From fb4667512319984bc1270d12d02e2bd77c9bb59e Mon Sep 17 00:00:00 2001 From: Dr-Electron Date: Fri, 19 Jan 2024 12:59:20 +0100 Subject: [PATCH] The Purge - Don't worry, it's just one night (#1411) * 7pm * First hours are over * Such a mess. So much blood * 7am --- .github/_CODEOWNERS | 11 +- articleRedirects.js | 26 +- banners/iota-streams-deprecated.mdx | 1 - banners/pre-sdk-libs-deprecated.mdx | 2 - contentPlugins.js | 18 - docs/build/apis/sidebars.js | 8 +- .../getting-started/networks-endpoints.mdx | 27 - docs/build/getting-started/sidebars.ts | 2 +- .../docs/explanations/about-alias-outputs.mdx | 4 +- .../decentralized-identifiers/create.mdx | 2 +- .../specifications/iota-did-method-spec.mdx | 2 +- .../chrysalis/docs/explanations/faq.md | 56 - .../chrysalis/docs/explanations/libraries.md | 45 - .../docs/explanations/node_software.md | 29 - .../docs/explanations/protocol_tip.md | 16 - .../update/chrysalis_improvements.md | 56 - .../update/migration_mechanism.md | 111 - .../explanations/update/path_to_chrysalis.md | 111 - .../explanations/update/what_is_chrysalis.md | 24 - .../chrysalis/docs/getting_started/.keep | 0 .../chrysalis/docs/how_tos/backup_security.md | 51 - .../chrysalis/docs/how_tos/exchange.md | 300 -- .../docs/how_tos/migration/hub_migration.md | 42 - .../snapshot_validation_bootstrapping.md | 93 - .../docs/how_tos/migration/token_migration.md | 402 -- .../docs/how_tos/verify_firefly_download.md | 206 - .../chrysalis/docs/reference/.keep | 0 .../chrysalis/docs/reference/changelog.md | 25 - .../chrysalis/docs/reference/details.md | 230 - .../docs/reference/networks/devnet.md | 43 - .../docs/reference/networks/mainnet.md | 27 - .../chrysalis/docs/resources.md | 61 - .../chrysalis/docs/tutorials/.keep | 0 .../chrysalis/docs/welcome.md | 16 - .../introduction-docs/chrysalis/sidebars.js | 140 - .../docs/explanations/libraries/client.md | 66 - .../docs/explanations/libraries/overview.md | 3 +- .../docs/explanations/libraries/wallet.md | 51 - .../stardust/docs/welcome.md | 2 +- .../introduction-docs/stardust/sidebars.js | 10 - .../_admonitions/_warning-password-storage.md | 2 +- .../1.0/docs/how-tos/exchange-guide.mdx | 16 +- .../2.0-rc.1/admonitions/_enable_pow.md | 7 - .../build/iota.js/2.0-rc.1/docs/contribute.md | 44 - .../iota.js/2.0-rc.1/docs/getting_started.mdx | 75 - .../build/iota.js/2.0-rc.1/docs/how_tos/.keep | 0 .../iota.js/2.0-rc.1/docs/how_tos/address.mdx | 157 - .../iota.js/2.0-rc.1/docs/how_tos/browser.mdx | 143 - .../iota.js/2.0-rc.1/docs/how_tos/data.mdx | 119 - .../2.0-rc.1/docs/how_tos/mint_nft.mdx | 99 - .../iota.js/2.0-rc.1/docs/how_tos/peers.mdx | 80 - .../iota.js/2.0-rc.1/docs/how_tos/pow.mdx | 73 - .../2.0-rc.1/docs/how_tos/run_how_tos.mdx | 57 - .../iota.js/2.0-rc.1/docs/how_tos/simple.mdx | 196 - .../2.0-rc.1/docs/how_tos/transaction.mdx | 95 - .../iota.js/2.0-rc.1/docs/references/.keep | 0 .../docs/references/client/api_ref.md | 4493 ----------------- .../docs/references/client/classes/B1T6.md | 71 - .../references/client/classes/Bech32Helper.md | 137 - .../references/client/classes/ClientError.md | 132 - .../client/classes/Ed25519Address.md | 83 - .../references/client/classes/Ed25519Seed.md | 123 - .../client/classes/IndexerPluginClient.md | 183 - .../client/classes/LocalPowProvider.md | 48 - .../references/client/classes/PowHelper.md | 140 - .../client/classes/SingleNodeClient.md | 710 --- .../client/classes/TransactionHelper.md | 272 - .../references/client/classes/UnitsHelper.md | 128 - .../references/client/enums/ConflictReason.md | 89 - .../references/client/interfaces/IAddress.md | 58 - .../interfaces/IAddressUnlockCondition.md | 45 - .../client/interfaces/IAliasAddress.md | 45 - .../client/interfaces/IAliasOutput.md | 131 - .../client/interfaces/IAliasUnlock.md | 45 - .../client/interfaces/IBasicOutput.md | 86 - .../client/interfaces/IBip44GeneratorState.md | 44 - .../references/client/interfaces/IBlock.md | 53 - .../client/interfaces/IBlockIdResponse.md | 26 - .../client/interfaces/IBlockMetadata.md | 98 - .../references/client/interfaces/IClient.md | 579 --- .../client/interfaces/ICommonOutput.md | 56 - .../client/interfaces/IEd25519Address.md | 45 - .../client/interfaces/IEd25519Signature.md | 54 - .../interfaces/IExpirationUnlockCondition.md | 55 - .../client/interfaces/IFoundryOutput.md | 113 - .../client/interfaces/IGossipHeartbeat.md | 62 - .../client/interfaces/IGossipMetrics.md | 116 - .../IGovernorAddressUnlockCondition.md | 45 - .../IImmutableAliasUnlockCondition.md | 45 - .../client/interfaces/IIssuerFeature.md | 45 - .../references/client/interfaces/IKeyPair.md | 35 - .../client/interfaces/IMetadataFeature.md | 45 - .../client/interfaces/IMigratedFunds.md | 44 - .../client/interfaces/IMilestonePayload.md | 126 - .../IMilestoneUtxoChangesResponse.md | 44 - .../client/interfaces/INativeToken.md | 35 - .../client/interfaces/INftAddress.md | 45 - .../client/interfaces/INftOutput.md | 104 - .../client/interfaces/INftUnlock.md | 45 - .../references/client/interfaces/INodeInfo.md | 98 - .../client/interfaces/INodeInfoBaseToken.md | 71 - .../client/interfaces/INodeInfoMetrics.md | 44 - .../client/interfaces/INodeInfoMilestone.md | 44 - .../client/interfaces/INodeInfoProtocol.md | 71 - .../INodeInfoProtocolParamsMilestoneOpt.md | 75 - .../client/interfaces/INodeInfoStatus.md | 53 - .../interfaces/IOutputMetadataResponse.md | 107 - .../client/interfaces/IOutputResponse.md | 35 - .../client/interfaces/IOutputsResponse.md | 53 - .../references/client/interfaces/IPeer.md | 78 - .../client/interfaces/IPowProvider.md | 43 - .../IProtocolParamsMilestoneOption.md | 65 - .../interfaces/IReceiptMilestoneOption.md | 72 - .../client/interfaces/IReceiptsResponse.md | 26 - .../client/interfaces/IReferenceUnlock.md | 46 - .../references/client/interfaces/IRent.md | 44 - .../references/client/interfaces/IResponse.md | 48 - .../client/interfaces/IRoutesResponse.md | 26 - .../references/client/interfaces/ISeed.md | 87 - .../client/interfaces/ISenderFeature.md | 45 - .../client/interfaces/ISignatureUnlock.md | 45 - .../client/interfaces/ISimpleTokenScheme.md | 63 - .../IStateControllerAddressUnlockCondition.md | 45 - .../IStorageDepositReturnUnlockCondition.md | 54 - .../client/interfaces/ITagFeature.md | 45 - .../client/interfaces/ITaggedDataPayload.md | 54 - .../interfaces/ITimelockUnlockCondition.md | 45 - .../client/interfaces/ITipsResponse.md | 26 - .../client/interfaces/ITransactionEssence.md | 81 - .../client/interfaces/ITransactionPayload.md | 54 - .../references/client/interfaces/ITreasury.md | 35 - .../client/interfaces/ITreasuryInput.md | 45 - .../client/interfaces/ITreasuryOutput.md | 45 - .../interfaces/ITreasuryTransactionPayload.md | 54 - .../references/client/interfaces/ITypeBase.md | 104 - .../client/interfaces/IUTXOInput.md | 54 - .../interfaces/SingleNodeClientOptions.md | 84 - .../docs/references/crypto/api_ref.md | 35 - .../references/crypto/classes/ArrayHelper.md | 49 - .../docs/references/crypto/classes/Bech32.md | 178 - .../references/crypto/classes/Bip32Path.md | 137 - .../docs/references/crypto/classes/Bip39.md | 155 - .../docs/references/crypto/classes/Blake2b.md | 167 - .../references/crypto/classes/ChaCha20.md | 100 - .../crypto/classes/ChaCha20Poly1305.md | 148 - .../docs/references/crypto/classes/Curl.md | 152 - .../docs/references/crypto/classes/Ed25519.md | 179 - .../references/crypto/classes/HmacSha1.md | 94 - .../references/crypto/classes/HmacSha256.md | 95 - .../references/crypto/classes/HmacSha512.md | 95 - .../docs/references/crypto/classes/Pbkdf2.md | 75 - .../references/crypto/classes/Poly1305.md | 84 - .../docs/references/crypto/classes/Sha1.md | 91 - .../docs/references/crypto/classes/Sha256.md | 135 - .../docs/references/crypto/classes/Sha512.md | 132 - .../references/crypto/classes/Slip0010.md | 93 - .../docs/references/crypto/classes/X25519.md | 69 - .../docs/references/crypto/classes/Zip215.md | 52 - .../2.0-rc.1/docs/references/mqtt/api_ref.md | 22 - .../references/mqtt/classes/MqttClient.md | 736 --- .../references/mqtt/interfaces/IMqttClient.md | 609 --- .../mqtt/interfaces/IMqttMilestoneResponse.md | 44 - .../references/mqtt/interfaces/IMqttStatus.md | 53 - .../docs/references/pow-browser/api_ref.md | 7 - .../pow-browser/classes/BrowserPowProvider.md | 72 - .../docs/references/pow-neon/api_ref.md | 16 - .../pow-neon/classes/NeonPowProvider.md | 65 - .../docs/references/pow-node/api_ref.md | 42 - .../pow-node/classes/NodePowProvider.md | 65 - .../docs/references/pow-wasm/api_ref.md | 42 - .../pow-wasm/classes/WasmPowProvider.md | 65 - .../2.0-rc.1/docs/references/util/api_ref.md | 24 - .../docs/references/util/classes/Base32.md | 71 - .../docs/references/util/classes/Base58.md | 71 - .../docs/references/util/classes/Base64.md | 91 - .../references/util/classes/BigIntHelper.md | 178 - .../docs/references/util/classes/Converter.md | 267 - .../docs/references/util/classes/HexHelper.md | 144 - .../references/util/classes/RandomHelper.md | 48 - .../references/util/classes/ReadStream.md | 299 -- .../references/util/classes/WriteStream.md | 285 -- .../iota.js/2.0-rc.1/docs/troubleshooting.md | 28 - .../iota.js/2.0-rc.1/docs/tutorials/.keep | 0 .../alias-transactions/01-introduction.md | 39 - .../02-prepare-the-dev-env.md | 112 - .../alias-transactions/03-mint-new-alias.md | 237 - .../04-alias-transaction.md | 143 - .../01-introduction.md | 47 - .../02-prepare-the-dev-env.md | 118 - .../03-mint-native-tokens.md | 305 -- .../04-native-tokens-transaction.md | 336 -- .../05-melt-native-tokens.md | 329 -- .../nft-transactions/01-introduction.md | 42 - .../02-prepare-the-dev-env.md | 118 - .../nft-transactions/03-mint-new-nft.md | 280 - .../nft-transactions/04-nft-transaction.md | 188 - .../nft-transactions/05-claim-nft.md | 337 -- .../value-transactions/01-introduction.md | 50 - .../02-prepare-the-dev-env.md | 117 - .../value-transactions/03-generate-a-seed.md | 65 - .../04-generate-addresses.md | 158 - .../value-transactions/05-public-addresses.md | 148 - .../06-request-funds-from-the-faucet.md | 25 - .../07-query-output-details.md | 129 - .../value-transactions/08-transfer-funds.md | 403 -- .../09-understanding-deposits.md | 41 - .../10-sweep-outputs-to-reduce-deposits.md | 295 -- docs/build/iota.js/2.0-rc.1/docs/welcome.md | 24 - docs/build/iota.js/2.0-rc.1/sidebars.js | 255 - .../docs/_admonitions/_active_development.md | 6 - .../docs/_admonitions/_android_app_example.md | 5 - .../_admonitions/_android_cross_compile.mdx | 11 - .../1.4/docs/_admonitions/_android_gradle.md | 5 - .../_android_unnecessary_build.md | 5 - .../_admonitions/_avoid_seed_generators.md | 6 - .../_admonitions/_compiling_for_android.md | 6 - .../1.4/docs/_admonitions/_dust_protection.md | 8 - .../1.4/docs/_admonitions/_enable_mqtt | 7 - .../docs/_admonitions/_example_seed_note.md | 6 - .../docs/_admonitions/_explanation_outputs.md | 6 - .../docs/_admonitions/_explanation_seeds.md | 5 - .../1.4/docs/_admonitions/_faucet_service.md | 6 - .../_load_balancer_health_checks.md | 8 - .../_message_finder_helper_class.md | 6 - .../1.4/docs/_admonitions/_minimum_nodes.md | 5 - .../docs/_admonitions/_password_storage.md | 7 - .../1.4/docs/_admonitions/_rust_standard.md | 6 - .../1.4/docs/_admonitions/_seed_mnemonics.md | 9 - .../_wallet_transaction_recommendation.md | 8 - .../examples/01_get_info/_client_builder.md | 3 - .../examples/01_get_info/outputs/camelCase.md | 32 - .../01_get_info/outputs/snake_case.md | 32 - docs/build/iota.rs/1.4/docs/charts.pptx | Bin 52676 -> 0 bytes docs/build/iota.rs/1.4/docs/contribute.md | 55 - .../1.4/docs/examples/data_message.mdx | 57 - .../1.4/docs/examples/generate_addresses.mdx | 46 - .../1.4/docs/examples/generate_seed.mdx | 61 - .../iota.rs/1.4/docs/examples/get_balance.mdx | 46 - .../iota.rs/1.4/docs/examples/get_info.mdx | 56 - .../1.4/docs/examples/get_message_data.mdx | 41 - .../iota.rs/1.4/docs/examples/get_outputs.mdx | 50 - docs/build/iota.rs/1.4/docs/examples/mqtt.mdx | 63 - .../1.4/docs/examples/running_examples.mdx | 47 - .../1.4/docs/examples/simple_message.mdx | 47 - .../iota.rs/1.4/docs/examples/transaction.mdx | 54 - .../docs/explanations/address_key_space.md | 70 - .../messages_payloads_and_transactions.md | 181 - .../iota.rs/1.4/docs/explanations/seeds.mdx | 33 - .../java/android_development.mdx | 230 - .../getting_started/java/getting_started.mdx | 140 - .../1.4/docs/getting_started/nodejs.md | 51 - .../1.4/docs/getting_started/python.mdx | 105 - .../required_prior_knowledge.md | 46 - .../iota.rs/1.4/docs/getting_started/rust.md | 60 - .../iota.rs/1.4/docs/getting_started/wasm.md | 145 - .../1.4/docs/libraries/java/api/Address.mdx | 20 - .../docs/libraries/java/api/AddressDto.mdx | 7 - .../java/api/AddressIndexRecorder.mdx | 29 - .../java/api/AddressPublicWrapper.mdx | 7 - .../java/api/AddressStringPublicWrapper.mdx | 7 - .../1.4/docs/libraries/java/api/Api.mdx | 39 - .../java/api/BalanceAddressResponse.mdx | 17 - .../docs/libraries/java/api/BrokerOptions.mdx | 43 - .../1.4/docs/libraries/java/api/Chain.mdx | 1 - .../1.4/docs/libraries/java/api/Client.mdx | 302 -- .../docs/libraries/java/api/ClientBuilder.mdx | 173 - .../libraries/java/api/ClientException.mdx | 7 - .../java/api/ClientMessageBuilder.mdx | 166 - .../docs/libraries/java/api/ClientMiner.mdx | 1 - .../1.4/docs/libraries/java/api/Essence.mdx | 1 - .../libraries/java/api/GetAddressBuilder.mdx | 22 - .../java/api/GetAddressesBuilder.mdx | 58 - .../java/api/GetBalanceBuilderApi.mdx | 28 - .../libraries/java/api/GetMessageBuilder.mdx | 53 - .../1.4/docs/libraries/java/api/GossipDto.mdx | 7 - .../docs/libraries/java/api/HeartbeatDto.mdx | 19 - .../libraries/java/api/IndexPublicDto.mdx | 3 - .../libraries/java/api/IndexationPayload.mdx | 33 - .../docs/libraries/java/api/InfoResponse.mdx | 54 - .../1.4/docs/libraries/java/api/Input.mdx | 5 - .../1.4/docs/libraries/java/api/InputKind.mdx | 3 - .../java/api/LedgerInclusionStateDto.mdx | 5 - .../1.4/docs/libraries/java/api/Message.mdx | 25 - .../libraries/java/api/MessageBuilder.mdx | 42 - .../1.4/docs/libraries/java/api/MessageId.mdx | 9 - .../libraries/java/api/MessageMetadata.mdx | 38 - .../libraries/java/api/MessagePayload.mdx | 27 - .../libraries/java/api/MessagePayloadType.mdx | 9 - .../docs/libraries/java/api/MessageWrap.mdx | 7 - .../docs/libraries/java/api/MetricsDto.mdx | 43 - .../libraries/java/api/MigratedFundsEntry.mdx | 16 - .../java/api/MigratedFundsEntryDto.mdx | 11 - .../docs/libraries/java/api/MilestoneId.mdx | 5 - .../libraries/java/api/MilestonePayload.mdx | 22 - .../java/api/MilestonePayloadEssence.mdx | 35 - .../libraries/java/api/MilestoneResponse.mdx | 11 - .../libraries/java/api/MilestoneSignature.mdx | 3 - .../java/api/MilestoneUtxoChangesResponse.mdx | 11 - .../1.4/docs/libraries/java/api/MqttEvent.mdx | 7 - .../docs/libraries/java/api/MqttListener.mdx | 5 - .../docs/libraries/java/api/MqttManager.mdx | 24 - .../libraries/java/api/MqttTopicManager.mdx | 20 - .../1.4/docs/libraries/java/api/NativeAPI.mdx | 3 - .../docs/libraries/java/api/NetworkInfo.mdx | 15 - .../1.4/docs/libraries/java/api/Node.mdx | 9 - .../libraries/java/api/NodeInfoWrapper.mdx | 9 - .../1.4/docs/libraries/java/api/Output.mdx | 7 - .../1.4/docs/libraries/java/api/OutputDto.mdx | 9 - .../docs/libraries/java/api/OutputKind.mdx | 5 - .../libraries/java/api/OutputResponse.mdx | 22 - .../libraries/java/api/OutputsOptions.mdx | 19 - .../1.4/docs/libraries/java/api/PeerDto.mdx | 25 - .../java/api/PreparedTransactionData.mdx | 21 - .../1.4/docs/libraries/java/api/PublicKey.mdx | 20 - .../docs/libraries/java/api/ReceiptDto.mdx | 7 - .../libraries/java/api/ReceiptPayload.mdx | 30 - .../libraries/java/api/ReceiptPayloadDto.mdx | 15 - .../libraries/java/api/ReferenceUnlock.mdx | 11 - .../libraries/java/api/RegularEssence.mdx | 9 - .../1.4/docs/libraries/java/api/Relation.mdx | 5 - .../1.4/docs/libraries/java/api/RustHex.mdx | 23 - .../docs/libraries/java/api/RustLogging.mdx | 1 - .../1.4/docs/libraries/java/api/SecretKey.mdx | 27 - .../1.4/docs/libraries/java/api/Signature.mdx | 11 - .../SignatureLockedDustAllowanceOutput.mdx | 19 - .../SignatureLockedDustAllowanceOutputDto.mdx | 10 - .../java/api/SignatureLockedSingleOutput.mdx | 18 - .../api/SignatureLockedSingleOutputDto.mdx | 9 - .../libraries/java/api/SignatureUnlock.mdx | 8 - .../1.4/docs/libraries/java/api/Topic.mdx | 7 - .../docs/libraries/java/api/TopicEvent.mdx | 7 - .../docs/libraries/java/api/TransactionId.mdx | 7 - .../libraries/java/api/TransactionPayload.mdx | 15 - .../java/api/TransactionPayloadBuilder.mdx | 23 - .../docs/libraries/java/api/TreasuryInput.mdx | 13 - .../libraries/java/api/TreasuryOutput.mdx | 13 - .../libraries/java/api/TreasuryOutputDto.mdx | 7 - .../libraries/java/api/TreasuryPayload.mdx | 10 - .../libraries/java/api/TreasuryResponse.mdx | 10 - .../docs/libraries/java/api/UnlockBlock.mdx | 5 - .../libraries/java/api/UnlockBlockKind.mdx | 3 - .../docs/libraries/java/api/UnlockBlocks.mdx | 14 - .../1.4/docs/libraries/java/api/Util.mdx | 25 - .../1.4/docs/libraries/java/api/UtxoInput.mdx | 18 - .../1.4/docs/libraries/java/api_reference.md | 458 -- .../libraries/java/examples/_01_get_info.mdx | 34 - .../java/examples/_02_generate_seed.mdx | 6 - .../java/examples/_03_generate_addresses.mdx | 37 - .../java/examples/_04_get_balance.mdx | 45 - .../java/examples/_05_get_outputs.mdx | 33 - .../java/examples/_06_simple_message.mdx | 29 - .../java/examples/_07_get_message_data.mdx | 52 - .../java/examples/_08_data_message.mdx | 30 - .../java/examples/_09_transaction.mdx | 12 - .../docs/libraries/java/examples/_10_mqtt.mdx | 3 - .../java/examples/_running_examples.mdx | 27 - .../docs/libraries/nodejs/api_reference.md | 1151 ----- .../nodejs/examples/_01_get_info.mdx | 37 - .../nodejs/examples/_02_generate_seed.mdx | 14 - .../examples/_03_generate_addresses.mdx | 38 - .../nodejs/examples/_04_get_balance.mdx | 44 - .../nodejs/examples/_05_get_outputs.mdx | 91 - .../nodejs/examples/_06_simple_message.mdx | 28 - .../nodejs/examples/_07_get_message_data.mdx | 51 - .../nodejs/examples/_08_data_message.mdx | 30 - .../nodejs/examples/_09_transaction.mdx | 11 - .../libraries/nodejs/examples/_10_mqtt.mdx | 16 - .../nodejs/examples/_running_examples.mdx | 14 - .../docs/libraries/python/api_reference.md | 966 ---- .../python/examples/_01_get_info.mdx | 30 - .../python/examples/_02_generate_seed.mdx | 6 - .../examples/_03_generate_addresses.mdx | 55 - .../python/examples/_04_get_balance.mdx | 37 - .../python/examples/_05_get_outputs.mdx | 97 - .../python/examples/_06_simple_message.mdx | 30 - .../python/examples/_07_get_message_data.mdx | 50 - .../python/examples/_08_data_message.mdx | 38 - .../python/examples/_09_transaction.mdx | 9 - .../libraries/python/examples/_10_mqtt.mdx | 3 - .../python/examples/_running_examples.mdx | 14 - .../1.4/docs/libraries/rust/api_reference.md | 22 - .../libraries/rust/examples/_01_get_info.mdx | 31 - .../rust/examples/_02_generate_seed.mdx | 6 - .../rust/examples/_03_generate_addresses.mdx | 59 - .../rust/examples/_04_get_balance.mdx | 58 - .../rust/examples/_05_get_outputs.mdx | 36 - .../rust/examples/_06_simple_message.mdx | 28 - .../rust/examples/_07_get_message_data.mdx | 55 - .../rust/examples/_08_data_message.mdx | 30 - .../rust/examples/_09_transaction.mdx | 12 - .../docs/libraries/rust/examples/_10_mqtt.mdx | 3 - .../rust/examples/_running_examples.mdx | 35 - .../1.4/docs/libraries/wasm/api_reference.md | 1342 ----- .../libraries/wasm/examples/_01_get_info.mdx | 37 - .../wasm/examples/_02_generate_seed.mdx | 6 - .../wasm/examples/_03_generate_addresses.mdx | 38 - .../wasm/examples/_04_get_balance.mdx | 45 - .../wasm/examples/_05_get_outputs.mdx | 94 - .../wasm/examples/_06_simple_message.mdx | 29 - .../wasm/examples/_07_get_message_data.mdx | 53 - .../wasm/examples/_08_data_message.mdx | 29 - .../wasm/examples/_09_transaction.mdx | 9 - .../wasm/examples/_running_examples.md | 20 - docs/build/iota.rs/1.4/docs/overview.md | 64 - docs/build/iota.rs/1.4/docs/specs.mdx | 1219 ----- .../build/iota.rs/1.4/docs/troubleshooting.md | 26 - docs/build/iota.rs/1.4/docs/welcome.md | 33 - docs/build/iota.rs/1.4/sidebars.js | 132 - .../docs/_admonitions/_api_ref_coming_soon.md | 5 - .../docs/_admonitions/_dot_env_warning.md | 5 - .../docs/_admonitions/_guide_coming_soon.md | 6 - .../docs/_admonitions/_iotajs_example.mdx | 5 - .../docs/_admonitions/_password_storage.md | 7 - .../_wallet_transaction_recommendation.md | 8 - .../build/iota.rs/2.0-rc.7/docs/contribute.md | 49 - .../docs/getting_started/getting_started.md | 40 - .../2.0-rc.7/docs/getting_started/java.mdx | 425 -- .../2.0-rc.7/docs/getting_started/nodejs.mdx | 69 - .../2.0-rc.7/docs/getting_started/python.mdx | 113 - .../2.0-rc.7/docs/getting_started/rust.mdx | 60 - .../2.0-rc.7/docs/how_tos/00_run_how_tos.mdx | 39 - .../docs/how_tos/01_get_node_info.mdx | 74 - .../docs/how_tos/02_generate_mnemonic.mdx | 65 - .../docs/how_tos/03_generate_addresses.mdx | 75 - .../2.0-rc.7/docs/how_tos/04_get_output.mdx | 66 - .../2.0-rc.7/docs/how_tos/05_build_output.mdx | 69 - .../docs/how_tos/06_get_address_balances.mdx | 71 - .../2.0-rc.7/docs/how_tos/07_create_block.mdx | 68 - .../2.0-rc.7/docs/how_tos/08_post_block.mdx | 119 - .../2.0-rc.7/docs/how_tos/09_get_block.mdx | 75 - .../how_tos/10_prepare_sign_transaction.mdx | 70 - .../docs/how_tos/11_build_nft_output.mdx | 69 - .../docs/how_tos/12_build_foundry_output.mdx | 64 - .../docs/how_tos/13_build_alias_output.mdx | 64 - .../iota.rs/2.0-rc.7/docs/how_tos/14_mqtt.mdx | 65 - .../docs/how_tos/15_more_examples.mdx | 20 - .../docs/how_tos/16_use-python-with-iota.mdx | 121 - .../docs/libraries/java/api_reference.md | 537 -- .../how_to/_01_get_node_info/_code_sample.mdx | 3 - .../_01_get_node_info/_expected_output.md | 48 - .../_02_generate_mnemonic/_code_sample.mdx | 3 - .../_02_generate_mnemonic/_expected_output.md | 3 - .../_03_generate_addresses/_code_sample.mdx | 3 - .../_expected_output.md | 42 - .../how_to/_04_get_output/_code_sample.mdx | 3 - .../how_to/_04_get_output/_expected_output.md | 23 - .../how_to/_05_build_output/_code_sample.mdx | 3 - .../_05_build_output/_expected_output.md | 93 - .../_06_get_address_balances/_code_sample.mdx | 3 - .../_expected_output.md | 4 - .../how_to/_07_create_block/_code_sample.mdx | 3 - .../_07_create_block/_expected_output.md | 15 - .../how_to/_08_post_block/_code_sample.mdx | 3 - .../how_to/_08_post_block/_expected_output.md | 3 - .../_08_post_raw_block/_code_sample.mdx | 3 - .../_08_post_raw_block/_expected_output.md | 3 - .../how_to/_09_get_block/_code_sample.mdx | 3 - .../how_to/_09_get_block/_expected_output.md | 17 - .../_code_sample.mdx | 3 - .../_expected_output.md | 3 - .../how_to/_11_nft_output/_code_sample.mdx | 3 - .../how_to/_11_nft_output/_expected_output.md | 16 - .../_12_foundry_output/_code_sample.mdx | 3 - .../_12_foundry_output/_expected_output.md | 28 - .../how_to/_13_alias_output/_code_sample.mdx | 3 - .../_13_alias_output/_expected_output.md | 54 - .../libraries/java/how_to/_run_how_tos.mdx | 25 - .../how_to/_01_get_node_info/_code_sample.mdx | 9 - .../_01_get_node_info/_expected_output.md | 39 - .../_01_get_node_info/_key_api_ref_links.md | 22 - .../_02_generate_mnemonic/_code_sample.mdx | 9 - .../_02_generate_mnemonic/_expected_output.md | 3 - .../_key_api_ref_links.md | 4 - .../_03_generate_addresses/_code_sample.mdx | 13 - .../_expected_output.md | 45 - .../_key_api_ref_links.md | 33 - .../how_to/_04_get_output/_code_sample.mdx | 13 - .../how_to/_04_get_output/_expected_output.md | 61 - .../_04_get_output/_key_api_ref_links.md | 10 - .../how_to/_05_build_output/_code_sample.mdx | 13 - .../_05_build_output/_expected_output.md | 93 - .../_05_build_output/_key_api_ref_links.md | 10 - .../_06_get_address_balances/_code_sample.mdx | 13 - .../_expected_output.md | 9 - .../_key_api_ref_links.md | 32 - .../how_to/_07_create_block/_code_sample.mdx | 13 - .../_07_create_block/_expected_output.md | 17 - .../_07_create_block/_key_api_ref_links.md | 7 - .../how_to/_08_post_block/_code_sample.mdx | 13 - .../how_to/_08_post_block/_expected_output.md | 31 - .../_08_post_block/_key_api_ref_links.md | 9 - .../how_to/_09_get_block/_code_sample.mdx | 13 - .../how_to/_09_get_block/_expected_output.md | 39 - .../_09_get_block/_key_api_ref_links.md | 19 - .../_code_sample.mdx | 13 - .../_expected_output.md | 19 - .../_key_api_ref_links.md | 0 .../how_to/_11_nft_output/_code_sample.mdx | 13 - .../how_to/_11_nft_output/_expected_output.md | 9 - .../_11_nft_output/_key_api_ref_links.md | 0 .../_12_foundry_output/_code_sample.mdx | 13 - .../_12_foundry_output/_expected_output.md | 14 - .../_12_foundry_output/_key_api_ref_links.md | 0 .../how_to/_13_alias_output/_code_sample.mdx | 13 - .../_13_alias_output/_expected_output.md | 52 - .../_13_alias_output/_key_api_ref_links.md | 0 .../nodejs/how_to/_14_mqtt/_code_sample.mdx | 13 - .../how_to/_14_mqtt/_expected_output.md | 23 - .../how_to/_14_mqtt/_key_api_ref_links.md | 3 - .../libraries/nodejs/how_to/_run_how_tos.mdx | 44 - .../libraries/nodejs/references/api_ref.md | 179 - .../nodejs/references/classes/Client.md | 1419 ------ .../references/classes/MessageHandler.md | 3 - .../nodejs/references/enums/CoinType.md | 22 - .../references/enums/LedgerDeviceType.md | 29 - .../nodejs/references/enums/Network.md | 22 - .../nodejs/references/interfaces/Burn.md | 44 - .../interfaces/IAliasOutputBuilderOptions.md | 66 - .../nodejs/references/interfaces/IAuth.md | 3 - .../interfaces/IBasicOutputBuilderOptions.md | 54 - .../interfaces/IBuildBlockOptions.md | 44 - .../IClientBlockBuilderOutputAddress.md | 3 - .../references/interfaces/IClientOptions.md | 126 - .../nodejs/references/interfaces/IDuration.md | 3 - .../IFoundryOutputBuilderOptions.md | 75 - .../interfaces/IGenerateAddressOptions.md | 17 - .../interfaces/IGenerateAddressesOptions.md | 26 - .../interfaces/IInputSigningData.md | 35 - .../interfaces/IMqttBrokerOptions.md | 17 - .../references/interfaces/INetworkInfo.md | 53 - .../interfaces/INftOutputBuilderOptions.md | 66 - .../nodejs/references/interfaces/INode.md | 3 - .../references/interfaces/INodeInfoWrapper.md | 26 - .../interfaces/IPreparedTransactionData.md | 35 - .../nodejs/references/interfaces/IRange.md | 3 - .../nodejs/references/interfaces/LedgerApp.md | 3 - .../interfaces/LedgerNanoSecretManager.md | 17 - .../references/interfaces/LedgerNanoStatus.md | 3 - .../interfaces/MnemonicSecretManager.md | 3 - .../interfaces/OutputIdsResponse.md | 3 - .../interfaces/StrongholdSecretManager.md | 3 - .../2.0-rc.7/docs/libraries/overview.md | 40 - .../docs/libraries/python/api_reference.md | 925 ---- .../how_to/_01_get_node_info/_code_sample.mdx | 9 - .../_01_get_node_info/_expected_output.md | 57 - .../_01_get_node_info/_key_api_ref_links.md | 10 - .../_02_generate_mnemonic/_code_sample.mdx | 9 - .../_02_generate_mnemonic/_expected_output.md | 3 - .../_key_api_ref_links.md | 4 - .../_03_generate_addresses/_code_sample.mdx | 9 - .../_expected_output.md | 42 - .../_key_api_ref_links.md | 44 - .../how_to/_04_get_output/_code_sample.mdx | 9 - .../how_to/_04_get_output/_expected_output.md | 61 - .../_04_get_output/_key_api_ref_links.md | 10 - .../how_to/_05_build_output/_code_sample.mdx | 9 - .../_05_build_output/_expected_output.md | 93 - .../_05_build_output/_key_api_ref_links.md | 5 - .../_06_get_address_balances/_code_sample.mdx | 9 - .../_expected_output.md | 29 - .../_key_api_ref_links.md | 31 - .../how_to/_07_create_block/_code_sample.mdx | 9 - .../_07_create_block/_expected_output.md | 15 - .../_07_create_block/_key_api_ref_links.md | 7 - .../how_to/_08_post_block/_code_sample.mdx | 9 - .../how_to/_08_post_block/_expected_output.md | 20 - .../_08_post_block/_key_api_ref_links.md | 9 - .../how_to/_09_get_block/_code_sample.mdx | 9 - .../how_to/_09_get_block/_expected_output.md | 38 - .../_09_get_block/_key_api_ref_links.md | 19 - .../_code_sample.mdx | 9 - .../_expected_output.md | 86 - .../_key_api_ref_links.md | 0 .../how_to/_11_nft_output/_code_sample.mdx | 9 - .../how_to/_11_nft_output/_expected_output.md | 90 - .../_11_nft_output/_key_api_ref_links.md | 0 .../_12_foundry_output/_code_sample.mdx | 9 - .../_12_foundry_output/_expected_output.md | 28 - .../how_to/_13_alias_output/_code_sample.mdx | 9 - .../_13_alias_output/_expected_output.md | 52 - .../_14_post_raw_block/_code_sample.mdx | 9 - .../_14_post_raw_block/_expected_output.md | 3 - .../libraries/python/how_to/_run_how_tos.md | 26 - .../python/references/iota_client/client.md | 200 - .../python/references/iota_client/common.md | 20 - .../references/iota_client/high_level_api.md | 114 - .../references/iota_client/node_core_api.md | 194 - .../iota_client/node_indexer_api.md | 66 - .../references/iota_client/secret_manager.md | 66 - .../python/references/iota_client/utils.md | 122 - .../libraries/python/references/sidebar.json | 19 - .../docs/libraries/rust/api_reference.md | 21 - .../how_to/_01_get_node_info/_code_sample.mdx | 17 - .../_01_get_node_info/_expected_output.md | 55 - .../_01_get_node_info/_key_api_ref_links.md | 24 - .../_02_generate_mnemonic/_code_sample.mdx | 9 - .../_02_generate_mnemonic/_expected_output.md | 3 - .../_key_api_ref_links.md | 5 - .../_03_generate_addresses/_code_sample.mdx | 17 - .../_expected_output.md | 49 - .../_key_api_ref_links.md | 38 - .../how_to/_04_get_output/_code_sample.mdx | 14 - .../how_to/_04_get_output/_expected_output.md | 92 - .../_04_get_output/_key_api_ref_links.md | 10 - .../how_to/_05_build_output/_code_sample.mdx | 15 - .../_05_build_output/_expected_output.md | 139 - .../_06_get_address_balances/_code_sample.mdx | 15 - .../_expected_output.md | 25 - .../_key_api_ref_links.md | 32 - .../how_to/_07_create_block/_code_sample.mdx | 15 - .../_07_create_block/_expected_output.md | 18 - .../_07_create_block/_key_api_ref_links.md | 8 - .../how_to/_08_post_block/_code_sample.mdx | 17 - .../how_to/_08_post_block/_expected_output.md | 3 - .../_08_post_block/_key_api_ref_links.md | 9 - .../_08_post_raw_block/_code_sample.mdx | 17 - .../_08_post_raw_block/_expected_output.md | 3 - .../_08_post_raw_block/_key_api_ref_links.md | 0 .../how_to/_09_get_block/_code_sample.mdx | 18 - .../how_to/_09_get_block/_expected_output.md | 159 - .../_09_get_block/_key_api_ref_links.md | 19 - .../_code_sample.mdx | 15 - .../_expected_output.md | 3 - .../_key_api_ref_links.md | 0 .../how_to/_11_nft_output/_code_sample.mdx | 15 - .../how_to/_11_nft_output/_expected_output.md | 4 - .../_11_nft_output/_key_api_ref_links.md | 0 .../_12_foundry_output/_code_sample.mdx | 15 - .../_12_foundry_output/_expected_output.md | 5 - .../_12_foundry_output/_key_api_ref_links.md | 0 .../how_to/_13_alias_output/_code_sample.mdx | 15 - .../_13_alias_output/_expected_output.md | 66 - .../_13_alias_output/_key_api_ref_links.md | 0 .../rust/how_to/_14_mqtt/_code_sample.mdx | 15 - .../rust/how_to/_14_mqtt/_expected_output.md | 78 - .../how_to/_14_mqtt/_key_api_ref_links.md | 0 .../libraries/rust/how_to/_run_how_tos.md | 49 - .../iota.rs/2.0-rc.7/docs/node_api_core.md | 523 -- docs/build/iota.rs/2.0-rc.7/docs/overview.md | 68 - .../iota.rs/2.0-rc.7/docs/troubleshooting.md | 23 - docs/build/iota.rs/2.0-rc.7/docs/welcome.md | 28 - docs/build/iota.rs/2.0-rc.7/sidebars.js | 141 - docs/build/streams/0.2/docs/contribute.md | 49 - .../build/streams/0.2/docs/getting_started.md | 15 - .../streams/0.2/docs/libraries/overview.md | 22 - .../0.2/docs/libraries/rust/api_reference.md | 12 - .../0.2/docs/libraries/rust/examples.md | 20 - .../docs/libraries/rust/getting_started.md | 155 - docs/build/streams/0.2/docs/overview.md | 147 - docs/build/streams/0.2/docs/specs.md | 14 - .../build/streams/0.2/docs/troubleshooting.md | 23 - docs/build/streams/0.2/docs/welcome.md | 34 - docs/build/streams/0.2/sidebars.js | 75 - .../1.1/docs/reference/specs/scope.md | 2 +- docs/build/wallet.rs/0.1/docs/contribute.md | 50 - .../build/wallet.rs/0.1/docs/examples/java.md | 144 - .../wallet.rs/0.1/docs/examples/nodejs.mdx | 229 - .../wallet.rs/0.1/docs/examples/python.mdx | 446 -- .../wallet.rs/0.1/docs/examples/rust.mdx | 107 - .../0.1/docs/explanations/nutshell.md | 26 - .../0.1/docs/getting_started/java.md | 126 - .../docs/getting_started/java_for_android.md | 239 - .../0.1/docs/getting_started/nodejs.mdx | 159 - .../0.1/docs/getting_started/python.md | 109 - .../0.1/docs/getting_started/rust.mdx | 133 - docs/build/wallet.rs/0.1/docs/overview.md | 21 - .../wallet.rs/0.1/docs/reference/java.mdx | 524 -- .../0.1/docs/reference/java_api/Account.mdx | 174 - .../reference/java_api/AccountBalance.mdx | 20 - .../reference/java_api/AccountInitialiser.mdx | 54 - .../reference/java_api/AccountManager.mdx | 212 - .../java_api/AccountManagerBuilder.mdx | 55 - .../reference/java_api/AccountSignerType.mdx | 5 - .../java_api/AccountSynchronizer.mdx | 32 - .../java_api/AccountsSynchronizer.mdx | 37 - .../0.1/docs/reference/java_api/Actor.mdx | 33 - .../docs/reference/java_api/ActorCallback.mdx | 5 - .../0.1/docs/reference/java_api/Address.mdx | 17 - .../reference/java_api/AddressBuilder.mdx | 35 - .../AddressConsolidationNeededEvent.mdx | 9 - .../AddressConsolidationNeededListener.mdx | 5 - .../docs/reference/java_api/AddressData.mdx | 5 - .../docs/reference/java_api/AddressOutput.mdx | 71 - .../reference/java_api/AddressWrapper.mdx | 20 - .../0.1/docs/reference/java_api/Api.mdx | 15 - .../docs/reference/java_api/BalanceChange.mdx | 13 - .../java_api/BalanceChangeListener.mdx | 5 - .../docs/reference/java_api/BalanceEvent.mdx | 28 - .../java_api/BroadcastTransactionListener.mdx | 5 - .../reference/java_api/BroadcastingBundle.mdx | 5 - .../docs/reference/java_api/BrokerOptions.mdx | 43 - .../docs/reference/java_api/ClientOptions.mdx | 1 - .../java_api/ClientOptionsBuilder.mdx | 135 - .../docs/reference/java_api/ErrorListener.mdx | 5 - .../0.1/docs/reference/java_api/Essence.mdx | 1 - .../0.1/docs/reference/java_api/EventId.mdx | 1 - .../docs/reference/java_api/EventManager.mdx | 157 - .../0.1/docs/reference/java_api/EventType.mdx | 17 - .../java_api/FetchingMigrationData.mdx | 9 - .../reference/java_api/IndexationPayload.mdx | 25 - .../docs/reference/java_api/InfoResponse.mdx | 54 - .../0.1/docs/reference/java_api/InputData.mdx | 25 - .../0.1/docs/reference/java_api/InputKind.mdx | 3 - .../0.1/docs/reference/java_api/Message.mdx | 17 - .../0.1/docs/reference/java_api/MessageId.mdx | 7 - .../reference/java_api/MessagePayload.mdx | 27 - .../reference/java_api/MessagePayloadType.mdx | 9 - .../docs/reference/java_api/MessageType.mdx | 11 - .../reference/java_api/MigratedFundsEntry.mdx | 7 - .../reference/java_api/MigrationAddress.mdx | 9 - .../reference/java_api/MigrationBundle.mdx | 9 - .../java_api/MigrationBundleOptions.mdx | 39 - .../docs/reference/java_api/MigrationData.mdx | 18 - .../java_api/MigrationProgressEvent.mdx | 13 - .../java_api/MigrationProgressListener.mdx | 5 - .../java_api/MigrationProgressType.mdx | 21 - .../docs/reference/java_api/MilestoneId.mdx | 5 - .../reference/java_api/MilestonePayload.mdx | 9 - .../java_api/MilestonePayloadEssence.mdx | 31 - .../reference/java_api/MilestoneSignature.mdx | 3 - .../docs/reference/java_api/MiningBundle.mdx | 5 - .../0.1/docs/reference/java_api/NativeAPI.mdx | 3 - .../java_api/NewTransactionListener.mdx | 5 - .../reference/java_api/NodeInfoWrapper.mdx | 7 - .../docs/reference/java_api/OutputKind.mdx | 7 - .../java_api/PreparedTransactionData.mdx | 13 - .../0.1/docs/reference/java_api/PublicKey.mdx | 20 - .../java_api/ReattachTransactionListener.mdx | 5 - .../reference/java_api/ReceiptPayload.mdx | 9 - .../reference/java_api/ReferenceUnlock.mdx | 11 - .../reference/java_api/RegularEssence.mdx | 25 - .../java_api/RemainderValueStrategy.mdx | 3 - .../0.1/docs/reference/java_api/RustHex.mdx | 11 - .../docs/reference/java_api/RustLogging.mdx | 1 - .../0.1/docs/reference/java_api/Signature.mdx | 11 - .../SignatureLockedDustAllowanceOutput.mdx | 19 - .../java_api/SignatureLockedSingleOutput.mdx | 19 - .../reference/java_api/SignatureUnlock.mdx | 8 - .../docs/reference/java_api/SigningBundle.mdx | 5 - .../java_api/StrongholdStatusEvent.mdx | 5 - .../java_api/StrongholdStatusListener.mdx | 5 - .../java_api/StrongholdStatusType.mdx | 3 - .../docs/reference/java_api/SyncedAccount.mdx | 3 - .../TransactionConfirmationChangeEvent.mdx | 17 - .../TransactionConfirmationChangeListener.mdx | 5 - .../java_api/TransactionConfirmed.mdx | 5 - .../reference/java_api/TransactionEvent.mdx | 13 - .../docs/reference/java_api/TransactionIO.mdx | 13 - .../docs/reference/java_api/TransactionId.mdx | 5 - .../reference/java_api/TransactionInput.mdx | 5 - .../reference/java_api/TransactionOutput.mdx | 7 - .../reference/java_api/TransactionPayload.mdx | 7 - .../java_api/TransactionReattachmentEvent.mdx | 17 - .../0.1/docs/reference/java_api/Transfer.mdx | 9 - .../reference/java_api/TransferBuilder.mdx | 49 - .../reference/java_api/TransferOutput.mdx | 23 - .../reference/java_api/TransferProgress.mdx | 7 - .../java_api/TransferProgressListener.mdx | 5 - .../java_api/TransferProgressType.mdx | 29 - .../docs/reference/java_api/TreasuryInput.mdx | 13 - .../reference/java_api/TreasuryOutput.mdx | 11 - .../reference/java_api/TreasuryPayload.mdx | 3 - .../docs/reference/java_api/UnlockBlock.mdx | 5 - .../reference/java_api/UnlockBlockKind.mdx | 3 - .../0.1/docs/reference/java_api/UtxoInput.mdx | 18 - .../0.1/docs/reference/java_api/Value.mdx | 12 - .../0.1/docs/reference/java_api/ValueUnit.mdx | 11 - .../reference/java_api/WalletException.mdx | 7 - .../java_api/WalletTransferProgress.mdx | 7 - .../wallet.rs/0.1/docs/reference/nodejs.md | 593 --- .../wallet.rs/0.1/docs/reference/python.md | 1127 ----- .../wallet.rs/0.1/docs/reference/rust.md | 18 - .../0.1/docs/reference/specifications.md | 1182 ----- .../wallet.rs/0.1/docs/troubleshooting.md | 22 - docs/build/wallet.rs/0.1/docs/tutorials/.keep | 0 docs/build/wallet.rs/0.1/docs/welcome.md | 51 - .../build/wallet.rs/0.1/resources/charts.pptx | Bin 44420 -> 0 bytes docs/build/wallet.rs/0.1/sidebars.js | 134 - .../docs/_admonitions/_guide_coming_soon.md | 6 - .../docs/_admonitions/_info_iotajs.mdx | 5 - .../_note_replace_native_token_id.md | 8 - .../docs/_admonitions/_note_replace_nft_id.md | 8 - .../docs/_admonitions/_password_storage.md | 7 - .../_admonitions/_tip_account_approaches.md | 6 - .../1.0-rc.6/docs/_admonitions/_tip_faucet.md | 5 - .../docs/_admonitions/_warning_dot_env.md | 5 - .../_warning_safe_password_storage.md | 5 - .../_warning_unlock_conditions.md | 11 - .../wallet.rs/1.0-rc.6/docs/contribute.md | 49 - .../docs/explanations/account_approaches.md | 23 - .../docs/explanations/library_overview.md | 42 - .../docs/getting_started/getting_started.md | 47 - .../1.0-rc.6/docs/getting_started/java.mdx | 244 - .../1.0-rc.6/docs/getting_started/nodejs.mdx | 80 - .../1.0-rc.6/docs/getting_started/python.mdx | 118 - .../1.0-rc.6/docs/getting_started/rust.mdx | 95 - .../1.0-rc.6/docs/how_tos/NFT/01_mint_nft.mdx | 75 - .../1.0-rc.6/docs/how_tos/NFT/02_send_nft.mdx | 80 - .../1.0-rc.6/docs/how_tos/NFT/03_burn_nft.mdx | 73 - .../01_create_a_wallet_account.mdx | 72 - .../02_generate_address.mdx | 75 - .../03_request_funds.mdx | 73 - .../04_check_balance.mdx | 75 - .../1.0-rc.6/docs/how_tos/exchange_guide.mdx | 234 - .../1.0-rc.6/docs/how_tos/more_examples.mdx | 19 - .../native_tokens/01_mint_native_token.mdx | 74 - .../native_tokens/02_send_native_token.mdx | 80 - .../native_tokens/03_melt_native_token.mdx | 74 - .../native_tokens/04_burn_native_token.mdx | 80 - .../native_tokens/05_destroy_foundry.mdx | 79 - .../native_tokens/06_destroy_alias_output.mdx | 69 - .../01_send_transaction.mdx | 73 - .../02_send_micro_transaction.mdx | 72 - .../03_list_outputs.mdx | 70 - .../04_claim_outputs.mdx | 72 - .../05_list_transactions.mdx | 69 - .../06_check_unlock_conditions.mdx | 66 - .../1.0-rc.6/docs/how_tos/run_how_tos.mdx | 79 - .../docs/how_tos/use-python-with-IOTA.mdx | 156 - .../how_to/NFT/_01_mint_nft/_code_sample.mdx | 3 - .../NFT/_01_mint_nft/_expected_output.md | 88 - .../how_to/NFT/_02_send_nft/_code_sample.mdx | 3 - .../NFT/_02_send_nft/_expected_output.md | 57 - .../how_to/NFT/_03_burn_nft/_code_sample.mdx | 3 - .../NFT/_03_burn_nft/_expected_output.md | 50 - .../libraries/java/how_to/_more_examples.md | 1 - .../libraries/java/how_to/_run_how_tos.mdx | 30 - .../_code_sample.mdx | 3 - .../_expected_output.md | 23 - .../_02_generate_address/_code_sample.mdx | 3 - .../_02_generate_address/_expected_output.md | 5 - .../_03_request_funds/_code_sample.mdx | 3 - .../_03_request_funds/_expected_output.md | 4 - .../_04_check_balance/_code_sample.mdx | 3 - .../_04_check_balance/_expected_output.md | 38 - .../_05_backup/_code_sample.mdx | 3 - .../_05_backup/_expected_output.md | 3 - .../_01_mint_native_token/_code_sample.mdx | 3 - .../_01_mint_native_token/_expected_output.md | 132 - .../_02_send_native_token/_code_sample.mdx | 3 - .../_02_send_native_token/_expected_output.md | 99 - .../_03_melt_native_token/_code_sample.mdx | 3 - .../_03_melt_native_token/_expected_output.md | 118 - .../_04_burn_native_token/_code_sample.mdx | 3 - .../_04_burn_native_token/_expected_output.md | 56 - .../_05_destroy_foundry/_code_sample.mdx | 3 - .../_05_destroy_foundry/_expected_output.md | 70 - .../_01_send_transaction/_code_sample.mdx | 3 - .../_01_send_transaction/_expected_output.md | 77 - .../_code_sample.mdx | 3 - .../_expected_output.md | 126 - .../_03_list_outputs/_code_sample.mdx | 3 - .../_03_list_outputs/_expected_output.md | 285 -- .../_04_claim_outputs/_code_sample.mdx | 3 - .../_04_claim_outputs/_expected_output.md | 50 - .../_05_list_transactions/_code_sample.mdx | 3 - .../_05_list_transactions/_expected_output.md | 63 - .../_code_sample.mdx | 9 - .../_expected_output.md | 3 - .../_06_destroy_alias_output/_code_sample.mdx | 3 - .../_expected_output.md | 50 - .../how_to/NFT/_01_mint_nft/_code_sample.mdx | 9 - .../NFT/_01_mint_nft/_expected_output.md | 24 - .../how_to/NFT/_02_send_nft/_code_sample.mdx | 9 - .../NFT/_02_send_nft/_expected_output.md | 23 - .../how_to/NFT/_03_burn_nft/_code_sample.mdx | 9 - .../NFT/_03_burn_nft/_expected_output.md | 24 - .../libraries/nodejs/how_to/_more_examples.md | 1 - .../libraries/nodejs/how_to/_run_how_tos.mdx | 59 - .../_code_sample.mdx | 9 - .../_expected_output.md | 37 - .../_02_generate_address/_code_sample.mdx | 9 - .../_02_generate_address/_expected_output.md | 27 - .../_03_request_funds/_code_sample.mdx | 9 - .../_03_request_funds/_expected_output.md | 3 - .../_04_check_balance/_code_sample.mdx | 9 - .../_04_check_balance/_expected_output.md | 0 .../_05_backup/_code_sample.mdx | 9 - .../_05_backup/_expected_output.md | 4 - .../_01_mint_native_token/_code_sample.mdx | 9 - .../_01_mint_native_token/_expected_output.md | 3 - .../_02_send_native_token/_code_sample.mdx | 9 - .../_02_send_native_token/_expected_output.md | 23 - .../_03_melt_native_token/_code_sample.mdx | 9 - .../_03_melt_native_token/_expected_output.md | 23 - .../_04_burn_native_token/_code_sample.mdx | 9 - .../_04_burn_native_token/_expected_output.md | 23 - .../_05_destroy_foundry/_code_sample.mdx | 9 - .../_05_destroy_foundry/_expected_output.md | 23 - .../_05_send_transaction/_code_sample.mdx | 9 - .../_05_send_transaction/_expected_output.md | 69 - .../_code_sample.mdx | 9 - .../_expected_output.md | 3 - .../_06_restore/_code_sample.mdx | 9 - .../_06_restore/_expected_output.md | 3 - .../_code_sample.mdx | 9 - .../_expected_output.md | 24 - .../_12a_list_outputs/_code_sample.mdx | 9 - .../_12a_list_outputs/_expected_output.md | 34 - .../_12c_list_transactions/_code_sample.mdx | 9 - .../_expected_output.md | 15 - .../_21_claim_outputs/_code_sample.mdx | 9 - .../_21_claim_outputs/_expected_output.md | 37 - .../references/interfaces/AccountMetadata.md | 35 - .../interfaces/AliasOutputOptions.md | 45 - .../interfaces/MnemonicSecretManager.md | 3 - .../how_to/NFT/_01_mint_nft/_code_sample.mdx | 9 - .../NFT/_01_mint_nft/_expected_output.md | 120 - .../how_to/NFT/_02_send_nft/_code_sample.mdx | 9 - .../NFT/_02_send_nft/_expected_output.md | 105 - .../how_to/NFT/_03_burn_nft/_code_sample.mdx | 9 - .../NFT/_03_burn_nft/_expected_output.md | 50 - .../libraries/python/how_to/_more_examples.md | 1 - .../libraries/python/how_to/_run_how_tos.md | 26 - .../_code_sample.mdx | 9 - .../_expected_output.md | 23 - .../_02_generate_address/_code_sample.mdx | 9 - .../_02_generate_address/_expected_output.md | 10 - .../_03_request_funds/_code_sample.mdx | 3 - .../_03_request_funds/_expected_output.md | 4 - .../_04_check_balance/_code_sample.mdx | 9 - .../_04_check_balance/_expected_output.md | 70 - .../_05_backup/_code_sample.mdx | 3 - .../_05_backup/_expected_output.md | 3 - .../_01_mint_native_tokens/_code_sample.mdx | 9 - .../_expected_output.md | 171 - .../_02_send_native_tokens/_code_sample.mdx | 9 - .../_expected_output.md | 141 - .../_03_melt_native_token/_code_sample.mdx | 3 - .../_03_melt_native_token/_expected_output.md | 118 - .../_04_burn_native_token/_code_sample.mdx | 3 - .../_04_burn_native_token/_expected_output.md | 56 - .../_05_destroy_foundry/_code_sample.mdx | 3 - .../_05_destroy_foundry/_expected_output.md | 70 - .../_01_send_transaction/_code_sample.mdx | 9 - .../_01_send_transaction/_expected_output.md | 99 - .../_code_sample.mdx | 9 - .../_expected_output.md | 121 - .../_03_list_outputs/_code_sample.mdx | 9 - .../_03_list_outputs/_expected_output.md | 164 - .../_04_claim_outputs/_code_sample.mdx | 9 - .../_04_claim_outputs/_expected_output.md | 76 - .../_05_list_transactions/_code_sample.mdx | 9 - .../_05_list_transactions/_expected_output.md | 148 - .../_code_sample.mdx | 9 - .../_expected_output.md | 3 - .../how_to/NFT/_01_mint_nft/_code_sample.mdx | 13 - .../NFT/_01_mint_nft/_expected_output.md | 6 - .../how_to/NFT/_02_send_nft/_code_sample.mdx | 13 - .../NFT/_02_send_nft/_expected_output.md | 4 - .../how_to/NFT/_03_burn_nft/_code_sample.mdx | 13 - .../NFT/_03_burn_nft/_expected_output.md | 48 - .../libraries/rust/how_to/_more_examples.md | 1 - .../libraries/rust/how_to/_run_how_tos.mdx | 40 - .../_code_sample.mdx | 13 - .../_expected_output.md | 3 - .../_02_generate_address/_code_sample.mdx | 13 - .../_02_generate_address/_expected_output.md | 3 - .../_03_request_funds/_code_sample.mdx | 13 - .../_03_request_funds/_expected_output.md | 6 - .../_04_check_balance/_code_sample.mdx | 13 - .../_04_check_balance/_expected_output.md | 24 - .../_01_mint_native_tokens/_code_sample.mdx | 13 - .../_expected_output.md | 4 - .../_02_send_native_tokens/_code_sample.mdx | 13 - .../_expected_output.md | 4 - .../_03_melt_native_token/_code_sample.mdx | 13 - .../_03_melt_native_token/_expected_output.md | 3 - .../_04_burn_native_token/_code_sample.mdx | 13 - .../_04_burn_native_token/_expected_output.md | 71 - .../_05_destroy_foundry/_code_sample.mdx | 13 - .../_05_destroy_foundry/_expected_output.md | 44 - .../_05_send_transaction/_code_sample.mdx | 13 - .../_05_send_transaction/_expected_output.md | 4 - .../_code_sample.mdx | 13 - .../_expected_output.md | 3 - .../_code_sample.mdx | 13 - .../_expected_output.md | 4 - .../_16_destroy_alias_output/_code_sample.mdx | 15 - .../_expected_output.md | 39 - .../1.0-rc.6/docs/references/java/account.md | 309 -- .../1.0-rc.6/docs/references/java/wallet.md | 159 - .../docs/references/nodejs/api_ref.md | 196 - .../docs/references/nodejs/classes/Account.md | 988 ---- .../nodejs/classes/AccountManager.md | 525 -- .../references/nodejs/enums/AddressType.md | 29 - .../docs/references/nodejs/enums/CoinType.md | 22 - .../references/nodejs/enums/InclusionState.md | 44 - .../nodejs/enums/LedgerDeviceType.md | 29 - .../docs/references/nodejs/enums/Network.md | 22 - .../references/nodejs/enums/OutputsToClaim.md | 43 - .../references/nodejs/enums/ReturnStrategy.md | 22 - .../references/nodejs/enums/WalletEvent.md | 50 - .../nodejs/interfaces/AccountBalance.md | 76 - .../interfaces/AccountManagerOptions.md | 3 - .../nodejs/interfaces/AccountMeta.md | 39 - .../nodejs/interfaces/AccountMetadata.md | 35 - .../nodejs/interfaces/AccountSyncOptions.md | 3 - .../references/nodejs/interfaces/Address.md | 3 - .../interfaces/AddressGenerationOptions.md | 3 - .../nodejs/interfaces/AddressNativeTokens.md | 3 - .../nodejs/interfaces/AddressNftId.md | 3 - .../nodejs/interfaces/AddressWithAmount.md | 3 - .../interfaces/AddressWithMicroAmount.md | 3 - .../interfaces/AddressWithUnspentOutputs.md | 3 - .../nodejs/interfaces/AliasOutputOptions.md | 45 - .../nodejs/interfaces/AliasSyncOptions.md | 3 - .../references/nodejs/interfaces/Assets.md | 3 - .../nodejs/interfaces/BaseCoinBalance.md | 26 - .../nodejs/interfaces/BuildAliasOutputData.md | 27 - .../nodejs/interfaces/BuildBasicOutputData.md | 27 - .../interfaces/BuildFoundryOutputData.md | 27 - .../nodejs/interfaces/BuildNftOutputData.md | 27 - .../nodejs/interfaces/ClientOptions.md | 3 - .../nodejs/interfaces/CreateAccountPayload.md | 3 - .../references/nodejs/interfaces/Features.md | 3 - .../nodejs/interfaces/FilterOptions.md | 35 - .../interfaces/GenerateAddressOptions.md | 3 - .../IncreaseNativeTokenSupplyOptions.md | 3 - .../nodejs/interfaces/InputSigningData.md | 45 - .../references/nodejs/interfaces/LedgerApp.md | 3 - .../interfaces/LedgerNanoSecretManager.md | 17 - .../nodejs/interfaces/LedgerNanoStatus.md | 3 - .../nodejs/interfaces/LoggerConfig.md | 53 - .../nodejs/interfaces/MintTokenTransaction.md | 26 - .../interfaces/MnemonicSecretManager.md | 3 - .../nodejs/interfaces/NativeTokenBalance.md | 3 - .../nodejs/interfaces/NativeTokenOptions.md | 35 - .../nodejs/interfaces/NetworkInfo.md | 3 - .../nodejs/interfaces/NftOptions.md | 63 - .../nodejs/interfaces/NftSyncOptions.md | 3 - .../nodejs/interfaces/NodeInfoWrapper.md | 26 - .../nodejs/interfaces/OutputData.md | 80 - .../nodejs/interfaces/OutputOptions.md | 3 - .../interfaces/PreparedTransactionData.md | 35 - .../nodejs/interfaces/RemainderData.md | 35 - .../interfaces/RequiredStorageDeposit.md | 3 - .../nodejs/interfaces/SeedSecretManager.md | 3 - .../references/nodejs/interfaces/Segment.md | 3 - .../interfaces/SignedTransactionEssence.md | 3 - .../nodejs/interfaces/StorageDeposit.md | 3 - .../interfaces/StrongholdSecretManager.md | 3 - .../nodejs/interfaces/SyncOptions.md | 103 - .../nodejs/interfaces/Transaction.md | 80 - .../nodejs/interfaces/TransactionOptions.md | 26 - .../references/nodejs/interfaces/Unlocks.md | 3 - .../references/python/iota_wallet/account.md | 358 -- .../references/python/iota_wallet/common.md | 20 - .../python/iota_wallet/secret_manager.md | 60 - .../references/python/iota_wallet/wallet.md | 223 - .../docs/references/python/sidebar.json | 5 - .../docs/references/rust_api_reference.md | 19 - .../1.0-rc.6/docs/troubleshooting.md | 23 - docs/build/wallet.rs/1.0-rc.6/docs/welcome.md | 33 - docs/build/wallet.rs/1.0-rc.6/sidebars.js | 189 - .../build/wallet.rs/1.0-rc.6/static/.nojekyll | 0 .../bg-2ab9b09901d67717ad0179ee92d7a3c1.svg | 9 - .../wallet.rs/1.0-rc.6/static/img/bg.svg | 9 - .../1.0-rc.6/static/img/iota_logo.svg | 1 - .../1.0-rc.6/static/img/libraries.png | Bin 47013 -> 0 bytes .../img/libraries/screenshot_faucet.png | Bin 32652 -> 0 bytes .../static/img/logo/Logo_Swirl_Dark.png | Bin 50898 -> 0 bytes .../1.0-rc.6/static/img/logo/favicon.ico | Bin 15086 -> 0 bytes .../1.0-rc.6/static/img/logo/wallet_light.png | Bin 1223 -> 0 bytes .../img/overview/iota_layers_overview.svg | 25 - .../1.0-rc.6/static/img/specs/erdIOTA.svg | 485 -- .../reference/style/form.md | 2 +- .../reference/style/mechanics.md | 6 +- docs/get-started/faq.md | 1 - .../chrysalis/core-concepts/EdDSA-support.md | 47 - .../binary-transaction-layout.md | 54 - .../chrysalis/core-concepts/switch-to-UTXO.md | 64 - .../core-concepts/white-flag-consensus.md | 56 - .../learn/protocols/chrysalis/introduction.md | 35 - docs/learn/protocols/chrysalis/tips.md | 22 - docs/learn/protocols/coordinator.md | 2 +- docs/learn/protocols/introduction.md | 4 +- .../core-concepts/consensus/preliminaries.md | 2 +- .../core-concepts/output-unlock-conditions.md | 2 +- docs/learn/protocols/stardust/introduction.md | 2 +- docs/learn/protocols/stardust/tips.md | 2 +- docs/learn/sidebars.ts | 19 - .../chronicle/0.3/docs/config_reference.md | 96 - .../maintain/chronicle/0.3/docs/contribute.md | 3 - .../chronicle/0.3/docs/getting_started.md | 79 - docs/maintain/chronicle/0.3/docs/welcome.md | 28 - docs/maintain/chronicle/0.3/sidebars.js | 35 - docusaurus.config.js | 32 +- .../HomeLayout/AppLibrariesSection.tsx | 38 +- static/img/libraries/accounts_addresses.svg | 1 - static/img/libraries/address_generation.svg | 4 - static/img/libraries/layered_overview.svg | 4 - static/img/libraries/messages_in_tangle.svg | 530 -- static/img/libraries/screenshot_faucet.png | Bin 32652 -> 0 bytes static/img/libraries/utxo.svg | 2045 -------- .../img/libraries/wallet-rs-layer.drawio.svg | 4 - static/robots.txt | 6 - tutorials/docusaurus.config.js | 29 - tutorials/pages/create-nft-with-wallet-lib.md | 200 - .../send-shimmer-tokens-with-wallet-lib.md | 222 - .../send-shimmer-tokens-with-wallet-lib.png | Bin 509641 -> 0 bytes tutorials/tags.json | 6 - versionedConfig.js | 84 - 1103 files changed, 47 insertions(+), 70398 deletions(-) delete mode 100644 banners/iota-streams-deprecated.mdx delete mode 100644 banners/pre-sdk-libs-deprecated.mdx delete mode 100644 docs/build/introduction-docs/chrysalis/docs/explanations/faq.md delete mode 100644 docs/build/introduction-docs/chrysalis/docs/explanations/libraries.md delete mode 100644 docs/build/introduction-docs/chrysalis/docs/explanations/node_software.md delete mode 100644 docs/build/introduction-docs/chrysalis/docs/explanations/protocol_tip.md delete mode 100644 docs/build/introduction-docs/chrysalis/docs/explanations/update/chrysalis_improvements.md delete mode 100644 docs/build/introduction-docs/chrysalis/docs/explanations/update/migration_mechanism.md delete mode 100644 docs/build/introduction-docs/chrysalis/docs/explanations/update/path_to_chrysalis.md delete mode 100644 docs/build/introduction-docs/chrysalis/docs/explanations/update/what_is_chrysalis.md delete mode 100644 docs/build/introduction-docs/chrysalis/docs/getting_started/.keep delete mode 100644 docs/build/introduction-docs/chrysalis/docs/how_tos/backup_security.md delete mode 100644 docs/build/introduction-docs/chrysalis/docs/how_tos/exchange.md delete mode 100644 docs/build/introduction-docs/chrysalis/docs/how_tos/migration/hub_migration.md delete mode 100644 docs/build/introduction-docs/chrysalis/docs/how_tos/migration/snapshot_validation_bootstrapping.md delete mode 100644 docs/build/introduction-docs/chrysalis/docs/how_tos/migration/token_migration.md delete mode 100644 docs/build/introduction-docs/chrysalis/docs/how_tos/verify_firefly_download.md delete mode 100644 docs/build/introduction-docs/chrysalis/docs/reference/.keep delete mode 100644 docs/build/introduction-docs/chrysalis/docs/reference/changelog.md delete mode 100644 docs/build/introduction-docs/chrysalis/docs/reference/details.md delete mode 100644 docs/build/introduction-docs/chrysalis/docs/reference/networks/devnet.md delete mode 100644 docs/build/introduction-docs/chrysalis/docs/reference/networks/mainnet.md delete mode 100644 docs/build/introduction-docs/chrysalis/docs/resources.md delete mode 100644 docs/build/introduction-docs/chrysalis/docs/tutorials/.keep delete mode 100644 docs/build/introduction-docs/chrysalis/docs/welcome.md delete mode 100644 docs/build/introduction-docs/chrysalis/sidebars.js delete mode 100644 docs/build/introduction-docs/stardust/docs/explanations/libraries/client.md delete mode 100644 docs/build/introduction-docs/stardust/docs/explanations/libraries/wallet.md delete mode 100644 docs/build/iota.js/2.0-rc.1/admonitions/_enable_pow.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/contribute.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/getting_started.mdx delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/how_tos/.keep delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/how_tos/address.mdx delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/how_tos/browser.mdx delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/how_tos/data.mdx delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/how_tos/mint_nft.mdx delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/how_tos/peers.mdx delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/how_tos/pow.mdx delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/how_tos/run_how_tos.mdx delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/how_tos/simple.mdx delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/how_tos/transaction.mdx delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/.keep delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/api_ref.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/classes/B1T6.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/classes/Bech32Helper.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/classes/ClientError.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/classes/Ed25519Address.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/classes/Ed25519Seed.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/classes/IndexerPluginClient.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/classes/LocalPowProvider.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/classes/PowHelper.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/classes/SingleNodeClient.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/classes/TransactionHelper.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/classes/UnitsHelper.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/enums/ConflictReason.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IAddress.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IAddressUnlockCondition.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IAliasAddress.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IAliasOutput.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IAliasUnlock.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IBasicOutput.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IBip44GeneratorState.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IBlock.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IBlockIdResponse.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IBlockMetadata.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IClient.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ICommonOutput.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IEd25519Address.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IEd25519Signature.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IExpirationUnlockCondition.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IFoundryOutput.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IGossipHeartbeat.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IGossipMetrics.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IGovernorAddressUnlockCondition.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IImmutableAliasUnlockCondition.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IIssuerFeature.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IKeyPair.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IMetadataFeature.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IMigratedFunds.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IMilestonePayload.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IMilestoneUtxoChangesResponse.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INativeToken.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INftAddress.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INftOutput.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INftUnlock.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfo.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoBaseToken.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoMetrics.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoMilestone.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoProtocol.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoProtocolParamsMilestoneOpt.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoStatus.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IOutputMetadataResponse.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IOutputResponse.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IOutputsResponse.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IPeer.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IPowProvider.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IProtocolParamsMilestoneOption.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IReceiptMilestoneOption.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IReceiptsResponse.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IReferenceUnlock.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IRent.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IResponse.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IRoutesResponse.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ISeed.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ISenderFeature.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ISignatureUnlock.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ISimpleTokenScheme.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IStateControllerAddressUnlockCondition.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IStorageDepositReturnUnlockCondition.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITagFeature.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITaggedDataPayload.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITimelockUnlockCondition.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITipsResponse.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITransactionEssence.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITransactionPayload.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITreasury.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITreasuryInput.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITreasuryOutput.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITreasuryTransactionPayload.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITypeBase.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IUTXOInput.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/SingleNodeClientOptions.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/crypto/api_ref.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/ArrayHelper.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Bech32.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Bip32Path.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Bip39.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Blake2b.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/ChaCha20.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/ChaCha20Poly1305.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Curl.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Ed25519.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/HmacSha1.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/HmacSha256.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/HmacSha512.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Pbkdf2.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Poly1305.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Sha1.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Sha256.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Sha512.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Slip0010.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/X25519.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Zip215.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/mqtt/api_ref.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/mqtt/classes/MqttClient.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/mqtt/interfaces/IMqttClient.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/mqtt/interfaces/IMqttMilestoneResponse.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/mqtt/interfaces/IMqttStatus.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/pow-browser/api_ref.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/pow-browser/classes/BrowserPowProvider.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/pow-neon/api_ref.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/pow-neon/classes/NeonPowProvider.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/pow-node/api_ref.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/pow-node/classes/NodePowProvider.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/pow-wasm/api_ref.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/pow-wasm/classes/WasmPowProvider.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/util/api_ref.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/util/classes/Base32.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/util/classes/Base58.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/util/classes/Base64.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/util/classes/BigIntHelper.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/util/classes/Converter.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/util/classes/HexHelper.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/util/classes/RandomHelper.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/util/classes/ReadStream.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/references/util/classes/WriteStream.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/troubleshooting.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/.keep delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/alias-transactions/01-introduction.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/alias-transactions/02-prepare-the-dev-env.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/alias-transactions/03-mint-new-alias.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/alias-transactions/04-alias-transaction.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/native-token-transactions/01-introduction.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/native-token-transactions/02-prepare-the-dev-env.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/native-token-transactions/03-mint-native-tokens.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/native-token-transactions/04-native-tokens-transaction.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/native-token-transactions/05-melt-native-tokens.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/nft-transactions/01-introduction.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/nft-transactions/02-prepare-the-dev-env.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/nft-transactions/03-mint-new-nft.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/nft-transactions/04-nft-transaction.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/nft-transactions/05-claim-nft.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/01-introduction.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/02-prepare-the-dev-env.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/03-generate-a-seed.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/04-generate-addresses.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/05-public-addresses.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/06-request-funds-from-the-faucet.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/07-query-output-details.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/08-transfer-funds.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/09-understanding-deposits.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/10-sweep-outputs-to-reduce-deposits.md delete mode 100644 docs/build/iota.js/2.0-rc.1/docs/welcome.md delete mode 100644 docs/build/iota.js/2.0-rc.1/sidebars.js delete mode 100644 docs/build/iota.rs/1.4/docs/_admonitions/_active_development.md delete mode 100644 docs/build/iota.rs/1.4/docs/_admonitions/_android_app_example.md delete mode 100644 docs/build/iota.rs/1.4/docs/_admonitions/_android_cross_compile.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/_admonitions/_android_gradle.md delete mode 100644 docs/build/iota.rs/1.4/docs/_admonitions/_android_unnecessary_build.md delete mode 100644 docs/build/iota.rs/1.4/docs/_admonitions/_avoid_seed_generators.md delete mode 100644 docs/build/iota.rs/1.4/docs/_admonitions/_compiling_for_android.md delete mode 100644 docs/build/iota.rs/1.4/docs/_admonitions/_dust_protection.md delete mode 100644 docs/build/iota.rs/1.4/docs/_admonitions/_enable_mqtt delete mode 100644 docs/build/iota.rs/1.4/docs/_admonitions/_example_seed_note.md delete mode 100644 docs/build/iota.rs/1.4/docs/_admonitions/_explanation_outputs.md delete mode 100644 docs/build/iota.rs/1.4/docs/_admonitions/_explanation_seeds.md delete mode 100644 docs/build/iota.rs/1.4/docs/_admonitions/_faucet_service.md delete mode 100644 docs/build/iota.rs/1.4/docs/_admonitions/_load_balancer_health_checks.md delete mode 100644 docs/build/iota.rs/1.4/docs/_admonitions/_message_finder_helper_class.md delete mode 100644 docs/build/iota.rs/1.4/docs/_admonitions/_minimum_nodes.md delete mode 100644 docs/build/iota.rs/1.4/docs/_admonitions/_password_storage.md delete mode 100644 docs/build/iota.rs/1.4/docs/_admonitions/_rust_standard.md delete mode 100644 docs/build/iota.rs/1.4/docs/_admonitions/_seed_mnemonics.md delete mode 100644 docs/build/iota.rs/1.4/docs/_admonitions/_wallet_transaction_recommendation.md delete mode 100644 docs/build/iota.rs/1.4/docs/_partials/examples/01_get_info/_client_builder.md delete mode 100644 docs/build/iota.rs/1.4/docs/_partials/examples/01_get_info/outputs/camelCase.md delete mode 100644 docs/build/iota.rs/1.4/docs/_partials/examples/01_get_info/outputs/snake_case.md delete mode 100644 docs/build/iota.rs/1.4/docs/charts.pptx delete mode 100644 docs/build/iota.rs/1.4/docs/contribute.md delete mode 100644 docs/build/iota.rs/1.4/docs/examples/data_message.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/examples/generate_addresses.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/examples/generate_seed.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/examples/get_balance.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/examples/get_info.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/examples/get_message_data.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/examples/get_outputs.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/examples/mqtt.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/examples/running_examples.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/examples/simple_message.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/examples/transaction.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/explanations/address_key_space.md delete mode 100644 docs/build/iota.rs/1.4/docs/explanations/messages_payloads_and_transactions.md delete mode 100644 docs/build/iota.rs/1.4/docs/explanations/seeds.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/getting_started/java/android_development.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/getting_started/java/getting_started.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/getting_started/nodejs.md delete mode 100644 docs/build/iota.rs/1.4/docs/getting_started/python.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/getting_started/required_prior_knowledge.md delete mode 100644 docs/build/iota.rs/1.4/docs/getting_started/rust.md delete mode 100644 docs/build/iota.rs/1.4/docs/getting_started/wasm.md delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/Address.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/AddressDto.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/AddressIndexRecorder.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/AddressPublicWrapper.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/AddressStringPublicWrapper.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/Api.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/BalanceAddressResponse.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/BrokerOptions.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/Chain.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/Client.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/ClientBuilder.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/ClientException.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/ClientMessageBuilder.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/ClientMiner.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/Essence.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/GetAddressBuilder.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/GetAddressesBuilder.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/GetBalanceBuilderApi.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/GetMessageBuilder.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/GossipDto.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/HeartbeatDto.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/IndexPublicDto.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/IndexationPayload.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/InfoResponse.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/Input.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/InputKind.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/LedgerInclusionStateDto.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/Message.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/MessageBuilder.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/MessageId.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/MessageMetadata.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/MessagePayload.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/MessagePayloadType.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/MessageWrap.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/MetricsDto.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/MigratedFundsEntry.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/MigratedFundsEntryDto.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/MilestoneId.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/MilestonePayload.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/MilestonePayloadEssence.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/MilestoneResponse.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/MilestoneSignature.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/MilestoneUtxoChangesResponse.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/MqttEvent.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/MqttListener.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/MqttManager.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/MqttTopicManager.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/NativeAPI.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/NetworkInfo.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/Node.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/NodeInfoWrapper.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/Output.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/OutputDto.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/OutputKind.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/OutputResponse.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/OutputsOptions.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/PeerDto.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/PreparedTransactionData.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/PublicKey.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/ReceiptDto.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/ReceiptPayload.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/ReceiptPayloadDto.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/ReferenceUnlock.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/RegularEssence.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/Relation.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/RustHex.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/RustLogging.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/SecretKey.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/Signature.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/SignatureLockedDustAllowanceOutput.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/SignatureLockedDustAllowanceOutputDto.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/SignatureLockedSingleOutput.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/SignatureLockedSingleOutputDto.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/SignatureUnlock.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/Topic.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/TopicEvent.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/TransactionId.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/TransactionPayload.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/TransactionPayloadBuilder.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/TreasuryInput.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/TreasuryOutput.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/TreasuryOutputDto.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/TreasuryPayload.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/TreasuryResponse.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/UnlockBlock.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/UnlockBlockKind.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/UnlockBlocks.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/Util.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api/UtxoInput.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/api_reference.md delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/examples/_01_get_info.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/examples/_02_generate_seed.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/examples/_03_generate_addresses.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/examples/_04_get_balance.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/examples/_05_get_outputs.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/examples/_06_simple_message.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/examples/_07_get_message_data.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/examples/_08_data_message.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/examples/_09_transaction.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/examples/_10_mqtt.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/java/examples/_running_examples.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/nodejs/api_reference.md delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_01_get_info.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_02_generate_seed.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_03_generate_addresses.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_04_get_balance.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_05_get_outputs.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_06_simple_message.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_07_get_message_data.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_08_data_message.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_09_transaction.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_10_mqtt.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_running_examples.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/python/api_reference.md delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/python/examples/_01_get_info.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/python/examples/_02_generate_seed.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/python/examples/_03_generate_addresses.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/python/examples/_04_get_balance.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/python/examples/_05_get_outputs.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/python/examples/_06_simple_message.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/python/examples/_07_get_message_data.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/python/examples/_08_data_message.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/python/examples/_09_transaction.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/python/examples/_10_mqtt.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/python/examples/_running_examples.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/rust/api_reference.md delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/rust/examples/_01_get_info.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/rust/examples/_02_generate_seed.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/rust/examples/_03_generate_addresses.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/rust/examples/_04_get_balance.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/rust/examples/_05_get_outputs.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/rust/examples/_06_simple_message.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/rust/examples/_07_get_message_data.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/rust/examples/_08_data_message.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/rust/examples/_09_transaction.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/rust/examples/_10_mqtt.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/rust/examples/_running_examples.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/wasm/api_reference.md delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_01_get_info.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_02_generate_seed.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_03_generate_addresses.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_04_get_balance.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_05_get_outputs.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_06_simple_message.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_07_get_message_data.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_08_data_message.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_09_transaction.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_running_examples.md delete mode 100644 docs/build/iota.rs/1.4/docs/overview.md delete mode 100644 docs/build/iota.rs/1.4/docs/specs.mdx delete mode 100644 docs/build/iota.rs/1.4/docs/troubleshooting.md delete mode 100644 docs/build/iota.rs/1.4/docs/welcome.md delete mode 100644 docs/build/iota.rs/1.4/sidebars.js delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_api_ref_coming_soon.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_dot_env_warning.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_guide_coming_soon.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_iotajs_example.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_password_storage.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_wallet_transaction_recommendation.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/contribute.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/getting_started/getting_started.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/getting_started/java.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/getting_started/nodejs.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/getting_started/python.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/getting_started/rust.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/how_tos/00_run_how_tos.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/how_tos/01_get_node_info.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/how_tos/02_generate_mnemonic.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/how_tos/03_generate_addresses.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/how_tos/04_get_output.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/how_tos/05_build_output.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/how_tos/06_get_address_balances.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/how_tos/07_create_block.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/how_tos/08_post_block.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/how_tos/09_get_block.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/how_tos/10_prepare_sign_transaction.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/how_tos/11_build_nft_output.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/how_tos/12_build_foundry_output.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/how_tos/13_build_alias_output.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/how_tos/14_mqtt.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/how_tos/15_more_examples.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/how_tos/16_use-python-with-iota.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/api_reference.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_01_get_node_info/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_01_get_node_info/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_02_generate_mnemonic/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_02_generate_mnemonic/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_03_generate_addresses/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_03_generate_addresses/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_04_get_output/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_04_get_output/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_05_build_output/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_05_build_output/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_06_get_address_balances/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_06_get_address_balances/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_07_create_block/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_07_create_block/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_08_post_block/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_08_post_block/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_08_post_raw_block/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_08_post_raw_block/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_09_get_block/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_09_get_block/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_10_prepare_signed_transaction/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_10_prepare_signed_transaction/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_11_nft_output/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_11_nft_output/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_12_foundry_output/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_12_foundry_output/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_13_alias_output/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_13_alias_output/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_run_how_tos.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_01_get_node_info/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_01_get_node_info/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_01_get_node_info/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_02_generate_mnemonic/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_02_generate_mnemonic/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_02_generate_mnemonic/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_03_generate_addresses/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_03_generate_addresses/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_03_generate_addresses/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_04_get_output/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_04_get_output/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_04_get_output/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_05_build_output/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_05_build_output/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_05_build_output/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_06_get_address_balances/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_06_get_address_balances/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_06_get_address_balances/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_07_create_block/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_07_create_block/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_07_create_block/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_08_post_block/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_08_post_block/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_08_post_block/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_09_get_block/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_09_get_block/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_09_get_block/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_10_prepare_signed_transaction/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_10_prepare_signed_transaction/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_10_prepare_signed_transaction/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_11_nft_output/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_11_nft_output/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_11_nft_output/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_12_foundry_output/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_12_foundry_output/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_12_foundry_output/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_13_alias_output/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_13_alias_output/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_13_alias_output/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_14_mqtt/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_14_mqtt/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_14_mqtt/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_run_how_tos.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/api_ref.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/classes/Client.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/classes/MessageHandler.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/enums/CoinType.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/enums/LedgerDeviceType.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/enums/Network.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/Burn.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IAliasOutputBuilderOptions.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IAuth.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IBasicOutputBuilderOptions.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IBuildBlockOptions.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IClientBlockBuilderOutputAddress.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IClientOptions.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IDuration.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IFoundryOutputBuilderOptions.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IGenerateAddressOptions.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IGenerateAddressesOptions.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IInputSigningData.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IMqttBrokerOptions.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/INetworkInfo.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/INftOutputBuilderOptions.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/INode.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/INodeInfoWrapper.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IPreparedTransactionData.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IRange.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/LedgerApp.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/LedgerNanoSecretManager.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/LedgerNanoStatus.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/MnemonicSecretManager.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/OutputIdsResponse.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/StrongholdSecretManager.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/overview.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/api_reference.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_01_get_node_info/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_01_get_node_info/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_01_get_node_info/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_02_generate_mnemonic/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_02_generate_mnemonic/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_02_generate_mnemonic/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_03_generate_addresses/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_03_generate_addresses/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_03_generate_addresses/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_04_get_output/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_04_get_output/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_04_get_output/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_05_build_output/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_05_build_output/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_05_build_output/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_06_get_address_balances/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_06_get_address_balances/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_06_get_address_balances/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_07_create_block/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_07_create_block/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_07_create_block/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_08_post_block/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_08_post_block/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_08_post_block/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_09_get_block/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_09_get_block/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_09_get_block/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_10_prepare_signed_transaction/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_10_prepare_signed_transaction/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_10_prepare_signed_transaction/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_11_nft_output/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_11_nft_output/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_11_nft_output/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_12_foundry_output/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_12_foundry_output/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_13_alias_output/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_13_alias_output/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_14_post_raw_block/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_14_post_raw_block/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_run_how_tos.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/client.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/common.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/high_level_api.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/node_core_api.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/node_indexer_api.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/secret_manager.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/utils.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/sidebar.json delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/api_reference.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_01_get_node_info/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_01_get_node_info/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_01_get_node_info/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_02_generate_mnemonic/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_02_generate_mnemonic/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_02_generate_mnemonic/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_03_generate_addresses/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_03_generate_addresses/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_03_generate_addresses/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_04_get_output/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_04_get_output/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_04_get_output/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_05_build_output/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_05_build_output/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_06_get_address_balances/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_06_get_address_balances/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_06_get_address_balances/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_07_create_block/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_07_create_block/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_07_create_block/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_08_post_block/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_08_post_block/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_08_post_block/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_08_post_raw_block/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_08_post_raw_block/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_08_post_raw_block/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_09_get_block/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_09_get_block/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_09_get_block/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_10_prepare_signed_transaction/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_10_prepare_signed_transaction/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_10_prepare_signed_transaction/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_11_nft_output/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_11_nft_output/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_11_nft_output/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_12_foundry_output/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_12_foundry_output/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_12_foundry_output/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_13_alias_output/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_13_alias_output/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_13_alias_output/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_14_mqtt/_code_sample.mdx delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_14_mqtt/_expected_output.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_14_mqtt/_key_api_ref_links.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_run_how_tos.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/node_api_core.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/overview.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/troubleshooting.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/docs/welcome.md delete mode 100644 docs/build/iota.rs/2.0-rc.7/sidebars.js delete mode 100644 docs/build/streams/0.2/docs/contribute.md delete mode 100644 docs/build/streams/0.2/docs/getting_started.md delete mode 100644 docs/build/streams/0.2/docs/libraries/overview.md delete mode 100644 docs/build/streams/0.2/docs/libraries/rust/api_reference.md delete mode 100644 docs/build/streams/0.2/docs/libraries/rust/examples.md delete mode 100644 docs/build/streams/0.2/docs/libraries/rust/getting_started.md delete mode 100644 docs/build/streams/0.2/docs/overview.md delete mode 100644 docs/build/streams/0.2/docs/specs.md delete mode 100644 docs/build/streams/0.2/docs/troubleshooting.md delete mode 100644 docs/build/streams/0.2/docs/welcome.md delete mode 100644 docs/build/streams/0.2/sidebars.js delete mode 100644 docs/build/wallet.rs/0.1/docs/contribute.md delete mode 100644 docs/build/wallet.rs/0.1/docs/examples/java.md delete mode 100644 docs/build/wallet.rs/0.1/docs/examples/nodejs.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/examples/python.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/examples/rust.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/explanations/nutshell.md delete mode 100644 docs/build/wallet.rs/0.1/docs/getting_started/java.md delete mode 100644 docs/build/wallet.rs/0.1/docs/getting_started/java_for_android.md delete mode 100644 docs/build/wallet.rs/0.1/docs/getting_started/nodejs.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/getting_started/python.md delete mode 100644 docs/build/wallet.rs/0.1/docs/getting_started/rust.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/overview.md delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/Account.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/AccountBalance.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/AccountInitialiser.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/AccountManager.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/AccountManagerBuilder.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/AccountSignerType.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/AccountSynchronizer.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/AccountsSynchronizer.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/Actor.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/ActorCallback.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/Address.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/AddressBuilder.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/AddressConsolidationNeededEvent.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/AddressConsolidationNeededListener.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/AddressData.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/AddressOutput.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/AddressWrapper.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/Api.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/BalanceChange.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/BalanceChangeListener.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/BalanceEvent.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/BroadcastTransactionListener.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/BroadcastingBundle.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/BrokerOptions.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/ClientOptions.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/ClientOptionsBuilder.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/ErrorListener.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/Essence.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/EventId.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/EventManager.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/EventType.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/FetchingMigrationData.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/IndexationPayload.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/InfoResponse.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/InputData.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/InputKind.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/Message.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/MessageId.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/MessagePayload.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/MessagePayloadType.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/MessageType.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/MigratedFundsEntry.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationAddress.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationBundle.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationBundleOptions.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationData.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationProgressEvent.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationProgressListener.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationProgressType.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/MilestoneId.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/MilestonePayload.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/MilestonePayloadEssence.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/MilestoneSignature.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/MiningBundle.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/NativeAPI.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/NewTransactionListener.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/NodeInfoWrapper.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/OutputKind.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/PreparedTransactionData.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/PublicKey.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/ReattachTransactionListener.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/ReceiptPayload.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/ReferenceUnlock.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/RegularEssence.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/RemainderValueStrategy.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/RustHex.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/RustLogging.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/Signature.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/SignatureLockedDustAllowanceOutput.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/SignatureLockedSingleOutput.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/SignatureUnlock.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/SigningBundle.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/StrongholdStatusEvent.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/StrongholdStatusListener.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/StrongholdStatusType.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/SyncedAccount.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionConfirmationChangeEvent.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionConfirmationChangeListener.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionConfirmed.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionEvent.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionIO.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionId.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionInput.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionOutput.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionPayload.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionReattachmentEvent.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/Transfer.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/TransferBuilder.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/TransferOutput.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/TransferProgress.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/TransferProgressListener.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/TransferProgressType.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/TreasuryInput.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/TreasuryOutput.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/TreasuryPayload.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/UnlockBlock.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/UnlockBlockKind.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/UtxoInput.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/Value.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/ValueUnit.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/WalletException.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/java_api/WalletTransferProgress.mdx delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/nodejs.md delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/python.md delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/rust.md delete mode 100644 docs/build/wallet.rs/0.1/docs/reference/specifications.md delete mode 100644 docs/build/wallet.rs/0.1/docs/troubleshooting.md delete mode 100644 docs/build/wallet.rs/0.1/docs/tutorials/.keep delete mode 100644 docs/build/wallet.rs/0.1/docs/welcome.md delete mode 100644 docs/build/wallet.rs/0.1/resources/charts.pptx delete mode 100644 docs/build/wallet.rs/0.1/sidebars.js delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_guide_coming_soon.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_info_iotajs.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_note_replace_native_token_id.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_note_replace_nft_id.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_password_storage.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_tip_account_approaches.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_tip_faucet.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_warning_dot_env.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_warning_safe_password_storage.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_warning_unlock_conditions.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/contribute.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/explanations/account_approaches.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/explanations/library_overview.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/getting_started/getting_started.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/getting_started/java.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/getting_started/nodejs.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/getting_started/python.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/getting_started/rust.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/how_tos/NFT/01_mint_nft.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/how_tos/NFT/02_send_nft.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/how_tos/NFT/03_burn_nft.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/how_tos/accounts_and_addresses/01_create_a_wallet_account.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/how_tos/accounts_and_addresses/02_generate_address.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/how_tos/accounts_and_addresses/03_request_funds.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/how_tos/accounts_and_addresses/04_check_balance.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/how_tos/exchange_guide.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/how_tos/more_examples.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/01_mint_native_token.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/02_send_native_token.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/03_melt_native_token.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/04_burn_native_token.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/05_destroy_foundry.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/06_destroy_alias_output.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/01_send_transaction.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/02_send_micro_transaction.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/03_list_outputs.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/04_claim_outputs.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/05_list_transactions.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/06_check_unlock_conditions.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/how_tos/run_how_tos.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/how_tos/use-python-with-IOTA.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_01_mint_nft/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_01_mint_nft/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_02_send_nft/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_02_send_nft/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_03_burn_nft/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_03_burn_nft/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/_more_examples.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/_run_how_tos.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_01_create_a_wallet_account/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_01_create_a_wallet_account/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_02_generate_address/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_02_generate_address/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_03_request_funds/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_03_request_funds/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_04_check_balance/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_04_check_balance/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_05_backup/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_05_backup/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_01_mint_native_token/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_01_mint_native_token/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_02_send_native_token/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_02_send_native_token/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_03_melt_native_token/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_03_melt_native_token/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_04_burn_native_token/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_04_burn_native_token/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_05_destroy_foundry/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_05_destroy_foundry/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_01_send_transaction/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_01_send_transaction/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_02_send_micro_transaction/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_02_send_micro_transaction/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_03_list_outputs/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_03_list_outputs/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_04_claim_outputs/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_04_claim_outputs/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_05_list_transactions/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_05_list_transactions/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_06_check_unlock_conditions/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_06_check_unlock_conditions/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_06_destroy_alias_output/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_06_destroy_alias_output/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_01_mint_nft/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_01_mint_nft/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_02_send_nft/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_02_send_nft/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_03_burn_nft/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_03_burn_nft/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/_more_examples.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/_run_how_tos.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_01_create_a_wallet_account/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_01_create_a_wallet_account/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_02_generate_address/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_02_generate_address/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_03_request_funds/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_03_request_funds/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_04_check_balance/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_04_check_balance/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_05_backup/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_05_backup/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_01_mint_native_token/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_01_mint_native_token/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_02_send_native_token/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_02_send_native_token/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_03_melt_native_token/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_03_melt_native_token/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_04_burn_native_token/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_04_burn_native_token/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_05_destroy_foundry/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_05_destroy_foundry/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_05_send_transaction/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_05_send_transaction/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_check_unlock_conditions/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_check_unlock_conditions/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_restore/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_restore/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_send_micro_transaction/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_send_micro_transaction/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_12a_list_outputs/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_12a_list_outputs/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_12c_list_transactions/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_12c_list_transactions/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_21_claim_outputs/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_21_claim_outputs/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/references/interfaces/AccountMetadata.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/references/interfaces/AliasOutputOptions.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/references/interfaces/MnemonicSecretManager.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_01_mint_nft/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_01_mint_nft/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_02_send_nft/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_02_send_nft/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_03_burn_nft/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_03_burn_nft/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/_more_examples.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/_run_how_tos.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_01_create_a_wallet_account/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_01_create_a_wallet_account/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_02_generate_address/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_02_generate_address/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_03_request_funds/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_03_request_funds/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_04_check_balance/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_04_check_balance/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_05_backup/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_05_backup/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_01_mint_native_tokens/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_01_mint_native_tokens/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_02_send_native_tokens/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_02_send_native_tokens/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_03_melt_native_token/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_03_melt_native_token/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_04_burn_native_token/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_04_burn_native_token/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_05_destroy_foundry/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_05_destroy_foundry/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_01_send_transaction/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_01_send_transaction/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_02_send_micro_transaction/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_02_send_micro_transaction/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_03_list_outputs/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_03_list_outputs/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_04_claim_outputs/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_04_claim_outputs/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_05_list_transactions/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_05_list_transactions/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_06_check_unlock_conditions/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_06_check_unlock_conditions/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_01_mint_nft/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_01_mint_nft/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_02_send_nft/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_02_send_nft/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_03_burn_nft/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_03_burn_nft/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/_more_examples.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/_run_how_tos.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_01_create_a_wallet_account/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_01_create_a_wallet_account/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_02_generate_address/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_02_generate_address/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_03_request_funds/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_03_request_funds/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_04_check_balance/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_04_check_balance/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_01_mint_native_tokens/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_01_mint_native_tokens/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_02_send_native_tokens/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_02_send_native_tokens/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_03_melt_native_token/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_03_melt_native_token/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_04_burn_native_token/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_04_burn_native_token/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_05_destroy_foundry/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_05_destroy_foundry/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_05_send_transaction/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_05_send_transaction/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_06_check_unlock_conditions/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_06_check_unlock_conditions/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_06_send_micro_transaction/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_06_send_micro_transaction/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_16_destroy_alias_output/_code_sample.mdx delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_16_destroy_alias_output/_expected_output.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/java/account.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/java/wallet.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/api_ref.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/classes/Account.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/classes/AccountManager.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/AddressType.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/CoinType.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/InclusionState.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/LedgerDeviceType.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/Network.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/OutputsToClaim.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/ReturnStrategy.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/WalletEvent.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AccountBalance.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AccountManagerOptions.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AccountMeta.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AccountMetadata.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AccountSyncOptions.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Address.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressGenerationOptions.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressNativeTokens.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressNftId.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressWithAmount.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressWithMicroAmount.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressWithUnspentOutputs.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AliasOutputOptions.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AliasSyncOptions.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Assets.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/BaseCoinBalance.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/BuildAliasOutputData.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/BuildBasicOutputData.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/BuildFoundryOutputData.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/BuildNftOutputData.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/ClientOptions.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/CreateAccountPayload.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Features.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/FilterOptions.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/GenerateAddressOptions.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/IncreaseNativeTokenSupplyOptions.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/InputSigningData.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/LedgerApp.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/LedgerNanoSecretManager.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/LedgerNanoStatus.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/LoggerConfig.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/MintTokenTransaction.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/MnemonicSecretManager.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NativeTokenBalance.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NativeTokenOptions.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NetworkInfo.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NftOptions.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NftSyncOptions.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NodeInfoWrapper.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/OutputData.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/OutputOptions.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/PreparedTransactionData.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/RemainderData.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/RequiredStorageDeposit.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/SeedSecretManager.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Segment.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/SignedTransactionEssence.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/StorageDeposit.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/StrongholdSecretManager.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/SyncOptions.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Transaction.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/TransactionOptions.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Unlocks.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/python/iota_wallet/account.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/python/iota_wallet/common.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/python/iota_wallet/secret_manager.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/python/iota_wallet/wallet.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/python/sidebar.json delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/references/rust_api_reference.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/troubleshooting.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/docs/welcome.md delete mode 100644 docs/build/wallet.rs/1.0-rc.6/sidebars.js delete mode 100644 docs/build/wallet.rs/1.0-rc.6/static/.nojekyll delete mode 100644 docs/build/wallet.rs/1.0-rc.6/static/img/bg-2ab9b09901d67717ad0179ee92d7a3c1.svg delete mode 100644 docs/build/wallet.rs/1.0-rc.6/static/img/bg.svg delete mode 100644 docs/build/wallet.rs/1.0-rc.6/static/img/iota_logo.svg delete mode 100644 docs/build/wallet.rs/1.0-rc.6/static/img/libraries.png delete mode 100644 docs/build/wallet.rs/1.0-rc.6/static/img/libraries/screenshot_faucet.png delete mode 100644 docs/build/wallet.rs/1.0-rc.6/static/img/logo/Logo_Swirl_Dark.png delete mode 100644 docs/build/wallet.rs/1.0-rc.6/static/img/logo/favicon.ico delete mode 100644 docs/build/wallet.rs/1.0-rc.6/static/img/logo/wallet_light.png delete mode 100644 docs/build/wallet.rs/1.0-rc.6/static/img/overview/iota_layers_overview.svg delete mode 100644 docs/build/wallet.rs/1.0-rc.6/static/img/specs/erdIOTA.svg delete mode 100644 docs/learn/protocols/chrysalis/core-concepts/EdDSA-support.md delete mode 100644 docs/learn/protocols/chrysalis/core-concepts/binary-transaction-layout.md delete mode 100644 docs/learn/protocols/chrysalis/core-concepts/switch-to-UTXO.md delete mode 100644 docs/learn/protocols/chrysalis/core-concepts/white-flag-consensus.md delete mode 100644 docs/learn/protocols/chrysalis/introduction.md delete mode 100644 docs/learn/protocols/chrysalis/tips.md delete mode 100644 docs/maintain/chronicle/0.3/docs/config_reference.md delete mode 100644 docs/maintain/chronicle/0.3/docs/contribute.md delete mode 100644 docs/maintain/chronicle/0.3/docs/getting_started.md delete mode 100644 docs/maintain/chronicle/0.3/docs/welcome.md delete mode 100644 docs/maintain/chronicle/0.3/sidebars.js delete mode 100644 static/img/libraries/accounts_addresses.svg delete mode 100644 static/img/libraries/address_generation.svg delete mode 100644 static/img/libraries/layered_overview.svg delete mode 100644 static/img/libraries/messages_in_tangle.svg delete mode 100644 static/img/libraries/screenshot_faucet.png delete mode 100644 static/img/libraries/utxo.svg delete mode 100644 static/img/libraries/wallet-rs-layer.drawio.svg delete mode 100644 tutorials/pages/create-nft-with-wallet-lib.md delete mode 100644 tutorials/pages/send-shimmer-tokens-with-wallet-lib.md delete mode 100644 tutorials/static/send-shimmer-tokens-with-wallet-lib.png diff --git a/.github/_CODEOWNERS b/.github/_CODEOWNERS index 05d76c6fd8f..8079ede2cf6 100644 --- a/.github/_CODEOWNERS +++ b/.github/_CODEOWNERS @@ -1,15 +1,9 @@ -# clients -**/iota.rs @thibault-martinez -**/wallet.rs @thibault-martinez +# sdk **/iota-sdk @thibault-martinez -**/iota.js @thibault-martinez # chronicle **/chronicle @Alexandcoats -# goshimmer -**/goshimmer @karimodm - # hornet and inx plugins **/hornet @muXxer **/inx-api-core-v0 @alexsporn @@ -30,8 +24,5 @@ # protocol - introduction-docs **/introduction-docs @luca-moser -# research -**/iota-2.0-research-specifications @darcy-camargo - # WASP - ISC **/wasp @fijter \ No newline at end of file diff --git a/articleRedirects.js b/articleRedirects.js index 70a1b92c8d6..6361c040885 100644 --- a/articleRedirects.js +++ b/articleRedirects.js @@ -9,30 +9,6 @@ function directoryExists(directoryPath) { } const ApiCore = [ - { - from: '/develop/category/nodes/rest-api/messages', - to: '/apis/core/v1/submit-a-message', - }, - { - from: '/develop/category/nodes/rest-api/milestones', - to: '/apis/core/v1/look-up-a-milestone-by-a-given-milestone-index', - }, - { - from: '/develop/category/nodes/rest-api/node', - to: '/apis/core/v1/returns-the-health-of-the-node', - }, - { - from: '/develop/category/nodes/rest-api/peers', - to: '/apis/core/v1/get-information-about-the-peers-of-the-node', - }, - { - from: '/develop/category/nodes/rest-api/tangle', - to: '/apis/core/v1/returns-tips-that-are-ideal-for-attaching-a-message', - }, - { - from: '/develop/category/nodes/rest-api/utxo', - to: '/apis/core/v1/find-an-output-by-its-identifier', - }, { from: '/shimmer/develop/category/nodes/core-rest-api/blocks', to: '/apis/core/v2/submit-a-block', @@ -123,7 +99,7 @@ exports.articleRedirects = [ }, { from: '/learn/about-iota/energy-efficiency', - to: '/learn/protocols/chrysalis/introduction', + to: '/learn/protocols/stardust/introduction', }, { from: '/learn/about-iota/messages', diff --git a/banners/iota-streams-deprecated.mdx b/banners/iota-streams-deprecated.mdx deleted file mode 100644 index 5414f539b49..00000000000 --- a/banners/iota-streams-deprecated.mdx +++ /dev/null @@ -1 +0,0 @@ -Streams and this documentation are no longer actively maintained. diff --git a/banners/pre-sdk-libs-deprecated.mdx b/banners/pre-sdk-libs-deprecated.mdx deleted file mode 100644 index 6af0d609c26..00000000000 --- a/banners/pre-sdk-libs-deprecated.mdx +++ /dev/null @@ -1,2 +0,0 @@ -This library has been deprecated and will no longer be updated. Please consider using the -[IOTA SDK](/iota-sdk/welcome), that will have the latest features and security updates. diff --git a/contentPlugins.js b/contentPlugins.js index c0e30df73ae..95d899fcd02 100644 --- a/contentPlugins.js +++ b/contentPlugins.js @@ -21,24 +21,6 @@ module.exports = async () => { routeBasePath: 'build', }, ...generatePluginConfig(buildPluginsConfig, __dirname + '/docs/build/'), - { - id: 'introduction-docs-chrysalis', - path: path.resolve( - __dirname, - 'docs/build/introduction-docs/chrysalis/docs', - ), - routeBasePath: 'introduction', - sidebarPath: path.resolve( - __dirname, - 'docs/build/introduction-docs/chrysalis/sidebars.js', - ), - versions: { - current: { - label: 'Chrysalis', - badge: true, - }, - }, - }, { id: 'introduction-docs-stardust', path: path.resolve( diff --git a/docs/build/apis/sidebars.js b/docs/build/apis/sidebars.js index 9b23147e54b..d4ded19f70e 100644 --- a/docs/build/apis/sidebars.js +++ b/docs/build/apis/sidebars.js @@ -37,17 +37,11 @@ const categories = [ type: 'generated-index', title: 'Core API', description: - 'The core API is the main API for interacting with the Tangle. V1 is meant for the IOTA network and V2 for the Shimmer staging network.', + 'The core API is the main API for interacting with the Tangle. V2 is now used for both IOTA and the Shimmer staging network.', slug: '/api/core', }, collapsed: true, items: [ - { - type: 'category', - label: 'V1', - collapsed: true, - items: './docs/core/v1/sidebar', - }, { type: 'category', label: 'V2', diff --git a/docs/build/getting-started/networks-endpoints.mdx b/docs/build/getting-started/networks-endpoints.mdx index e7ba8a4132e..dfb98119bea 100644 --- a/docs/build/getting-started/networks-endpoints.mdx +++ b/docs/build/getting-started/networks-endpoints.mdx @@ -3,7 +3,6 @@ description: Networks and endpoints in the IOTA ecosystem. keywords: - mainnet - shimmer - - devnet - public testnet - MQTT - REST API @@ -88,29 +87,3 @@ This network is subject to occasional resets (no data retention) which are usual | Base Token | Protocol | Chain ID | RPC URL | Faucet | Explorer | | ------------------------- | --------- | -------- | -------------------------------------------- | ------------------------------------------ | -------------------------------------------- | | Testnet Tokens (no value) | ISC / EVM | | https://json-rpc.evm.testnet.shimmer.network | https://evm-faucet.testnet.shimmer.network | https://explorer.evm.testnet.shimmer.network | - -## DevNet - -:::caution -This network is going to be decommissioned by the end of 2023, -consider building on the Public Testnet instead. -::: - -[The DevNet](https://explorer.iota.org/legacy-mainnet) is a legacy network running the Chrysalis protocol. - -| Base Token | Protocol | HTTP REST API | Event API | Permanode API | Faucet | -| ------------------------- | --------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------- | -------------------------------------- | -| Testnet Tokens (no value) | Chrysalis | https://api.lb-0.h.chrysalis-devnet.iota.cafe , https://api.lb-1.h.chrysalis-devnet.iota.cafe | wss://api.lb-0.h.chrysalis-devnet.iota.cafe:443 (MQTT 3.1, /mqtt) | https://chronicle.testnet.shimmer.network | https://faucet.testnet.shimmer.network | - -## Legacy - -:::caution -With the upgrade of the IOTA Mainnet to the Stardust protocol, migrations have been stopped and will re-commence -once a new mechanism via an L2 chain is set up. -::: - -The legacy IOTA Mainnet was running for the sole purpose to facilitate token migrations into the IOTA Mainnet. - -| Base Token | Protocol | HTTP REST API | -| ----------------------- | ----------------------- | --------------------------------- | -| IOTA Token (Unmigrated) | Legacy Trinary Protocol | https://api-legacy.iotaledger.net | diff --git a/docs/build/getting-started/sidebars.ts b/docs/build/getting-started/sidebars.ts index d5c01247478..c43731c91c2 100644 --- a/docs/build/getting-started/sidebars.ts +++ b/docs/build/getting-started/sidebars.ts @@ -70,7 +70,7 @@ module.exports = { { type: 'link', label: 'IotaWallet.NET', - href: 'https://github.com/IOTA-NET/IotaWallet.NET', + href: 'https://github.com/IOTA-NET/IotaSDK.NET', }, { type: 'link', diff --git a/docs/build/identity.rs/1.0/docs/explanations/about-alias-outputs.mdx b/docs/build/identity.rs/1.0/docs/explanations/about-alias-outputs.mdx index a18cea25fcb..4a7a0123700 100644 --- a/docs/build/identity.rs/1.0/docs/explanations/about-alias-outputs.mdx +++ b/docs/build/identity.rs/1.0/docs/explanations/about-alias-outputs.mdx @@ -26,7 +26,7 @@ and which can be transferred through transactions to update DID Documents. ::: -The IOTA DID method uses the IOTA ledger, which is baed on the [unspent transaction output (_UTXO_) model](/learn/protocols/chrysalis/core-concepts/switch-to-UTXO/), +The IOTA DID method uses the IOTA ledger, which is baed on the unspent transaction output (_UTXO_) model, as well as the features of the [Stardust](/introduction/stardust/explanations/what_is_stardust) upgrade, which are fundamental to the IOTA DID method. @@ -38,7 +38,7 @@ A state controller can execute a state transition which allows updating the data The governor, on the contrary, can't update the `State Metadata` but can change both controllers and destroy the Alias Output. -A controller can be either [Ed25519 Address](/learn/protocols/chrysalis/core-concepts/switch-to-UTXO/), [Alias Address or an _NFT_ Address](/learn/protocols/stardust/core-concepts/multi-asset-ledger/) +A controller can be either Ed25519 Address, [Alias Address or an _NFT_ Address](/learn/protocols/stardust/core-concepts/multi-asset-ledger/) and at most one of each can be set for an Alias Output. In order to create a new Alias Output, a transaction must be made that includes another Output, for example, diff --git a/docs/build/identity.rs/1.0/docs/how-tos/decentralized-identifiers/create.mdx b/docs/build/identity.rs/1.0/docs/how-tos/decentralized-identifiers/create.mdx index b5aed539e40..5c3f0bccc25 100644 --- a/docs/build/identity.rs/1.0/docs/how-tos/decentralized-identifiers/create.mdx +++ b/docs/build/identity.rs/1.0/docs/how-tos/decentralized-identifiers/create.mdx @@ -96,7 +96,7 @@ https://github.com/iotaledger/identity.rs/blob/main/bindings/wasm/examples/src/0 Next, you need to construct a new [Alias Output](../../explanations/about-alias-outputs.mdx) that includes the DID Document in the [State Metadata](../../explanations/about-alias-outputs.mdx). The created Alias Output contains an encoded version of the DID Document in its `State Metadata`, and has the state -controller and the governor set to the generated [Ed25519](/learn/protocols/chrysalis/core-concepts/EdDSA-support/) address. +controller and the governor set to the generated Ed25519 address. Note that controllers don't need to be Ed25519 addresses, they can be any type of output. However, they must be unlocked in order perform a state or governance transition when the DID Document is updated or destroyed. diff --git a/docs/build/identity.rs/1.0/docs/references/specifications/iota-did-method-spec.mdx b/docs/build/identity.rs/1.0/docs/references/specifications/iota-did-method-spec.mdx index e202844f68d..87787af978b 100644 --- a/docs/build/identity.rs/1.0/docs/references/specifications/iota-did-method-spec.mdx +++ b/docs/build/identity.rs/1.0/docs/references/specifications/iota-did-method-spec.mdx @@ -18,7 +18,7 @@ keywords: ## Abstract -The IOTA DID Method Specification describes a method of implementing the [Decentralized Identifiers](https://www.w3.org/TR/did-core/) (DID) standard on [IOTA](https://iota.org), a Distributed Ledger Technology (DLT). It conforms to the [DID specification v1.0](https://www.w3.org/TR/did-core/) and describes how to perform Create, Read, Update and Delete (CRUD) operations for IOTA DID Documents using unspent transaction outputs ([_UTXO_](/introduction/reference/details#unspent-transaction-output-utxo)) on the IOTA and [Shimmer](https://shimmer.network/) networks, introduced with the [Stardust upgrade](https://blog.shimmer.network/stardust-upgrade-in-a-nutshell/). +The IOTA DID Method Specification describes a method of implementing the [Decentralized Identifiers](https://www.w3.org/TR/did-core/) (DID) standard on [IOTA](https://iota.org), a Distributed Ledger Technology (DLT). It conforms to the [DID specification v1.0](https://www.w3.org/TR/did-core/) and describes how to perform Create, Read, Update and Delete (CRUD) operations for IOTA DID Documents using unspent transaction outputs (_UTXO_) on the IOTA and [Shimmer](https://shimmer.network/) networks, introduced with the [Stardust upgrade](https://blog.shimmer.network/stardust-upgrade-in-a-nutshell/). ## Data Types & Subschema Notation diff --git a/docs/build/introduction-docs/chrysalis/docs/explanations/faq.md b/docs/build/introduction-docs/chrysalis/docs/explanations/faq.md deleted file mode 100644 index cf9e8574fa7..00000000000 --- a/docs/build/introduction-docs/chrysalis/docs/explanations/faq.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -description: Frequently asked questions regarding the Chrysalis implementation. -image: /img/logo/Chrysalis_logo_dark.png -keywords: - - FAQ - - dust protection - - coordicide - - transactions - - hornet - - libraries - - wallet.rs - - iota.rs - - Firefly - - C - - spent addresses - - bundle mining - - explanation ---- - -# FAQ - -## Which Libraries are Available for Chrysalis? - -At this time, there are a handful of libraries available for Chrysalis which are outlined below: - -A low-level library called [iota.rs](https://github.com/iotaledger/iota.rs) which is a client library meant to connect to an IOTA node for core interactions with the Tangle. It is written in Rust and there are currently two bindings for Node.js and Python allowing you to use this library from those languages as well. - -For _value transactions_, there is the [wallet.rs](https://github.com/iotaledger/wallet.rs) library which provides a stateful way to manage IOTA coins for one or multiple accounts. It is also written in Rust and there are currently two bindings for Node.js and Python. - -Additionally, there is also a native C ([iota.c](https://github.com/iotaledger/iota.c)) and an alternative, native javascript ([iota.js](https://github.com/iotaledger/iota.js/tree/chrysalis)) client library. - -## What is Dust Protection and How Does it Work? - -Since IOTA is feeless and has the ability to send microtransactions, attackers could use this to spam the network with very low-_value transactions_, which we call dust. To avoid this, we only allow microtransactions below 1Mi of IOTA tokens to another address if you already have at least 1Mi on that address. - -For reference, you can read more about _Dust Protection_ on this [RFC](https://github.com/iotaledger/protocol-rfcs/pull/32). - -## What is Happening with Coordicide? - -The Chrysalis release still depends on the Coordinator/Compass to run and issue milestones. The next big release after Chrysalis will be Coordicide, where we will get rid of that dependency. This release is currently in a research/testing phase and will be the main priority after the Chrysalis release. - -## When is a Transaction on the Network Considered Final/Irreversible? - -On average, confirmation times on the new network are around 10 seconds. Once a transaction is set to confirm its final transaction, you do not have block confirmations like with blockchain. - -## What are Spent Addresses and Why are they Dangerous? - -- In the IOTA 1.0 network, IOTA used Winternitz One Time Signatures (W-OTS) - think of these as, more or less, an authenticator and validator for a transaction. These keys and signatures are highly secure against malicious attacks for signing transactions. But, on the downside, by signing a transaction, W-OTS reveals parts of a private key for the specific address tokens are being spent from. -- With W-OTS, every time a signature is used to spend tokens from a particular address, any remaining tokens need to be moved onto a new address to prevent malicious actors from brute-forcing (trial-and-error guessing) the remaining parts of the private key for the address. That’s the main reason why this signature scheme is considered to be a “one-time signature”. -- So, after our Chrysalis update, we are now using the Ed25519, based on the EdDSA, scheme instead of W-OTS. The advantage is that the new scheme addresses all of the issues that W-OTS originally had. Ed25519 verifies both single-signature and batch verification (taking care of the remaining tokens) very quickly, as well as faster key generation and smaller signatures which make it very secure. - -## What is Bundle Mining? - -- If you have spent addresses, it means you accidentally received funds to an address that was already spent from, and these funds are not safe to send again due to W-OTS. -- To secure your spent addresses during the migration, [Firefly](https://github.com/iotaledger/firefly) will try to find a new bundle that reveals the least amount of additional private key parts compared to previous signatures. -- This process will take 10 minutes per spent address and upon completion you will be presented with a risk calculation (very high, high, medium, low, very low). We recommended that you repeat the process if it returns a bundle with medium risk or higher, particularly for significant sums of IOTA. You have the option to select which addresses you want to mine for, and again which you want to rerun the process for. diff --git a/docs/build/introduction-docs/chrysalis/docs/explanations/libraries.md b/docs/build/introduction-docs/chrysalis/docs/explanations/libraries.md deleted file mode 100644 index e50dd9fca05..00000000000 --- a/docs/build/introduction-docs/chrysalis/docs/explanations/libraries.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: The IOTA client libraries allow you to easily integrate IOTA into your own applications. -image: /img/logo/Chrysalis_logo_dark.png -keywords: - - wallet library - - client library - - Tangle - - C - - golang - - javascript - - rust - - explanation ---- - -# Libraries - -With the IOTA client libraries you can easily integrate IOTA into your own applications. You can choose a library to match your use case. - -The official IOTA libraries serve as `one-source-code-of-truth` to IOTA users and provide binding to other programming languages. Below is a list of the IOTA libraries. You can also check out the [IOTA client libraries blog post](https://blog.iota.org/the-new-iota-client-libraries-harder-better-faster-stronger/), to learn about the libraries' core principles. - -- [client-lib](/iota.rs/welcome): a general purpose IOTA client library for interacting with the IOTA network (Tangle). -- [wallet-lib](/wallet.rs/welcome): a stateful library specifically designed to be used for IOTA value-based transfers . -- [iota.c](https://github.com/iotaledger/iota.c): a special-purpose library in C for embedded devices (with microcontrollers) covering a basic features of `client-lib` or `wallet-lib.` -- [iota.js](https://github.com/iotaledger/iota.js/tree/chrysalis): an initial IOTA client library in Typescript that can be used in a web browser. -- [iota.go](https://github.com/iotaledger/iota.go/tree/chrysalis/phase2): an initial IOTA client library in Golang. - -
- -
- -![Libraries Overview](/img/guides/overview-libraries.svg) - -Currently, all of the libraries are in active development. The libraries target the Chrysalis _devNet_ and no longer work with the previous IOTA mainnet. - -The IOTA foundation is in charge of maintaining the official client libraries. You can find the libraries' source code in the [Official GitHub repository](https://github.com/iotaledger). - -## Utilities - -#### **Developer tools** - -- [Official explorer](https://explorer.iota.org/mainnet). -- [Devnet faucet](https://faucet.devnet.chrysalis2.com/). -- [Commandline wallet](https://github.com/iotaledger/cli-wallet). - ---- diff --git a/docs/build/introduction-docs/chrysalis/docs/explanations/node_software.md b/docs/build/introduction-docs/chrysalis/docs/explanations/node_software.md deleted file mode 100644 index a697d7f23f3..00000000000 --- a/docs/build/introduction-docs/chrysalis/docs/explanations/node_software.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -description: Hornet is the officially supported node software for IOTA. -image: /img/logo/Chrysalis_logo_dark.png -keywords: - - Node - - Hornet - - Golang - - Rust - - explanation ---- - -# Node Software - -We have been running the network exclusively on the Go powered Hornet node since the summer of 2020. - -## Hornet - -Hornet is the officially supported node software for IOTA. - -Hornet is an EDF-supported community node written in Go and has already proven itself to be a stable and performant implementation. - -## Hornet - -- [Official GitHub Repository](https://github.com/gohornet/hornet). -- [Documentation](/hornet/welcome). - -## Node API Specification - -- [rest-api specification](https://editor.swagger.io/?url=https://raw.githubusercontent.com/iotaledger/tips/main/tips/TIP-0013/rest-api.yaml). diff --git a/docs/build/introduction-docs/chrysalis/docs/explanations/protocol_tip.md b/docs/build/introduction-docs/chrysalis/docs/explanations/protocol_tip.md deleted file mode 100644 index b8930cfb238..00000000000 --- a/docs/build/introduction-docs/chrysalis/docs/explanations/protocol_tip.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -description: The Chrysalis protocol changes are described in full detail in the TIPs. -image: /img/logo/Chrysalis_logo_dark.png -keywords: - - TIP - - RFC - - protocol - - GIT - - explanation ---- - -# IOTA Protocol TIPs - -Changes to the IOTA protocol have to go through a proposal process first, where a proposal is posted as a "Tangle Improvement Proposal" (TIP). The Chrysalis protocol changes are described in full detail in the TIPs found below: - -- [Git Repo](https://github.com/iotaledger/tips/pulls). diff --git a/docs/build/introduction-docs/chrysalis/docs/explanations/update/chrysalis_improvements.md b/docs/build/introduction-docs/chrysalis/docs/explanations/update/chrysalis_improvements.md deleted file mode 100644 index 60317e55bfe..00000000000 --- a/docs/build/introduction-docs/chrysalis/docs/explanations/update/chrysalis_improvements.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -keywords: - - Coordicide - - mainnet - - protocol improvements - - explanation -description: Specific Chrysalis improvements over IOTA 1.0. -image: /img/logo/Chrysalis_logo_dark.png ---- - -# Chrysalis Improvements - -## White-flag Approach - -![White-flag approach](/img/introduction/what_is_chrysalis/01.png) -[The White-flag approach](https://iota.cafe/t/conflict-white-flag-mitigate-conflict-spamming-by-ignoring-conflicts/233), which is used for calculating balances. It is a simpler, conflict-ignoring approach that improved the speed and efficiency of _tip selection_, eliminated many network attacks, and significantly reduced the need for reattachments. - -## New Milestone Selection Algorithm - -![New Milestone Selection Algorithm](/img/introduction/what_is_chrysalis/02.png) -[A new milestone selection algorithm for the Coordinator](https://iota.cafe/t/coordinator-improvements/310) that focuses on allowing the network to support many more confirmed transactions per second (_CTPS_) than before, with higher computational efficiency. - -## URTS Tip Selection - -![URTS Tip Selection](/img/introduction/what_is_chrysalis/03.png) -A new [Uniform Random Tip Selection](https://github.com/iotaledger/protocol-rfcs/blob/master/text/0008-uniform-random-tip-selection/0008-uniform-random-tip-selection.md) in node software. It is significantly faster and more efficient than the previous _tip selection_ algorithm. - -## Ed25519 Signature Scheme - -![Ed25519 Signature Scheme](/img/introduction/what_is_chrysalis/04.png) -[The Ed25519 signature scheme](https://github.com/iotaledger/protocol-rfcs/blob/ee07797acb5940b7dbb5c3411b184ccdc6afdbb1/text/0000-ed25519-signature-scheme/0000-ed25519-signature-scheme.md) has been added to the network, replacing the current Winternitz one time signature scheme (W-OTS) signature scheme. Using an EdDSA signature scheme allows the protocol and clients using the protocol to run more efficiently on established hardware. Unlike W-OTS, the Ed25519 signature scheme also allows for the re-use of private keys, and, with that, introduces _reusable addresses_ to the protocol. This change also dramatically reduces the transaction size, saving network bandwidth and processing time. - -## Atomic Transactions - -![Atomic Transactions](/img/introduction/what_is_chrysalis/05.png) -[Atomic transactions](https://github.com/luca-moser/protocol-rfcs/blob/signed-tx-payload/text/0000-transaction-payload/0000-transaction-payload.md) that move the protocol from the current, complicated, bundle construct and use simpler atomic transactions instead. This results in much simpler development, and more adaptable and maintainable code of the core software. In addition, atomic transactions reduce network overhead, reduce transaction validation and signature verification load, and improve spam protection and congestion control. - -## Switch to UTXO Model - -![Switch to UTXO Model](/img/introduction/what_is_chrysalis/06.png) -[Switch to the UTXO model](https://iota.cafe/t/switching-to-utxo-model-for-balances-colored-coins-easier-conflict-resolution/229) from the current account model. Every coin on an address becomes uniquely identifiable and every spend names the exact coins that it wants to move. This allows for faster and more exact conflict handling and improves resilience and security of the protocol. In addition, switching to UTXO makes other functionalities, such as colored tokens, on the protocol possible in the future. - -## Internal Binary Representation - -![Internal Binary Representation](/img/introduction/what_is_chrysalis/07.png) -[A switch to an internal binary representation of the trinary transaction](https://github.com/luca-moser/protocol-rfcs/blob/signed-tx-payload/text/0000-transaction-payload/0000-transaction-payload.md). This allows us to work on binary data for validation, IO, and other processing, without the current reliance on binary-ternary conversions as in the pre-Chrysalis node software. The switch to binary transactions further reduces transaction size, saving network bandwidth and processing time. - -## New Node API and Client Libraries - -With Chrysalis, we wanted to offer a more standard API on both the node and client library level. Node implementations provide a completely redesigned [RESTful](https://editor.swagger.io/?url=https://raw.githubusercontent.com/rufsam/protocol-rfcs/master/text/0026-rest-api/rest-api.yaml) and [eventful](https://playground.asyncapi.io/?load=https://raw.githubusercontent.com/luca-moser/protocol-rfcs/rfc/node-event-api/text/0033-node-event-api/0033-node-event-api.yml) API implementations. - -Our [client libraries](/build/welcome) provide high-level abstractions that allow developers to build solutions that are easier to develop and cheaper to maintain. - -## Full Changelog - -You can find a [full list of changes](../../reference/changelog.md) in the reference section. diff --git a/docs/build/introduction-docs/chrysalis/docs/explanations/update/migration_mechanism.md b/docs/build/introduction-docs/chrysalis/docs/explanations/update/migration_mechanism.md deleted file mode 100644 index a3347c9cd68..00000000000 --- a/docs/build/introduction-docs/chrysalis/docs/explanations/update/migration_mechanism.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -description: This page describes the migration components and mechanism used to migrate from IOTA 1.0 to IOTA 1.5 (Chrysalis). -image: /img/logo/Chrysalis_logo_dark.png -keywords: - - WOTS addresses - - trustless - - migration mechanism - - treasury - - Firefly - - wallet - - legacy nodes - - explanation ---- - -# How the IOTA Chrysalis Phase 2 Token Migration Works - -:::caution -Since the launch of the Stardust protocol on the IOTA _Mainnet_, this mechanism is no longer applied, instead -the migrations will be facilitated through an L2 solution. -::: - -For the Chrysalis Phase 2 transition, the IOTA Foundation developed a way to migrate funds to the new network. IOTA created this new mechanism because the previous network did not support the WOTS addresses. - -Before proceeding into the developed mechanism, below is our reasoning for why other mechanisms were not chosen: - -- `Migrating funds by performing periodic global snapshots on both networks`: while this approach would have - been the easiest to do, it would have blocked the funds of people between the times of global snapshots. For example, if - we would have taken global snapshots monthly (to carry over funds from burn/migration addresses), token holders would - have been excluded from opportunities arising from the change in token price. In this case, perhaps a user wanted to sell - tokens but were blocked by the fact that the next global _snapshot_ would only be performed in 20 days and so they - couldn't move their tokens to an exchange (which only supports Chrysalis Phase 2 IOTA). -- `Supporting WOTS on Chrysalis Phase 2 (and only allowing to send to non-WOTS addresses)`: while this was also a - viable option, we decided not to include support for WOTS as it brought several legacy problems: - - WOTS signatures are very large and make up a disproportional amount of data in a transaction (note that our PoW - requirement in Chrysalis' Phase 2 was dependent on the size of the message). Additionally, there were no real bounds - on how big such signatures could grow to (even if, per the default, we only supported three security levels in our - libraries). - - We would have needed to pollute our new Chrysalis Phase 2 models with support for these addresses and signatures, - adding unnecessary complexity to what should be a clean protocol. - - Chrysalis Phase 2 nodes would have needed to keep a spent address list to inform wallets that they had vulernable - addresses. - -## Components - -The developed migration mechanism was built from the following components: - -- Chrysalis phase 2 data types (for reference, see [the RFC](https://github.com/luca-moser/protocol-rfcs/blob/rfc/wotsicide/text/0035-wotsicide/0035-wotsicide.md) for details): - - `Treasury Output`: an object which specified an amount of tokens held in the treasury. - - `Treasury Input`: an object which referenced a previous `Treasury Output`. - - `Treasury Transaction`: an object which defined a `Treasury Input` referencing the last `Treasury Output` and a - new `Treasury Output` that held the delta of what the `Treasury Transaction` was spending. - - `Receipt`: an object which held a pointer to a legacy milestone index, a list of funds to mint, and - a `Treasury Transaction`. A `Receipt` can only be an inner payload of a _milestone_. -- Chrysalis Phase 2 nodes which validated receipts. -- Legacy nodes which provided a special API command for the above Chrysalis Phase 2 nodes. -- `Treasury`: this was the last `Treasury Output` in the ledger. At one point, only one existed. - After Chrysalis Phase 2 network launched, the `Treasury` contained the total supply of tokens (2779530283277761) aside from the funds that were already migrated during the "7-day-migration-period" prior to the network launch. This means that all funds which are not migrated from the legacy network, will always reside in the `Treasury`. - -:::note - -A `Receipt` could only be contained within a milestone and that valid milestones could only be issued by -the Coordinator. Therefore, a minting of migrated funds could only happen through milestones and not any other type of -transactions. Likewise, a `Treasury Transaction` was only valid as an inner payload of a `Receipt`. - -::: - -## How it Actually Works - -1. In essence, a `Receipt` carried the information about funds which were migrated or "burned" to a `migration address` - on the legacy network. A `migration address` looks like any other normal address on the legacy network but it - encapsulates actual information, such as: - - The target Ed25519 address on the Chrysalis Phase 2 network from which the token holder wants their funds to be - accessible from. - - A checksum of that Ed25519 address. - - A tryte prefix `TRANSFER` (these addresses always start with this prefix). -2. As mentioned above, a `Receipt` could only be contained in a milestone and therefore the Coordinator on the Chrysalis - Phase 2 network. - 1. Periodically polled data from a legacy node about what kind of newly confirmed burned/migrated funds there were (while also performing WOTS signature verification on these and the legacy milestone bundle). - 2. Then a milestone is produced with a `Receipt` that contained those funds, where within the `Receipt`, - a `Treasury Transaction` was placed which deducts the sum of tokens migrated from the `Treasury`. -3. Chrysalis Phase 2 nodes then saw receipts when applying milestones and automatically generated outputs for the Ed25519 - address as defined in the origin `migration address` in the legacy network. As an optional step (which is not turned - on by default), every node could have been configured to verify whether the funds in the receipt were really migrated in the - old network using a legacy node and whether all funds for a given legacy milestone index were migrated. If this - verification failed, the node would have automatically panicked as the integrity was no longer correct. - -This meant that: - -- The IOTA Foundation could not mint funds out of thin air, because nodes in the Chrysalis Phase 2 network verified that the - funds were burned in the legacy network. -- All migration bundles, respectively transferred to `migration addresses` which were _confirmed_ by a given legacy - milestone, had to have been migrated fully to the new network, as otherwise the verification failed. -- Node operators were free to choose which legacy nodes they queried with their Chrysalis Phase 2 nodes, so the - verification of migrations/receipts was decentralized. For example, a node operator chose to both operate their own - legacy and Chrysalis Phase 2 nodes. - -Essentially, via the _Firefly_ wallet, token holders: - -1. Produced migration bundles which sent funds to `migration addresses` controlled by the given owner. -2. These bundles were confirmed on the legacy network. -3. The Chrysalis Phase 2 Coordinator picked these confirmed legacy bundles up and generated receipts minting those funds - to the target Ed25519 address. -4. Verifier nodes verified the receipts and made sure that the funds originated from the legacy network. - -### Verifier Node - -A verifier node is a Chrysalis Phase 2 node which upon seeing receipts: - -1. Queries a legacy node for the confirmation data for the specified milestone in the receipt. -2. Then performs WOTS signature verification of the legacy milestone bundle and all confirmed bundles. -3. Additionally, it also checks that all confirmed funds on the legacy network for the given legacy milestone, are indeed minted with a given batch of receipts (i.e. nothing is left out). diff --git a/docs/build/introduction-docs/chrysalis/docs/explanations/update/path_to_chrysalis.md b/docs/build/introduction-docs/chrysalis/docs/explanations/update/path_to_chrysalis.md deleted file mode 100644 index b3770b95af5..00000000000 --- a/docs/build/introduction-docs/chrysalis/docs/explanations/update/path_to_chrysalis.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -description: Chrysalis was the most promising series of upgrades made to IOTA yet with increased transaction _throughput_, network stability, and improved usability. -image: /img/logo/Chrysalis_logo_dark.png -keywords: - - EdDSA - - phases - - upgrades - - performance - - tip selection - - UTXO - - efficiency - - explanation ---- - -# Path to Chrysalis - -One of the IOTA Foundation’s primary roles is defining and delivering on a development roadmap that aligns with the Foundation's strategy to reach production-readiness and adoption. - -The IOTA _mainnet_ has been operational since 2016 and the overall engineering strategy evolved significantly based on industry demand and feedback. - -Progress in Coordicide research has resulted in identifying many concepts that could already be implemented on the current IOTA mainnet and provides significant value to users of the protocol before Coordicide. This led to the formalization of our engineering strategy around Chrysalis: a series of upgrades to the protocol that achieves production-readiness before Coordicide. - -The benefit of this approach is that many of the protocol properties will remain the same, or almost the same, for Coordicide. That, together with a better set of developer tools, will make the transition to Coordicide much simpler. - -The intended outcomes for Chrysalis were: - -- **A simpler transition to Coordicide** - With Coordicide making significant progress, we wanted to ensure that all developers and companies that built and deployed on Chrysalis would have as smooth a transition to Coordicide as possible. -- **Substantial performance improvements** - With the changes introduced by Chrysalis, we saw a substantial improvement in the scalability and reliability of the IOTA Mainnet. -- **Improved developer and user experience** - With the new protocol features, new libraries, and the new wallet, we strived to make IOTA a platform to build on by enhancing the developer's experience today while allowing solutions built on top of the protocol to provide a better experience. -- **Accelerated adoption** - Chrysalis made IOTA production-ready by becoming a stable protocol, with a reliable set of developer tools and frameworks that enabled startups, corporations, and governments to develop and launch products powered by IOTA. - -## The Stages to Chrysalis - -![The stages to Chrysalis](/img/introduction/path_to_chrysalis/01.png) - -The Chrysalis upgrade was a complex undertaking. We coordinated a number of distinct products to ensure a smooth transition for IOTA’s you and the partners. In addition to the core node software, we also needed to update our wallet software, our libraries, and the entire infrastructure. - -Another important requirement was the ease of transition to the future Coordicide network. By carefully planning the breaking changes introduced along the way, and providing support in our developer tools, we ensured that our growing ecosystem of developers, startups, and corporations could reliably develop and launch new innovative products on IOTA. - -The plan for implementing Chrysalis was divided into two phases: - -**The first phase** consisted of improved tip selection (URTS), milestone selection, and White flag. These were gradually implemented in the node software. This phase required an upgrade of all nodes, including the _coordinator_ node, and did not require a snapshot. - -The first phase of Chrysalis resulted in: - -- _Transaction confirmation_ times of around 10 seconds. -- Transactions rarely needing reattachment. -- A substantial TPS increase. -- Performance and reliability improvements for nodes. - -**The second phase** of Chrysalis consisted of adopting and/or implementing UTXO, atomic transactions, _reusable addresses_ (Ed25519), a transition to a binary transaction layout, and a new set of client libraries and developer tools. These represented significant changes to the core protocol and the way transactions were structured. Once everything was tested, validated, and audited, the Foundation deployed a new Chrysalis network. The upgrade consisted of an extended period when the legacy network remained operational which allowed users, exchanges, and partners to migrate to the Chrysalis network at will. - -The second phase of Chrysalis consisted of: - -- Reusable addresses and support for more standard cryptography (EdDSA), making efficient hardware support for all major architectures possible. -- A simplified transaction layout and a reduction in transaction size, further increasing performance and efficiency. -- Significant improvements to the usability and reliability of IOTA. -- A switch to a UTXO based model from the previous account model. - -The introduction of reusable addresses was an important change for token holders. This vastly improved IOTA’s usability and made integration into new exchanges, wallets, and payment systems much simpler. A new wallet, called Firefly, was released with Chrysalis which allowed token holders to transition from the WOTS address scheme to the new EdDSA scheme. - -### From Plan to Action - -With Chrysalis, we had to make decisions on how to best implement all the upcoming changes, ensuring a correct and timely implementation. What follows is an overview of the various components we worked on to successfully implement this update. - -### Specification and Standardization - -Specifications are a major part of our new development process. All our new software projects (Node software, Wallet, Identity, Access, Streams, etc.) were based on vetted specifications. Specifications make it possible for external parties to follow a project’s intended functionality, for example for audit purposes, or develop their own implementations in different languages. - -The Chrysalis changes were specified in the form of RFCs. You can find all the RFCs in the [protocol-rfcs repository](https://github.com/iotaledger/protocol-rfcs). The list of Chrysalis RFCs includes: - -- [Improved tip selection (URTS)](https://github.com/luca-moser/protocol-rfcs/blob/rfc-urts-tip-sel/text/0008-weighted-uniform-random-tip-selection/0008-weighted-uniform-random-tip-selection.md). -- [Milestone selection](https://github.com/iotaledger/protocol-rfcs/blob/milestone-merkle-validation-chrysalis-pt-2/text/0012-milestone-merkle-validation/0012-milestone-merkle-validation.md). -- [White flag](https://github.com/thibault-martinez/protocol-rfcs/blob/rfc-white-flag/text/0005-white-flag/0005-white-flag.md). -- [UTXO.](https://github.com/hmoog/protocol-rfcs/blob/master/text/0011-utxo-model/0011-utxo-model.md) -- [Ed25519 Signature Scheme](https://github.com/iotaledger/protocol-rfcs/blob/ee07797acb5940b7dbb5c3411b184ccdc6afdbb1/text/0000-ed25519-signature-scheme/0000-ed25519-signature-scheme.md). -- [Reusable addresses (Ed25519)](https://github.com/Wollac/protocol-rfcs/blob/ed25519/text/0009-ed25519-signature-scheme/0009-ed25519-signature-scheme.md). -- [Message object.](https://github.com/GalRogozinski/protocol-rfcs/blob/message/text/0017-message/0017-message.md) -- [Binary transaction layout](https://github.com/luca-moser/protocol-rfcs/blob/signed-tx-payload/text/0000-transaction-payload/0000-transaction-payload.md). -- [Message proof of work.](https://github.com/Wollac/protocol-rfcs/blob/message-pow/text/0024-message-pow/0024-message-pow.md) -- [Dust protection](https://github.com/GalRogozinski/protocol-rfcs/blob/dust/text/0032-dust-protection/0032-dust-protection.md). -- [New local snapshot file format.](https://github.com/luca-moser/protocol-rfcs/blob/local-snapshot-file-format/text/0000-local-snapshot-file-format/0000-local-snapshot-file-format.md) -- [Bech32 address format](https://github.com/Wollac/protocol-rfcs/blob/bech32-address-format/text/0020-bech32-address-format/0020-bech32-address-format.md). -- [RESTful node API.](https://editor.swagger.io/?url=https://raw.githubusercontent.com/rufsam/protocol-rfcs/master/text/0026-rest-api/rest-api.yaml) -- [Eventful node API.](https://playground.asyncapi.io/?load=https://raw.githubusercontent.com/luca-moser/protocol-rfcs/rfc/node-event-api/text/0033-node-event-api/0033-node-event-api.yml) - -### Wallet Support - -The Trinity wallet was a popular IOTA wallet. With Chrysalis, we released a new wallet implementation, [Firefly](https://blog.iota.org/firefly-iota-next-generation-wallet-26bdd4d01510/). The team worked on a complete reevaluation of the wallet architecture, with a completely redesigned experience for you. At its core is a [new wallet library](/wallet.rs/welcome) written in Rust. The wallet library is designed to allow other developers to easily implement IOTA wallets within their applications. Another new Rust library utilized by Firefly is Stronghold; Stronghold enables ultra-secure secret handling and storage. - -### Infrastructure - -Currently, the IOTA Foundation supports two public Networks: Mainnet and Devnet (Devnet is for PoCs and application tests). Both networks provide public endpoints for users and partners. You can discover the networks on our Explorer [https://explorer.iota.org](https://explorer.iota.org/mainnet). - -### Chrysalis Devnet - -Nodes deployed to the devnet can be queried using a load balancer at: - -- [https://api.lb-0.h.chrysalis-devnet.iota.cafe/](https://api.lb-0.h.chrysalis-devnet.iota.cafe/) -- [https://api.lb-1.h.chrysalis-devnet.iota.cafe/](https://api.lb-1.h.chrysalis-devnet.iota.cafe/) - -We recommend using the load balancer for most scenarios. - -Single node endpoints that expose native MQTT in case you need this are: - -- `mqtt.lb-0.h.chrysalis-devnet.iota.cafe:1883` -- `mqtt.lb-1.h.chrysalis-devnet.iota.cafe:1883` - -## Conclusion - -Chrysalis was the most promising series of upgrades made to IOTA yet. It was a major step for our production-readiness, with increased transaction _throughput_, network stability, improved usability, and enabled new features and use cases. The upcoming weeks and months are some of the most exciting in IOTA’s history. With the release of Chrysalis, we are on a clear path towards IOTA’s adoption as an enabling technology for IoT and beyond. diff --git a/docs/build/introduction-docs/chrysalis/docs/explanations/update/what_is_chrysalis.md b/docs/build/introduction-docs/chrysalis/docs/explanations/update/what_is_chrysalis.md deleted file mode 100644 index b1629926cb3..00000000000 --- a/docs/build/introduction-docs/chrysalis/docs/explanations/update/what_is_chrysalis.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -keywords: - - Coordicide - - Upgrades - - Mainnet - - Protocol Improvements - - explanation -description: Specific Chrysalis Upgrades from IOTA 1.0. -image: /img/logo/Chrysalis_logo_dark.png ---- - -# What is Chrysalis? - -The objective of the IOTA Foundation was to optimize the IOTA _mainnet_ before the release of IOTA 2.0 (Coordicide) to offer an enterprise-ready solution for our ecosystem. This was achieved by an intermediate update called `Chrysalis`. You can read more about how Chrysalis was strategically released here. - -![IOTA1.0 vs Chrysalis(IOTA1.5) confirmation time](/img/introduction/what_is_chrysalis/00.gif) - -A chrysalis is “the form a caterpillar takes before it emerges from its cocoon as a fully-formed moth or butterfly”. For IOTA, Chrysalis was the mainnet’s intermediate stage before Coordicide's completion. The purpose of Chrysalis is to improve the usability of the previous IOTA mainnet, for developers. - -![From cocoon to butterfly](/img/introduction/02_path_to.png) - -Why is this process of adopting major protocol improvements relatively unique to IOTA among permissionless Digital Ledger Technologies (_DLT_s)? The simple answer is the absence of miners. In most permissionless DLTs, the miners’ economic incentives differ from those of regular network users. Changes to _throughput_ and network latencies can disrupt the fee market the miners rely on. This makes them more likely to object to network upgrades as it affects their bottom line. - -In IOTA, you and validators are one and the same. There is no conflict of interests between either with different motivations, meaning there is a much smoother path to network improvements. This is why we are able to incrementally and smoothly upgrade the network before Coordicide. diff --git a/docs/build/introduction-docs/chrysalis/docs/getting_started/.keep b/docs/build/introduction-docs/chrysalis/docs/getting_started/.keep deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/build/introduction-docs/chrysalis/docs/how_tos/backup_security.md b/docs/build/introduction-docs/chrysalis/docs/how_tos/backup_security.md deleted file mode 100644 index b89854b932e..00000000000 --- a/docs/build/introduction-docs/chrysalis/docs/how_tos/backup_security.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -description: How to back up your account, restore an account from a backup, export a user's Stronghold, and rekey Stronghold. -image: /img/logo/Chrysalis_logo_dark.png -keywords: - - stronghold - - checklist - - backup - - DMZ - - account - - restore - - export - - rekey - - how to ---- - -# Backup and Security - -## Security Checklist - -- I use Stronghold. -- I use a strong password (32 character length, Shannon Entropy ~ 4.0) for encrypting the stronghold. -- I rotate the stronghold password on a regular basis. -- I create a daily backup of the stronghold.snapshot file. -- I keep a secure history of passwords used for recovery. -- I use a secure password management service that integrates with the server. -- I use a linux based server (best memory security). -- I have isolated my server behind a DMZ. -- Don't use SQLite. -- Don't store passwords and backups on the same device. - -## How to Backup Your Account - -You can use a copy of the `stronghold.snapshot` file as a backup. You can implement a [_cronjob_](https://linux.die.net/man/1/crontab), [_rsync_](https://linux.die.net/man/1/rsync) or [_scp_](https://linux.die.net/man/1/scp) with a date-time suffix to periodically back up your account. - -## How to Restore From a Backup - -Place a snapshot file in the directory that wallet.rs expects. - -## How to Export a User's Stronghold - -You can create a new Stronghold snapshot on the fly to allow a user to leave your service and retain their key. - -## How to Rekey a Stronghold/Password Rotation - -To change a Stronghold password, you read a snapshot into a vault and then write it out with a new encryption password. You can view this [code](https://github.com/iotaledger/wallet.rs/blob/d1b8893d73aae35dfcf7c5c8006e2177988d25d0/src/stronghold.rs#L436-L451) for the source. - -:::note - -Old snapshot backups will not be "rekeyed", so you have to track your old passwords. - -::: diff --git a/docs/build/introduction-docs/chrysalis/docs/how_tos/exchange.md b/docs/build/introduction-docs/chrysalis/docs/how_tos/exchange.md deleted file mode 100644 index fe4d11d6a49..00000000000 --- a/docs/build/introduction-docs/chrysalis/docs/how_tos/exchange.md +++ /dev/null @@ -1,300 +0,0 @@ ---- -description: Easily integrate IOTA with your exchange, custody solution, or product using the wallet.rs library. -image: /img/logo/Chrysalis_logo_dark.png -keywords: - - integrate - - exchange - - account model - - addresses - - wallet.rs - - setup - - NodeJS - - how to ---- - -# Exchange Guide - -## The IOTA Wallet Library - -:::note - -You can easily integrate IOTA with your exchange, custody solution, or product. - -::: - -IOTA is built on an architecture that was designed to be the backbone of the Internet of Things (IoT) environment of the future. But this architecture has made it more challenging for service providers like exchanges to integrate IOTA compared to traditional blockchain-based distributed ledgers. - -Within the Chrysalis update (also known as IOTA 1.5), some building blocks were changed to be more approachable and more aligned with currently leveraged standards. We also ship many [client libraries](../explanations/libraries.md) to help developers implement IOTA into their applications: - -![Wallet.rs layer overview](/img/guides/wallet_rs_layers.svg) - -## How Do I Implement It to My Exchange? - -In [wallet.rs](/wallet.rs/welcome), we use an account model so you can create an account for each of your users. Another approach would be to use one account and generate multiple addresses, which you can then link to the users in your database. The wallet library is designed to be as flexible as possible to back up any of your use cases. - -Since IOTA addresses in the Chrysalis network are perfectly reusable, they can be mapped to your users in a clear and concise way: - -- Create an account for every user -> `Multi Account` approach. -- Create one account with many addresses -> `Single account` approach. - -The library supports derivation for multiple accounts from a single seed. An account is simply a deterministic identifier from which multiple addresses can be further derived. - -The library also allows consumers to assign a meaningful alias to each account. In addition to this, generated individual accounts can also be searched via generated addresses. This means it does not matter whether aliases or addresses are known as the search for the related account is very straightforward using the `wallet.rs` library. - -It also leaves the choice to users if they want to segregate their funds across multiple accounts or multiple addresses. The following illustration outlines the relationships between seed, accounts, and addresses: - -![Relationship between seed, accounts, and addresses](/img/guides/accounts.svg) - -### Multi-Account Approach - -The multi-account approach is used to create an account for each individual user. The created accounts can then be linked to the internal user IDs as an account alias, which are distinctly separated. - -### Single Account Approach - -The single account approach allows for just one account and creates addresses for each user. The associated addresses are then linked to the internal user IDs and store who owns which address in the database. Most exchanges are more familiar with the single account approach and find it easier to use, implement, and backup. - -## Implementation Guide - -This guide explains how to use the IOTA Wallet Library to successfully implement IOTA into an exchange. If you have already implemented the IOTA Hub, please visit the [Hub Migration Guide](migration/hub_migration.md). - -Features of the Wallet Library: - -- Secure seed management. -- Account management (with multiple accounts and multiple addresses). -- Confirmation monitoring. -- Deposit address monitoring. -- Backup and restore functionality. - -## How Does it Work? - -The Wallet Library is a stateful package with a standardized interface for developers to build applications involving IOTA _value transactions_. It offers abstractions to handle IOTA payments and can optionally interact with the IOTA Stronghold for seed handling, seed storage, and state backup. You can also use an SQLite database instead of Stronghold but it is not as secure. - -For further reference, you can read our [wallet documentation here](/wallet.rs/welcome). - -The following examples cover the _multi-account approach_ using the `NodeJS` binding: - -1. Set up the Wallet Library. -2. Create an account for each user. -3. Generate a user address for deposits. -4. Listen to events. -5. Check the user balance. -6. Enable withdrawals. - -Since all `wallet.rs` bindings are based on core principles provided by the `wallet.rs` library, the outlined approach is very similar regardless of the programming language of your choice. - -### 1. Set up the Wallet Library - -First, you should install the components that are needed to use `wallet.rs` and the binding of your choice; it may vary a bit from language to language. In the case of the `NodeJs` binding, it is straightforward since it is distributed via the `npm` package manager. We also recommend you use `dotenv` for password management. - -You can read more about [backup and security in this guide](./backup_security.md). - -```bash -npm install @iota/wallet dotenv -touch .env -``` - -Then, input your password to the `.env` file like this: - -```bash -SH_PASSWORD="here is your super secure password" -``` - -Once you have everything needed to use the `wallet.rs` library, it is necessary to initialize the `AccountManager` instance which creates (opens) a secure storage for individual accounts (backed up by `Stronghold` by default). - -The storage is encrypted at rest, so you need a strong password and location where to put your storage. - -:::note - -Manage your password with the utmost care. - -::: - -Technically speaking, "storage" means a single file called `wallet.stronghold`. It is also needed to generate a seed (mnemonic) that serves as a cryptographic key from which all accounts and related addresses are generated. - -One of the key principles behind the `stronghold`-based storage is that no one can get a seed from the storage. You deal with all the accounts purely via the `Account_Manager` instance where all complexities are hidden under the hood and are dealt with securely. In case you would also like to store a seed somewhere else, there is another method, `AccountManager.generateMnemonic()`, that generates random seeds. This method can be leveraged before the actual account initialization. - -:::note - -Keep the `stronghold` password and the `stronghold` database on separate devices. See the [backup and security guide](./backup_security.md) for more information. - -::: - -Import the Wallet Library and create an account manager: - -```javascript -const { AccountManager, SignerType } = require('@iota/wallet'); - -// Setup IOTA Wallet Library -const manager = new AccountManager({ - storagePath: './storage', -}); -manager.setStrongholdPassword(process.env.SH_PASSWORD); -const mnemonic = manager.generateMnemonic(); // seed generation -// Store your mnemonic in a secure location, it's the only backup option apart from the Stronghold file -console.log('Save this securely: ' + mnemonic); -manager.storeMnemonic(SignerType.Stronghold, mnemonic); -``` - -Once the stronghold storage is created, it is not needed to generate the seed any longer (`manager.storeMnemonic(SignerType.Stronghold, manager.generateMnemonic())`). It has already been saved in the storage together with all account information. - -### 2. Create an Account For a User - -Once the backend storage is created, individual accounts for individual users can be created: - -```javascript -let account = await manager.createAccount({ - alias: user_id, // an unique id from your existing user - clientOptions: { - node: 'https://api.lb-0.h.chrysalis-devnet.iota.cafe/', - localPow: false, - }, -}); -``` - -Each account is related to a specific IOTA network (mainnet/devnet) which is referenced by a node property, such as node url (in this example, the Chrysalis devnet balancer). - -For more information about `clientOptions`, please refer to the [Wallet NodeJs API Reference](/wallet.rs/reference/nodejs). - -The `Alias` can be whatever fits to the given use case and should be unique. The `Alias` is typically used to identify the given account later on. Each account is also represented by an `index` which is incremented (by 1) every time a new account is created. Any account can then be referred to via `index`, `alias`, or one of its generated `addresses`. - -Once an account has been created, you get an instance of it using the following methods: `AccountManager.getAccount(accountId)`, `AccountManager.getAccountByAlias(alias)` or `AccountManager.getAccounts()`. - -The most common methods of `account` instance include: - -- `account.alias()` - returns an alias of the given account. -- `account.listAddresses()` - returns list of addresses related to the account. -- `account.getUnusedAddress()` - returns a first unused address. -- `account.generateAddress()` - generate a new address for the address index incremented by 1. -- `account.balance()` - returns the balance for the given account. -- `account.sync()` - sync the account information with the tangle. - -### 3. Generate a User Address to Deposit Funds - -`Wallet.rs` is a stateful library which means it caches all relevant information in storage to provide performance benefits while dealing with, potentially, many accounts/addresses. - -:::tip - -Sync the account info with the network during the wallet manipulation to be sure the storage reflects an actual state of the ledger (network). - -::: - -Every account can own multiple addresses. Addresses are represented by an `index` which is incremented (by 1) every time a new address is created. The latest address is accessible via `account.latestAddress()`: - -```javascript -// Always sync before account interactions -console.log('syncing...'); -const synced = await account.sync(); -console.log('synced!'); - -// By design, the last address of each account is an unused address which can be used as deposit address -const latestAddress = account.latestAddress(); - -console.log('Need a refill? Send it to this address:', latestAddress); -``` - -You can fill the address with Devnet Tokens with the [IOTA Faucet](https://faucet.devnet.chrysalis2.com/) to test it. - -Addresses are of two types, `internal` and `public` (external): - -- Each set of addresses are independent from each other and has an independent `index` id. -- Addresses that are created by `account.generateAddress()` are indicated as `internal=false` (public). -- Internal addresses (`internal=true`) are called `change` addresses and are used to send the excess funds to them. -- The approach is also known as a _BIP32 Hierarchical Deterministic wallet (HD Wallet)_. - -:::note - -You may remember IOTA 1.0 network in which addresses were not reusable. It is no longer true and addresses can be reused multiple times in the Chrysalis network. - -::: - -### 4. Listen to Events - -The `Wallet.rs` library supports several events for listening. As soon as the given event occurs, a provided callback is triggered. - -Below is an example of fetching existing accounts and listening to transaction events coming into the account: - -```javascript -const { addEventListener } = require('@iota/wallet'); - -const callback = function (err, data) { - if (err) console.log('err:', err); - console.log('data:', data); -}; - -//Adds a new event listener with a callback in the form of (err, data) => {}. Supported event names: -addEventListener('BalanceChange', callback); - -// Possible Event Types: -// -// ErrorThrown -// BalanceChange -// NewTransaction -// ConfirmationStateChange -// Reattachment -// Broadcast -``` - -Example output: - -```bash -data: { - accountId: 'wallet-account://1666fc60fc95534090728a345cc5a861301428f68a237bea2b5ba0c844988566', - address: { - address: 'atoi1q9c6r2ek5w2yz54en78m8dxwl4qmwd7gmh9u0krm45p8txxyhtfry6apvwj', - balance: 20000000, - keyIndex: 0, - internal: false, - outputs: [ [Object], [Object] ] - }, - balance: 20000000 -} -``` - -`accountId` can then be used to identify the given account via `AccountManager.getAccount(accountId)`. - -For further reference, you can read more about events in the [API reference](/wallet.rs/reference/nodejs). - -### 5. Check the Account Balance - -Get the available account balance across all addresses of the given account: - -```javascript -// Always sync before account interactions -console.log('syncing...'); -const synced = await account.sync(); -console.log('synced!'); -let balance = account.balance().available; -console.log('available balance', balance); -``` - -### 6. Enable Withdrawals - -Sending tokens is performed via the `SyncedAccount` instance that is a result of the `account.sync()` function: - -```javascript -console.log('syncing...'); -const synced = await account.sync(); -console.log('available balance', account.balance().available); - -const address = - 'atoi1qzt0nhsf38nh6rs4p6zs5knqp6psgha9wsv74uajqgjmwc75ugupx3y7x0r'; -const amount = 1000000; // Amount in IOTA: 1000000 == 1 MIOTA - -const node_response = await account.send(address, amount); - -console.log( - 'Check your message on https://explorer.iota.org/chrysalis/message/', - node_response.id, -); -``` - -The full function signature is `Account.send(address, amount[, options])`. - -Default options are fine and are successful; however, additional options can be provided, such as `remainderValueStrategy`: - -- `changeAddress`: Send the remainder value to an internal address. -- `reuseAddress`: Send the remainder value back to its original address. - -The `Account.send()` function returns a `wallet message` that fully describes the given transaction. The `messageId` can be used later for checking a confirmation status. Individual messages related to the given account can be obtained via the `account.listMessages()` function. - -Please note that when sending tokens, a [dust protection](../reference/details.md#dust-protection) mechanism should be considered. diff --git a/docs/build/introduction-docs/chrysalis/docs/how_tos/migration/hub_migration.md b/docs/build/introduction-docs/chrysalis/docs/how_tos/migration/hub_migration.md deleted file mode 100644 index e99a9be48e7..00000000000 --- a/docs/build/introduction-docs/chrysalis/docs/how_tos/migration/hub_migration.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -description: How to switch from IOTA hub using wallet.rs, or its bindings. -image: /img/logo/Chrysalis_logo_dark.png -keywords: - - wallet.rs - - IOTA Hub - - iota.rs - - migration - - how to ---- - -# IOTA Hub Migration Guide - -:::info - -This guide outlines how to switch from using IOTA Hub to [Wallet.rs](/wallet.rs/welcome) or its bindings instead. - -::: - -:::warning -Before you start a migration from IOTA Hub, get in contact with us so we can assist you in this process. - -**Contact details:** - -Dave de Fijter - -**Email**: [dave.defijter@iota.org](mailto:dave.defijter@iota.org) - -[**Discord**](https://discord.iota.org/): Dave [IF]#3333 -::: - -Because of the unique features of IOTA 1.0, it was difficult to manage IOTA transactions with just a library. With the Chrysalis update, we have updated to be more accommodating to industry-wide standards and developers. - -IOTA Hub was deprecated with the Chrysalis upgrade and will not work with the new protocol changes. If you somehow still use Hub, we recommend that you to switch our new wallet library [Iota.rs](/iota.rs/welcome), or its bindings, where you can easily manage IOTA addresses, deposits, and withdrawals for user accounts. - -To upgrade from Hub to a Chrysalis implementation you will need to: - -- Integrate the Chrysalis network using [Wallet.rs](/wallet.rs/welcome) as mentioned in the [Exchange section](../exchange.md). -- Pause withdrawals/deposits. -- Make sure all balances have been swept and all deposits have been processed. -- [Transfer all IOTA to a generated migration address](token_migration.md). -- Once migrated, transfer the IOTA coins to your host wallet account on your wallet.rs implementation. diff --git a/docs/build/introduction-docs/chrysalis/docs/how_tos/migration/snapshot_validation_bootstrapping.md b/docs/build/introduction-docs/chrysalis/docs/how_tos/migration/snapshot_validation_bootstrapping.md deleted file mode 100644 index 837ddb51d1b..00000000000 --- a/docs/build/introduction-docs/chrysalis/docs/how_tos/migration/snapshot_validation_bootstrapping.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -description: This page described to take part in the global snapshot. -image: /img/logo/Chrysalis_logo_dark.png -keywords: - - golang - - github - - bootstrapping - - snapshot - - verify - - validate - - hornet - - tools - - how to ---- - -# Chrysalis Snapshot Validation/Boostrapping - -This guide outlined how to take part in the global snapshot, respectively genesis snapshot creation for the -legacy, and the Chrysalis Phase 2 IOTA network. The goal was to generate a global snapshot for the legacy network which acted -as a cut-off point for when only migration bundles/transactions were allowed. Then a genesis snapshot for the new network -which contained the already burned/migrated funds from the 7-day-migration window would be created. - -## Requirements - -- A GitHub account and git. -- A synchronized legacy Hornet node (running version < 0.x.x). - - The `getLedgerState` API command must be permitted. Add an entry to `httpAPI.permitRemoteAccess` in case this API - command is not added yet (restart your node afterwards). - - The API port must be accessible. -- Golang version 1.16.x (https://golang.org/). - -## Steps - -:::note - -Make sure you have Go installed by issuing `go version` on your command line. - -::: - -1. `git clone https://github.com/iotaledger/chrysalis-tools.git`. -2. `cd chrysalis-tools/snapshot/verify`. -3. `go build` (this should generate a `verify`/`verify.exe` binary respectively). -4. `./verify -node="https://your-node-uri" -genesis-snapshot-file-network-id="chrysalis-mainnet" -genesis-snapshot-file-network-id-alt="as-network"`. -5. The program would fetch the then current ledger state of your defined legacy Hornet node, compute its Blake2b-256 hash - and generate the global snapshot for the legacy and genesis snapshot for the new network. Example output: - -``` -2021/04/28 12:05:22 querying legacy node for info... -2021/04/28 12:05:22 legacy node state: lsmi/lsm 3705194/3705194 -2021/04/28 12:05:22 fetching ledger state at 3705194, this might take a while...go grab a coffee... -2021/04/28 12:05:27 total ledger entries: 340692 -2021/04/28 12:05:29 legacy ledger state integrity hash: 8900ac80edffe4eed9f6f55dfe32d775c18d789351c7dddfa4a4c815a0fa7116 -2021/04/28 12:05:29 migration: addrs count 7949, tokens total 661557732260355 -2021/04/28 12:05:29 migration (alternative): addrs count 7950, tokens total 724118708261378 -2021/04/28 12:05:29 generating genesis snapshot files... -2021/04/28 12:05:29 treasury allocation with genesis_snapshot.bin: 2117972551017406 tokens -2021/04/28 12:05:29 treasury allocation with genesis_snapshot_alt.bin: 2055411575016383 tokens -2021/04/28 12:05:29 misc info: -2021/04/28 12:05:29 eligible for migration: addrs 225329, tokens total 2055405216227457 -``` - -6. Generate the sha256 hashes of the generated snapshot. - files: `sha256sum genesis_snapshot.bin genesis_snapshot_alt.bin global_snapshot.csv`; Example output: - -``` -$ sha256sum genesis_snapshot.bin genesis_snapshot_alt.bin global_snapshot.csv -65be1a80a6895d17a492db3dd55babf1d57557dbaa40da6e1d0ed5937ceb6662 genesis_snapshot.bin -39bd5308a1e9fb57503f6d15b90206ae434f581807ef0e29cf2e66de64165c5b genesis_snapshot_alt.bin -8f48388423cc706bf5f7707735fd99a5d89efbb966a8e2a0b82ff3529cf33f7f global_snapshot.csv -``` - -8. Copy the entire program output, and the sha256 hashes to the [corresponding issue](https://github.com/iotaledger/hornet/issues/16) on - the `iotaledger` Hornet fork repository. - -## Bootstrapping the Legacy Hornet Node From The Global Snapshot - -:::note - -Loading the global snapshot ensured that your legacy Hornet node added the _genesis transaction_ (999...) as a solid entry point: this was important as the Coordinator would issue the next milestone after the global snapshot index on top of it. Your node would **not** lose the data it already had. - -::: - -1. Await for confirmation that the global snapshot was taken successfully by looking into the validation issue on - the [Hornet repository](https://github.com/gohornet/hornet) or Discord. -2. Stop your legacy Hornet node and download the binary or docker image of the Hornet build which only supports - migration-bundles. With this "migration-bundles-only" version, your Hornet node will also no longer peer to nodes - which do not run the same version. -3. Let `snapshots.global.path` point to the global snapshot file (i.e `global_snapshot.csv`). -4. Under `snapshots.global.index` define the index of the milestone at which the global snapshot was taken. (This should - correspond to what `legacy node state` was from the program output, i.e. `3705194` from the example output above). -5. Change `snapshots.loadType` to `"global"` (note the quotes as the value is a string). -6. Restart your legacy Hornet **with the additional `--forceGlobalSnapshot` flag** (this will instruct your Hornet node - to load the global snapshot despite the fact that it already has a database). diff --git a/docs/build/introduction-docs/chrysalis/docs/how_tos/migration/token_migration.md b/docs/build/introduction-docs/chrysalis/docs/how_tos/migration/token_migration.md deleted file mode 100644 index 6a5e5d10195..00000000000 --- a/docs/build/introduction-docs/chrysalis/docs/how_tos/migration/token_migration.md +++ /dev/null @@ -1,402 +0,0 @@ ---- -description: Overview on how you migrated tokens from the IOTA 1.0 to IOTA 1.5 Chrysalis network using the Firefly wallet or a migration bundle. -image: /img/logo/Chrysalis_logo_dark.png -keywords: - - migration - - migration bundle - - Firefly - - Chrysalis Phase 2 - - how to ---- - -# Chrysalis Migration - -By the end of the Chrysalis migration, several aspects at IOTA changed for the better. With easier ways to -manage and secure your experience, IOTA seamlessly integrated these innovations with no service interruptions. - -With Chrysalis, we made a clear-cut from the current IOTA protocol, and started a new with a much better, and more mature -network. The network supports many new use cases and created a foundation for IOTA’s upcoming Coordicide. - -This included one of the innovations that directly impacted one of the most crucial aspects of your experience: funds. - -## Token Migration Overview - -Below is an overview of how the migration is taking place for normal token holders: - -1. You enter your seed in _Firefly_. -2. Firefly creates a new seed for you and generates an EdDSA address for the new network. -3. Firefly sends your funds to a specific migration address (which encapsulates your EdDSA address) on the old network. -4. Your funds become available on the new network on the EdDSA address Firefly created for you. -5. Your funds are successfully migrated. - -:::note - -If you migrate after the Chrysalis launch, your funds will become available shortly after you migrate (within less than 5 minutes). - -::: - -:::note - -Firefly will initially only be available on desktop operating systems such as: macOS, Linux, or Windows and will not support migrations for Ledger devices or using a Ledger device. - -::: - -For further information on the migration process, see our [blog post](https://blog.iota.org/firefly-token-migration/). - -For a detailed explanation on how the migration process works technically, see the [migration-mechanism](../../explanations/update/migration_mechanism.md) page. - -## Exchange Token Migration Guide - -To help you successfully transfer your tokens securely to the Chrysalis network, we created this guide as -an overview of the migration process and its intricacies. - -:::info - -On the 28th of April 2021, Chrysalis Phase 2 was released (with its corresponding node software, libraries, and tooling). -After this, the legacy network only supports migration transfers moving further (this is accompanied by a legacy -node release). This means that both a legacy (albeit only for migrations), and a new Chrysalis Phase 2 network -co-exist. - -::: - -There are two ways with which you can migrate your funds from the old legacy to the Chrysalis Phase 2 network: - -1. You can either use our Firefly wallet (which allows migrating from either an 81-tryte seed or seed vault file) - (check out this [blog post](https://blog.iota.org/firefly-token-migration/) on how to do this). -2. Or you can craft a migration bundle yourself which transfers your funds to a special migration address under your - control (programmatic approach). - -This guide will further explain how to create a migration bundle and the rules imposed on it. - -### Migrating Funds by Issuing Migration Bundles - -As mentioned above, there was a special release for the legacy node software on the 28/4/2021, which -will only further support migration bundles. In case you are operating a node yourself you must upgrade to that version, -as otherwise you will no longer be synchronized with the network. - -#### Migration bundle - -With this limited legacy network, only migration bundles will be confirmed moving forward. A migration bundle is simply a -normal value bundle/transfer which has some additional restrictions. If you craft a bundle which obeys the following -rules, then it falls under what we define as a migration bundle: - -- It contains exactly one output transaction of which the destination address is a valid migration address and is - positioned as the tail transaction within the bundle (meaning `currentIndex` 0). **The output transaction value is at - least 1'000'000 tokens (1 Mi).** -- It does not contain any zero-_value transactions_ which do not hold signature fragments. This means that transactions - other than the tail transaction must always be part of an input. -- Input transactions must not use migration addresses. - -If you are in doubt whether your bundle is an actual migration bundle, you can use the [ValidBundle(bundle, true)](https://github.com/iotaledger/iota.go/blob/2618d56d58105dfc2f3b7f1eb3481d9f89a1d6bc/bundle/bundle.go#L335) function of our iota.go library to validate this. If you are not acquainted with Go, you can also contact us on -Discord or Slack to ensure that your crafted bundles are valid migration bundles. - -Here are a few things to consider: - -- You must not broadcast your own migration bundles unless you are 100% sure that they are valid migration - bundles. -- If one of your input transactions spends funds from an already used address (meaning it is subject to key re-use), we - recommend that you use the [bundle miner tool](https://github.com/iotaledger/iota.rs/tree/migration-new/iota-bundle-miner) to craft a bundle with the most applicable security given the already exposed parts of the given address' private key. -- Do not use too many input transactions as this will increase the overall Proof-of-Work time needed for a single bundle. Rather, split your input addresses over multiple migration bundles. -- Your code must include logic to await for the migration bundle's confirmation. If you find that your migration bundle - is not confirming, consider re-attaching it (re-attaching is **not** the same as re-signing the bundle). -- If you submit a migration bundle for broadcasting via the `broadcastTransactions` API command and you are using the - updated legacy node software, then it will additionally check up on the submission whether your submitted bundle really adheres to the rules outlined above as an additional safeguard. - -For further information about the migration bundles, see the [RFC-0035](https://github.com/luca-moser/protocol-rfcs/blob/rfc/wotsicide/text/0035-wotsicide/0035-wotsicide.md#migration-bundle) page. - -As an example, [this bundle](https://explorer.iota.org/mainnet/bundle/ZRAFFSEPRKDYGGA9DJQBWCXG9CGODUNZUBOWHVFQY9DK9HCHJQTHHSYBQRGZHGXWAPXDTJPPFJ9XFUALW) is a valid migration bundle. It spends 1 Mi - -- from: - `YVLQWMRUZ9RCQODQZFYDNRVXHERUFPSDVLDRQLHEWGJLRTMEAQNX9OHZJVTONDHMUJQECDCUAR9PUIGAZPAAEHTZXB` -- to: - `TRANSFERTBIXPEWWYZZWBWPWJCB9XYMC9AGYH9X9AYAYADVXTYGYB9G9J9PEF9O9KYZXS9D9MANWTZOD9B9HMRQFWZ` where the destination address encodes the target Bech32 address `iota1qqhmslysuwfedz2mqtr4ux73pr7uhjmd4tpazqs8pf7qdax44muqgw0fz25` respectively the hex Ed25519 address `2fb87c90e39396895b02c75e1bd108fdcbcb6daac3d102070a7c06f4d5aef804` on which the these funds will be made available in the new network. - -##### Migration address - -As mentioned above, a migration bundle must have as its single destination/output address a migration address. A -migration address is, in essence, an EdDSA address (to which you hold the keys on the new network) encoded in a legacy -tryte address. You can create such an address in the following way: - -- Compute the [BLAKE2b-256](https://tools.ietf.org/html/rfc7693) hash `H` of your Ed25519 address `A` (this address is the one you control in the new network; note that an Ed25519 address is the Blake2b-256 hash of your Ed25519 public key). -- Append the first 4 bytes of `H` to `A`, resulting in 36 bytes. -- Convert `A` to trytes using the `b1t6` encoding (as described - in [RFC-15](https://github.com/iotaledger/protocol-rfcs/blob/master/text/0015-binary-to-ternary-encoding/0015-binary-to-ternary-encoding.md)). This results in `A`tri consisting of 72 trytes. -- Prepend the 8-tryte prefix `TRANSFER` to `A`tri. -- Finally, pad `A`tri with the single tryte `9` to get a legacy 81-tryte address. - -Example: - -- Ed25519 address (32-byte): `6f9e8510b88b0ea4fbc684df90ba310540370a0403067b22cef4971fec3e8bb8` -- Migration address including 9-tryte checksum ( - 90-tryte): `TRANSFERCDJWLVPAIXRWNAPXV9WYKVUZWWKXVBE9JBABJ9D9C9F9OEGADYO9CWDAGZHBRWIXLXG9MAJV9RJEOLXSJW` - -Since nobody holds keys to such migration addresses, funds are effectively burned and can no longer be used in the legacy network. - -#### Migration Code Example with Node.js - -[Click to see more detailed documentation for the following example](https://github.com/iotaledger/wallet.rs/blob/dev/bindings/nodejs/examples/8-migration.md). - -```js -/** - * This example creates a new database and account, - * and migrate funds from the legacy network to the chrysalis network - */ - -require('dotenv').config(); - -const ADDRESS_SECURITY_LEVEL = 2; -// Minimum balance that is required for a migration bundle, because of the dust protection in the new network -const MINIMUM_MIGRATION_BALANCE = 1000000; -// This value should not be too high, because then the PoW could take too long to get it confirmed -const MAX_INPUTS_PER_BUNDLE = 10; - -async function run() { - try { - const { - AccountManager, - SignerType, - addEventListener, - } = require('@iota/wallet'); - - // We store all bundle hashes here and check later if the bundles got confirmed - let migrationBundleHashes = []; - // Log migration events - const callback = function (err, data) { - // After a successful broadcast of this bundle, the library will automatically reattach bundle to - // speed up the confirmation process. An event with type "TransactionConfirmed" (with corresponding bundle hash) - // will be emitted as soon as the bundle is confirmed. - if (data.event.type === 'TransactionConfirmed') { - console.log('MigrationProgress:', data); - migrationBundleHashes = migrationBundleHashes.filter( - (hash) => hash !== data.event.data.bundleHash, - ); - if (migrationBundleHashes.length == 0) { - process.exit(); - } - console.log('Still unconfirmed bundles: ', migrationBundleHashes); - } - }; - addEventListener('MigrationProgress', callback); - - const manager = new AccountManager({ - storagePath: './migration-database', - }); - manager.setStrongholdPassword(process.env.SH_PASSWORD); - // Save this mnemonic securely. If you lose it, you potentially lose everything. - const mnemonic = manager.generateMnemonic(); - console.log( - 'Save this mnemonic securely. If you lose it, you potentially lose everything:', - mnemonic, - ); - manager.storeMnemonic(SignerType.Stronghold, mnemonic); - - const account = await manager.createAccount({ - // Node url for the new network - clientOptions: { - node: 'https://chrysalis-nodes.iota.cafe', - localPow: true, - network: 'chrysalis-mainnet', - }, - alias: 'Migration', - }); - - console.log('Account created:', account.alias()); - // Nodes for the legacy network - const nodes = ['https://nodes.iota.org']; - const seed = process.env.MIGRATION_SEED; - const migrationData = await manager.getMigrationData(nodes, seed, { - // permanode for the legacy network - permanode: 'https://chronicle.iota.org/api', - securityLevel: ADDRESS_SECURITY_LEVEL, - // this is the default and from there it will check addresses for balance until 30 in a row have 0 balance - // if not all balance got detected because a higher address index was used it needs to be increased here - initialAddressIndex: 0, - }); - console.log(migrationData); - - let input_batches = getMigrationBundles(migrationData.inputs); - // create bundles with the inputs - for (batch of input_batches) { - try { - const bundle = await manager.createMigrationBundle( - seed, - batch.inputs.map((input) => input.index), - { - logFileName: 'iota-migration.log', - // if the input is a spent address we do a bundle mining process which takes 10 minutes to reduce the amount - // of the parts of the private key which get revealed - mine: batch.inputs[0].spent, - }, - ); - migrationBundleHashes.push(bundle.bundleHash); - } catch (e) { - console.error(e); - } - } - - // Send all bundles to the Tangle and reattach them until they are confirmed - for (bundleHash of migrationBundleHashes) { - try { - await manager.sendMigrationBundle(nodes, bundleHash); - } catch (e) { - console.error(e); - } - } - } catch (e) { - console.error(e); - } -} - -run(); - -const getMigrationBundles = (inputs) => { - // Categorise spent vs unspent inputs - const { spent, unspent } = inputs.reduce( - (acc, input) => { - if (input.spent) { - acc.spent.push(input); - } else { - acc.unspent.push(input); - } - return acc; - }, - { spent: [], unspent: [] }, - ); - const unspentInputChunks = selectInputsForUnspentAddresses(unspent); - const spentInputs = spent.filter( - (input) => input.balance >= MINIMUM_MIGRATION_BALANCE, - ); - return [ - ...spentInputs.map((input) => ({ - // Make sure for spent addresses, we only have one input per bundle - inputs: [input], - })), - ...unspentInputChunks.map((inputs) => ({ inputs })), - ]; -}; -/** - * Prepares inputs (as bundles) for unspent addresses. - * Steps: - * - Categorises inputs in two groups 1) inputs with balance >= MINIMUM_MIGRATION_BALANCE 2) inputs with balance < MINIMUM_MIGRATION_BALANCE - * - Creates chunks of category 1 input addresses such that length of each chunk should not exceed MAX_INPUTS_PER_BUNDLE - * - For category 2: - * - Sort the inputs in descending order based on balance; - * - Pick first N inputs (where N = MAX_INPUTS_PER_BUNDLE) and see if their accumulative balance >= MINIMUM_MIGRATION_BALANCE - * - If yes, then repeat the process for next N inputs. Otherwise, iterate on the remaining inputs and add it to a chunk that has space for more inputs - * - If there is no chunk with space left, then ignore these funds. NOTE THAT THESE FUNDS WILL ESSENTIALLY BE LOST! - * - * NOTE: If the total sum of provided inputs are less than MINIMUM_MIGRATION_BALANCE, then this method will just return and empty array as those funds cannot be migrated. - * - * This method gives precedence to max inputs over funds. It ensures a maximum a bundle could have is 30 inputs and their accumulative balance >= MINIMUM_MIGRATION_BALANCE - * - * @method selectInputsForUnspentAddresses - * - * @params {Input[]} inputs - * - * @returns {Input[][]} - */ -const selectInputsForUnspentAddresses = (inputs) => { - const totalInputsBalance = inputs.reduce( - (acc, input) => acc + input.balance, - 0, - ); - - // If the total sum of unspent addresses is less than MINIMUM MIGRATION BALANCE, just return an empty array as these funds cannot be migrated - if (totalInputsBalance < MINIMUM_MIGRATION_BALANCE) { - return []; - } - - const { inputsWithEnoughBalance, inputsWithLowBalance } = inputs.reduce( - (acc, input) => { - if (input.balance >= MINIMUM_MIGRATION_BALANCE) { - acc.inputsWithEnoughBalance.push(input); - } else { - acc.inputsWithLowBalance.push(input); - } - - return acc; - }, - { inputsWithEnoughBalance: [], inputsWithLowBalance: [] }, - ); - - let chunks = inputsWithEnoughBalance.reduce((acc, input, index) => { - const chunkIndex = Math.floor(index / MAX_INPUTS_PER_BUNDLE); - - if (!acc[chunkIndex]) { - acc[chunkIndex] = []; // start a new chunk - } - - acc[chunkIndex].push(input); - - return acc; - }, []); - - const fill = (_inputs) => { - _inputs.every((input) => { - const chunkIndexWithSpaceForInput = chunks.findIndex( - (chunk) => chunk.length < MAX_INPUTS_PER_BUNDLE, - ); - - if (chunkIndexWithSpaceForInput > -1) { - chunks = chunks.map((chunk, idx) => { - if (idx === chunkIndexWithSpaceForInput) { - return [...chunk, input]; - } - - return chunk; - }); - - return true; - } - - // If there is no space, then exit - return false; - }); - }; - - const totalBalanceOnInputsWithLowBalance = inputsWithLowBalance.reduce( - (acc, input) => acc + input.balance, - 0, - ); - - // If all the remaining input addresses have accumulative balance less than the minimum migration balance, - // Then sort the inputs in descending order and try to pair the - if (totalBalanceOnInputsWithLowBalance < MINIMUM_MIGRATION_BALANCE) { - const sorted = inputsWithLowBalance - .slice() - .sort((a, b) => b.balance - a.balance); - - fill(sorted); - } else { - let startIndex = 0; - - const sorted = inputsWithLowBalance - .slice() - .sort((a, b) => b.balance - a.balance); - const max = Math.ceil(sorted.length / MAX_INPUTS_PER_BUNDLE); - - while (startIndex < max) { - const inputsSubset = sorted.slice( - startIndex * MAX_INPUTS_PER_BUNDLE, - (startIndex + 1) * MAX_INPUTS_PER_BUNDLE, - ); - const balanceOnInputsSubset = inputsSubset.reduce( - (acc, input) => acc + input.balance, - 0, - ); - - if (balanceOnInputsSubset >= MINIMUM_MIGRATION_BALANCE) { - chunks = [...chunks, inputsSubset]; - } else { - fill(inputsSubset); - } - - startIndex++; - } - } - - return chunks; -}; -``` - -After the migration, only the 24-word mnemonic or the stronghold file gives you access to the funds, so make sure to back them up properly. It is impossible to get access to the funds with the old seed after the migration transaction. Please read our recommendations for [Backup and security](../../how_tos/backup_security.md). diff --git a/docs/build/introduction-docs/chrysalis/docs/how_tos/verify_firefly_download.md b/docs/build/introduction-docs/chrysalis/docs/how_tos/verify_firefly_download.md deleted file mode 100644 index 047803b4e2a..00000000000 --- a/docs/build/introduction-docs/chrysalis/docs/how_tos/verify_firefly_download.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -description: Firefly is IOTA's new official wallet for Chrysalis. You can verify your Firefly download on Windows, maxOS, and/or Linux. -image: /img/logo/Chrysalis_logo_dark.png -keywords: - - Firefly - - DLT - - wallet - - download - - verify - - windows - - macOS - - linux - - how to ---- - -# Firefly - -:::info - -_Firefly_ is IOTA's new official wallet for Chrysalis. - -::: - -**Website**: [https://firefly.iota.org/](https://firefly.iota.org/) - -**Code Repository**: [https://github.com/iotaledger/firefly](https://github.com/iotaledger/firefly) - -## Verify your Firefly Desktop Download - -When you download Firefly Desktop, you should verify its authenticity to make sure that you downloaded the correct one from the IOTA Foundation GitHub repository. In this how-to guide, you learn how to verify various Firefly Desktop downloads. - -You can verify the authenticity of the Firefly Desktop by checking its SHA256 hash and code signature. The instructions for both of these steps differ, depending on your operating system. - -### Windows Operating System - -#### Verify the SHA256 Hash - -1. Open a command-line interface. - -2. Create a SHA256 hash of the Firefly Desktop `.exe` file. Replace the path with the path to your Firefly `.exe` file. - -``` -certUtil -hashfile path\to\firefly-desktop-version.exe SHA256 -``` - -For example, if the file is in the `C:\Users\yourname\Downloads` directory, do the following: - -``` -certUtil -hashfile C:\Users\yourname\Downloads\firefly-desktop-1.0.0.exe SHA256 -``` - -3. Compare your SHA256 hash with the one in the [release notes](https://github.com/iotaledger/firefly/releases) and make sure that they match. - -#### Verify the code signature - -1. Right-click on `firefly-desktop-version.exe`. - -2. Go to **Digital Signatures** > **Details** > **View Certificate**. - -##### For Firefly 1.2.0 and earlier - -1. In the Certification Path tab, make sure that the path matches the following information: - - - DigiCert. - - DigiCert SHA2 Assured Code Signing CA. - - IOTA Stiftung. - -2. Make sure that the Certificate status reads "This certificate is OK.". - -##### For Firefly 1.3.0 and later - -1. In the Certification Path tab, make sure that the path matches the following information: - - - Sectigo (AAA). - - Sectigo Public Code Signing Root R46. - - Sectigo Public Code Signing CA R36. - - IOTA Stiftung. - -2. Make sure that the Certificate status reads, "This certificate is OK.". - -### MacOS Operating System - -#### Verify the SHA256 Hash - -1. Open the Terminal (in `/Applications/Utilities/Terminal`). - -2. Create a SHA256 hash of the Firefly Desktop `.dmg` file. Replace the path with the path to your Firefly `.dmg` file. - -```bash -shasum -a 256 /path/to/firefly-desktop-version.dmg -``` - -For example, if the file is in `~/Downloads`, do the following: - -```bash -shasum -a 256 ~/Downloads/firefly-desktop-1.0.0.dmg -``` - -3. Compare your SHA256 hash with the one in the [release notes](https://github.com/iotaledger/firefly/releases) and make sure that they match. - -#### Verify the code signature - -##### Prerequisites - -To follow these instructions you need the [Xcode Command Line Tools](https://www.ics.uci.edu/~pattis/common/handouts/macmingweclipse/allexperimental/macxcodecommandlinetools.html). - -1. Open the Terminal (in `/Applications/Utilities/Terminal`). - -2. Verify the `Firefly.app` file's signature. Replace the path with the path to your `Firefly.app` file. This command confirms whether the code binaries are actually signed, the signature is valid, all the sealed components are unaltered, and the signature passes some basic consistency checks. - - ```bash - codesign -d -vv /path/to/Firefly.app - ``` - - For example, if the file is in the `/Applications` directory, do the following: - - ```bash - codesign -d -vv /Applications/Firefly.app - ``` - -3. Make sure that the following information matches the output of the command: - - ```bash - Identifier=org.iota.firefly - Authority=Developer ID Application: IOTA Stiftung (UG77RJKZHH) - Authority=Developer ID Certification Authority - Authority=Apple Root CA - ``` - -4. Test the signature against system policies. Replace the path with the path to your `Firefly.app` file. - - ```bash - spctl -a -vv path/to/Firefly.app - ``` - - For example, if the file is in the `/Applications` directory, do the following: - - ```bash - spctl -a -vv /Applications/Firefly.app - ``` - -5. Make sure that the following information matches the output of the command (assuming Firefly is in the `/Applications` directory): - - ``` - /Applications/Firefly.app: accepted - source=Developer ID - origin=Developer ID Application: IOTA Stiftung (UG77RJKZHH) - ``` - -### Linux Operating System - -#### Verify the SHA256 Hash - -##### Prerequisites - -You will need the `sha256sum` package, which is included with most Linux distributions. - -1. Open the Terminal. - -2. Create a SHA256 hash of the Firefly Desktop executable file. Replace the path with the path to your Firefly executable file. - -```bash -sha256sum path/to/firefly-desktop-version.AppImage -``` - -For example, if the file is in `~/Downloads`, do the following: - -```bash -sha256sum ~/Downloads/firefly-desktop-1.0.0.AppImage -``` - -3. Compare your SHA256 hash with the one in the [release notes](https://github.com/iotaledger/firefly/releases) and make sure that they match. - -#### Verify the code signature - -1. Download the .asc file in the Assets section of the [release notes](https://github.com/iotaledger/firefly/releases). - -2. Import the Firefly GPG key from keyserver.ubuntu.com. - - ```bash - gpg --keyserver keyserver.ubuntu.com --recv 466385BD0B40D9550F93C04746A440CCE5664A64 - ``` - -3. Make sure that the following information matches the output of the command: - - ```bash - gpg: key 46A440CCE5664A64: public key "IOTA Foundation (IOTA Foundation Identity) " - ``` - -4. Verify the signature. - - ```bash - gpg --verify path/to/firefly-desktop-version.AppImage.asc path/to/firefly-desktop-version.AppImage - ``` - - For example, if the .asc and .AppImage files are both in `~/Downloads`, do the following: - - ```bash - gpg --verify ~/Downloads/firefly-desktop-1.0.0.AppImage.asc ~/Downloads/firefly-desktop-1.0.0.AppImage - ``` - -5. Make sure that the following information matches the output of the command: - - ```bash - gpg: Good signature from "IOTA Foundation (IOTA Foundation Identity) " - ``` diff --git a/docs/build/introduction-docs/chrysalis/docs/reference/.keep b/docs/build/introduction-docs/chrysalis/docs/reference/.keep deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/build/introduction-docs/chrysalis/docs/reference/changelog.md b/docs/build/introduction-docs/chrysalis/docs/reference/changelog.md deleted file mode 100644 index 1ae64f69137..00000000000 --- a/docs/build/introduction-docs/chrysalis/docs/reference/changelog.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -description: An overview of the available guides for the Chrysalis network that also outlines the changes from IOTA 1.0 to IOTA 1.5, aka Chrysalis. -image: /img/logo/Chrysalis_logo_dark.png -keywords: - - IOTA 1.0 - - IOTA 1.5 - - changes - - guides - - migration - - developer - - reference ---- - -# Chrysalis Changelog - -- The format of the address was changed, and it is now based on both the `derivation path` and `bech32` standards. For reference, you can read the [IOTA address anatomy](./details.md#iota-15-address-anatomy) guide. -- The concepts of `bundles` and `transactions` were replaced with `messages` and `payloads`. The `message` is a data structure that is actually being broadcast in the network and represents a node (vertex) in the Tangle graph. For reference, you can read both the [messages, payload, and transactions](./details.md#messages-payloads-and-transactions) and [selected message payloads](./details.md#selected-message-payloads) guides. -- The IOTA network is based on a DAG (Directed Acyclic Graph) to store individual `messages` and related `transactions`. However, each `message` can newly reference up to 8 parent messages. For reference, you can read the [messages, payload, and transactions](./details.md#messages-payloads-and-transactions) guide. -- The signature scheme based on `WOTS` was replaced with the `Ed25519` signature scheme. For reference, you can read the [seed and addresses](./details.md#seed-and-addresses) guide. -- Due to the changed signature scheme, IOTA addresses are reusable without any negative security impact. Compared to IOTA 1.0, which was based on ternary, IOTA 1.5 is based on binary and is thus very efficient on all kinds of current hardware devices. In contrast to IOTA 1.0, IOTA 1.5 addresses are perfectly reusable; even if one spends funds from the given address, it can be used again. For reference, you can read the [address/key space](./details.md#addresskey-space) guide. -- Originally, IOTA 1.0 used an `account-based model` for tracking individual iota tokens. Chrysalis embraced the `Unspent Transaction Output` (also known as `UTXO`) model to track tokens and token holders. For reference, you can read the [Unspent Transaction Output](./details.md#unspent-transaction-output-utxo) guide. -- The approach to client libraries was completely reengineered from the ground up. There are new official client libraries that serve as `one-source-code-of-truth` to IOTA users and can be combined in a modular fashion based on particular use cases. All libraries provide a binding to other programming languages. For reference, you can read an overview of [client libraries](../explanations/libraries.md). -- Our official IOTA tools, such as wallet software, use the same libraries under the hood so any developer may work in the same environment as we do. -- The official client libraries embraced an `Hierarchical Deterministic Wallets` approach which is fully `BIP44` compatible. For reference, you can read the [address/key space](./details.md#addresskey-space) guide. -- There is a new official wallet software called Firefly. See [Firefly](https://firefly.iota.org/) and the Repo at: [Firefly Github](https://github.com/iotaledger/firefly) diff --git a/docs/build/introduction-docs/chrysalis/docs/reference/details.md b/docs/build/introduction-docs/chrysalis/docs/reference/details.md deleted file mode 100644 index 2824ec62539..00000000000 --- a/docs/build/introduction-docs/chrysalis/docs/reference/details.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -description: This article outlines the differences between IOTA 1.0 and IOTA 1.5, aka Chrysalis. -image: /img/logo/Chrysalis_logo_dark.png -keywords: - - developer - - Address Anatomy - - seeds - - UTXO - - Ed25519 - - IOTA 1.5 - - IOTA 1.0 - - reference ---- - -# Chrysalis Details - -## Seed and Addresses - -In Chrysalis, all ternary conversions apart from PoW have been removed which results in a better, faster developer experience. Additionally, the WOTS-Signature has been replaced by an `Ed25519` signature scheme. This means that you can now use an address multiple times to send and receive coins. - -With these changes, and the further adoption of industry standards, both seeds and addresses look completely different in Chrysalis. - -IOTA 1.0 address: - -```bash -UDYXTZBE9GZGPM9SSQV9LTZNDLJIZMPUVVXYXFYVBLIEUHLSEWFTKZZLXYRHHWVQV9MNNX9KZC9D9UZWZRGJMIGPDW -``` - -IOTA 1.5 (Chrysalis) address (bech32 standard): - -Mainnet with `iota`. - -```bash -iota1qpw6k49dedaxrt854rau02talgfshgt0jlm5w8x9nk5ts6f5x5m759nh2ml -``` - -Devnet with `atoi`. - -```bash -atoi1qpw6k49dedaxrt854rau02talgfshgt0jlm5w8x9nk5ts6f5x5m75zaxtpj -``` - -### IOTA 1.5 Address Anatomy - -The current IOTA address is based on the Ed25519 signature scheme and it is usually represented by the Bech32 (checksummed base32) format string of 64 characters or hex format: - -We can break down the address `iota1qpw6k49dedaxrt854rau02talgfshgt0jlm5w8x9nk5ts6f5x5m759nh2ml` into three distinguishable parts: - -| human-readable id | separator | data | checksum | -| ----------------- | --------- | ----------------------------------------------------- | ----------------------- | -| iota \| atoi | 1 | 48 bytes [0..9a..z] | 6 characters [0..9a..z] | -| iota | 1 | qpw6k49dedaxrt854rau02talgfshgt0jlm5w8x9nk5ts6f5x5m75 | 9nh2ml | - -For further reference, please see our [Protocol-rfc#0020 - Bech32 Address Format](https://github.com/iotaledger/tips/blob/main/tips/TIP-0011/tip-0011.md) page. - -### Seed - -With the updated [wallet library](/wallet.rs/welcome), developers do not need to use a self-generated seed. By default, the seed is created and stored in Stronghold, our in-house built security enclave. It is not possible to extract the seed from Stronghold for security purposes. Stronghold uses encrypted snapshots that can easily be backed up and securely shared between devices. These snapshots are then further secured with a password. - -More information about IOTA Wallet Library is available on the [Wallet docs page](/wallet.rs/welcome) or in the [Exchange guide](../how_tos/exchange.md), which is mainly focuses on _value transactions_. - -:::note - -It is highly recommended you do NOT use online seed generators at all. The seed is the only key to the given funds. - -::: - -A root of the `Ed25519` signature scheme is a `32-byte (256-bit)` uniformly randomly generated seed based on which all private keys and corresponding addresses are generated. A seed may be represented by a string of 64 characters using `[0-9a-f]` alphabet (32 bytes encoded in hexadecimal). - -The seed can be, for example, generated using the SHA256 algorithm on some random input generated by cryptographically secure pseudo-random generator, such as [os.urandom()](/iota.rs/examples/generate_seed/?language=python). - -Seed examples (a single seed per line): - -```plaintext -4892e2265c45734d07f220294b1697244a8ab5beb38ba9a7d57aeebf36b6e84a -37c4aab22a5883595dbc77907c1626c1be39d104df39c5d5708423c0286aea89 -e94346bce41402155ef120e2525fad2d0bf30b10a89e4b93fd8471df1e6a0981 -... -``` - -> In modern wallet implementations, such as our [wallet.rs library](/wallet.rs/welcome) and [firefly wallet](https://github.com/iotaledger/firefly), the seed is usually generated from a `seed mnemonic` (`seed phrase`), using the [BIP39 standard](https://en.bitcoin.it/wiki/BIP_0039), for better memorization or to be stored by humans. It is based on a randomly generated list of english words and is later used to generate the seed. Either way, the seed is a root for all generated private keys and addresses. - -For further reference, please see the [Protocol-rfc#0010 - Mnemonic Seed](https://github.com/iotaledger/tips/blob/main/tips/TIP-0010/tip-0010.md) page. - -### Address/Key Space - -As mentioned above, IOTA 1.5 embraced some existing industry standards, which is apparent during an address generation process. This included the [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) standard that describes an approach to _Hierarchical Deterministic Wallets_ which was further improved by [BIP44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki). - -These standards define a tree structure as a base for address and key space generation which is represented by a `derivation path`: - -```plaintext -m / purpose / coin_type / account / change / address_index -``` - -- `m`: a master node (seed). -- `purpose`: constant which is {44}. -- `coin_type`: a constant set for each crypto currency. IOTA = 4218, for instance. -- `account`: account index. Zero-based increasing `int`. This level splits the address/key space into independent branches (ex. user identities) which each has its own set of addresses/keys. -- `change`: change index which is `{0, 1}`, also known as `wallet chain`.
- There are two independent chain of addresses/keys. `0` is reserved for public addresses (for coin receival) and `1` is reserved for internal (also known as change) addresses to which a transaction change is returned. _In comparison to IOTA 1.0, IOTA 1.5 is fine with address reuse, and so it is, technically speaking, valid to return transaction change to the same originating address. It is up to developers whether to leverage it or not. `iota.rs` library and its sibling `wallet.rs` help with either scenario_. -- `address_index`: address index. Zero-based increasing `int` that indicates an address index. - -As outlined, there is a large address/key space that is secured by a single seed. - -And there are a few additional things to note: - -- Each level defines a completely different subtree (subspace) of addresses/keys and those are never mixed up. -- The hierarchy is ready to "absorb" addresses/keys for different coins at the same time (`coin_type`) and all those coins are secured by the same seed. -- There may also be other `purposes` in the future. However, we should consider it a single purpose as of now. The constant `44` stands for BIP44. -- The standard was agreed upon by different crypto communities, although not all `derivation path` components are always in active use. For example, `account` is not always actively leveraged across crypto space (if this is a case then there is usually `account=0` used). -- Using different `accounts` may be useful to split addresses/key into some independent spaces and it is up to developers to implement.
- -:::note - -Having many different accounts may have a negative impact on performance while in the [account discovery](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki#account-discovery) phase. So, if you are after using multiple, different accounts then you may be interested in our stateful library [wallet.rs](/wallet.rs/welcome) that incorporates all business logic needed to efficiently manage independent accounts. Additionally, our [exchange guide](../how_tos/exchange.md) provides some useful tips on how different accounts may be leveraged. - -::: - -![Address Generation](/img/guides/address_generation.svg) - -So in case of Chrysalis, the derivation path of address/key space is `[seed]/44/4218/{int}/{0,1}/{int}`: - -- The levels `purpose` and `coin_type` are given. -- The rest levels are up to developers to integrate, specifically `seed`, `account`, `wallet_chain`, and `address_index`. - -For further reference, please see our [Protocol-rfc#0003 - Signature Scheme](https://github.com/iotaledger/protocol-rfcs/blob/ee07797acb5940b7dbb5c3411b184ccdc6afdbb1/text/0000-ed25519-signature-scheme/0000-ed25519-signature-scheme.md) page. - -## Messages, Payloads, and Transactions - -In comparison to the original IOTA 1.0, Chrysalis also introduced some fundamental changes to the underlying data structures. The original concept of `transactions` and `bundles` is gone and has been replaced by a concept of `messages` and `payloads`. - -A `message` is a data structure that is actually being broadcast in the Chrysalis network and represents a node (vertex) in the Tangle graph. - -It refers to at least 1 (2 is recommended) and up to 8 previous messages and once a message is attached to the Tangle and approved by a milestone, the Tangle structure ensures the content of the message is unaltered. Every message is referenced by a `message_id` which is based on a hash algorithm (`Blake2b256`) of binary content of the message. It also includes previous Tangle messages as its `parents` which means it is not possible to alter the given message without altering previous messages in the Tangle. - -The `message` is an atomic unit that is confirmed by the network as a whole. - -:::info - -IOTA is no longer based on ternary. IOTA 1.5 uses binary to encode and broadcast all underlying data entities. - -::: - -A `message` can be up to 32 kb in size and can hold variable sets of information called `payloads`. The number of payloads a single message can encapsulate is not given. Even a message without a `payload` is completely valid and can be broadcast. The `message` itself does not include any timestamp; a message timestamp is derived from an acceptance of the given message by the Tangle network. - -For further reference, please see our [TIP#0006 - Message](https://github.com/iotaledger/tips/blob/main/tips/TIP-0006/tip-0006.md) page. - -A `payload` represents a layer of concern. Some payloads may change the state of the ledger (ex. `SignedTransactions`) and some may provide extra features to some specific applications and business use cases (ex. `IndexationPayload`). - -There are already implemented core payloads, such as `SignedTransaction`, `MilestonePayload`, and `IndexationPayload` but the message and payload definition is generic enough to incorporate any future payload(s) the community agrees upon. - -For further reference, please see our [TIP#0018 - Transaction Payload](https://github.com/iotaledger/tips/blob/main/tips/TIP-0007/tip-0007.md) page. - -The IOTA network ensures the outer structure of the message itself is valid and strictly complies with network consensus protocol. However, the inner structure is very flexible, future-proof, and offers network extensibility. - -![Messages in the Tangle](/img/guides/messages_in_tangle.svg) - -The current Chrysalis network incorporates the following core payloads: - -- `SignedTransaction`: a payload that describes `UTXO` transactions that are the cornerstones of value-based transfers in the IOTA network. Via this payload, a `message` can also be cryptographically signed. -- `MilestonePayload`: a payload that is emitted by the Coordinator. -- `IndexationPayload`: a payload that enables the addition of an index to the encapsulating message, as well as some arbitrary data. The given index can be later used to search the message(s). - -In comparison to IOTA 1.0, a `message` itself is not directly related to the IOTA address while broadcasting to the Chrysalis network. Such messages are referenced using the so-called `message_id`. Messages are indirectly related to IOTA addresses via `SignedTransaction` payload, specifically the `UTXO` section. - -## Unspent Transaction Output (UTXO) - -Originally, IOTA 1.0 used an `account-based model` for tracking individual iota tokens: each IOTA address held a number of tokens and the aggregated number of tokens from all IOTA addresses was equal to the total supply. - -In contrast, Chrysalis uses the `unspent transaction output` model, or `UTXO`. It is based on an idea to track unspent amounts of tokens via a data structure called `output`. - -Below is a simplified analogy of how the UTXO works: - -- There are 100 tokens recorded in the ledger as `Output A` and this output belongs to Alice. So, the **initial state of the ledger**: `Output A` = 100 tokens. -- Alice sends 20 tokens to Paul, 30 tokens to Linda, and keeps 50 tokens at her disposal. -- Her 100 tokens are recorded as `Output A` so she has to divide (spent) tokens and create three new outputs:
`Output B` with 20 tokens that goes to Paul, `Output C` with 30 tokens that goes to Linda, and finally `Output D` with the rest of the 50 tokens that she kept for herself. -- **Original `Output A`** was completely spent and cannot be used any more. It has been spent and so **becomes irrelevant** to ledger state. -- **New state of ledger**: - - `Output B` = 20 tokens. - - `Output C` = 30 tokens. - - `Output D` = 50 tokens. -- The total supply remains the same, the number of outputs differs, and some outputs were replaced by other outputs in the process. - -![Unspent Transaction Output](/img/guides/utxo.svg) - -The key takeaway of the outlined process above is the fact that each unique `output` can be spent **only once**. Once the given `output` is spent, it cannot be used any more and is irrelevant in regards to the ledger state. - -So even if Alice still wants to keep the remaining tokens at her fingertips, those tokens have to be moved to a completely new `output` that can be, for instance, still tied to Alice's same IOTA address as before. - -Every `output` also stores information about an IOTA address to which it is coupled with. So addresses and tokens are indirectly coupled via `outputs`. Basically, the sum of outputs and their amounts under the given address is a balance of the given address, that is, the number of tokens the given address can spend. And the sum of all unspent outputs and their amounts is equal to the total supply. - -`Outputs` are being broadcasted and encapsulated in a `message` as a part of `SignedTransaction` payload. - -## Selected Message Payloads - -Currently, there are two commonly used message payloads, `IndexationPayload` and `SignedTransaction` which can be combined as needed. - -For further reference, please see our [TIP#0007 - Transaction Payload](https://github.com/iotaledger/tips/blob/main/tips/TIP-0007/tip-0007.md) page. - -### IndexationPayload - -`IndexationPayload` is a payload type that can be used to attach arbitrary `data` and key `index` to a message. When this particular payload is leveraged, then a message and related data entity can be searched via key `index` in addition to a `message_id`. - -### SignedTransaction - -`SignedTransaction` is a payload type that is used to transfer value-based messages as `UTXO`. It changes the ledger state as old `outputs` are being spent (replaced) and new `outputs` are being created. - -Each `SignedTransaction` includes the following set of information: - -- `inputs` - a list of valid `outputs` that should be used to fund the given transaction. Outputs are uniquely referenced via a previous `transaction_id` and inner `index`. At least one output has to be given with enough balance to source all `outputs` of the given message. -- `outputs` - a list of IOTA address(es) and related amount(s) the input `outputs` should be split among. Based on this information, new `UTXO` outputs are being created. -- `unlock_blocks` - it includes a transaction signature(s) (currently based on `Ed25519` scheme) that proves token ownership based on a valid seed. - -## Dust Protection - -Since IOTA is feeless and has the ability to send microtransactions, attackers could use this to spam the network with very low _value transactions_, which we call dust. To avoid this, we only allow microtransaction below 1Mi (dust) of IOTA tokens to another address if you already have at least 1Mi as a dust allowance output on that address. The number of allowed dust outputs on an address is the amount of the dust allowance outputs divided by 100,000 and rounded down, that is, 10 outputs for each 1 Mi deposited, with a maximum of 100 dust outputs in total. - -:::note - -In the _UTXO model_, each node in the network needs to keep track of all the currently unspent outputs. When the number of outputs becomes too large, it can cause performance and memory issues. The RFC below proposes a new protocol rule regarding the processing of outputs where they transfer a very small amount of IOTA’s so-called dust outputs. Dust outputs are only allowed when they are backed up by a certain deposit on the receiving address. This limits the amount of dust outputs, thus making it expensive to proliferate dust. Since a receiver must make a deposit, the protocol makes receiving dust an opt-in feature. - -::: - -For further reference, please see our [TIP#0015 - Dust Protection](https://github.com/iotaledger/tips/blob/main/tips/TIP-0015/tip-0015.md) page. - -## Up to 8 Parents - -With IOTA 1.0, you always had to reference 2 parent transactions. With Chrysalis, we introduced a more dynamic number of parent nodes where you can reference up to 8 parents. We recommend you reference at least 2 unique parents at all times for the best possible results. - -For further reference, please see our [TIP#0008 - Message](https://github.com/iotaledger/tips/blob/main/tips/TIP-0008/tip-0008.md) page. diff --git a/docs/build/introduction-docs/chrysalis/docs/reference/networks/devnet.md b/docs/build/introduction-docs/chrysalis/docs/reference/networks/devnet.md deleted file mode 100644 index 5b054071c6a..00000000000 --- a/docs/build/introduction-docs/chrysalis/docs/reference/networks/devnet.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -description: The IOTA foundation provides load-balanced public devnet endpoints, where MQTT and the HTTP REST API are enabled. -image: /img/logo/Chrysalis_logo_dark.png -keywords: - - devnet - - load-balanced - - HTTP REST API - - MQTT - - reference ---- - -# Devnet - -Since the Chrysalis update, the `testnet` is now called `devnet`. We recommend using the `devnet` to develop and test your application. - -## Public Infrastructure - -IOTA currently provides a load-balanced public devNet endpoint: - -- [https://api.lb-0.h.chrysalis-devnet.iota.cafe/](https://api.lb-0.h.chrysalis-devnet.iota.cafe/). -- [https://api.lb-1.h.chrysalis-devnet.iota.cafe/](https://api.lb-1.h.chrysalis-devnet.iota.cafe/). - -:::note - -We recommend using the load balancer for most scenarios. - -::: - -We also provide single node endpoints that expose native [MQTT](https://mqtt.org/): - -- [https://api.thin-hornet-0.h.chrysalis-devnet.iota.cafe](https://api.thin-hornet-0.h.chrysalis-devnet.iota.cafe) -- [https://api.thin-hornet-1.h.chrysalis-devnet.iota.cafe](https://api.thin-hornet-1.h.chrysalis-devnet.iota.cafe) -- mqtt.lb-0.h.chrysalis-devnet.iota.cafe:1883 -- mqtt.lb-1.h.chrysalis-devnet.iota.cafe:1883 - -These endpoints have MQTT (via WebSockets and raw TCP) exposed and offer the HTTP REST API (according to this [specification](https://editor.swagger.io/?url=https://raw.githubusercontent.com/rufsam/protocol-rfcs/master/text/0026-rest-api/rest-api.yaml)) over TLS. - -## Developer Tools - -- [Explorer](https://explorer.iota.org/devnet). -- [Online Faucet](https://faucet.chrysalis-devnet.iota.cafe). -- [cli-wallet](https://github.com/iotaledger/cli-wallet). -- [chrysalis-faucet Code (nodejs + svelte)](https://github.com/iotaledger/chrysalis-faucet). diff --git a/docs/build/introduction-docs/chrysalis/docs/reference/networks/mainnet.md b/docs/build/introduction-docs/chrysalis/docs/reference/networks/mainnet.md deleted file mode 100644 index adad9edf67a..00000000000 --- a/docs/build/introduction-docs/chrysalis/docs/reference/networks/mainnet.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -description: The IOTA foundation provides load-balanced public mainnet endpoints where MQTT and the HTTP REST API are enabled. -image: /img/logo/Chrysalis_logo_dark.png -keywords: - - mainnet - - MQTT - - REST API - - HTTP - - Explorer - - reference ---- - -# Mainnet - -## Public Infrastructure - -IOTA currently provides two load-balanced public mainnet endpoints: - -- chrysalis-nodes.iota.org. -- chrysalis-nodes.iota.cafe. - -These endpoints have MQTT (via WebSockets) exposed and offer the HTTP REST API (according to this [specification](https://editor.swagger.io/?url=https://raw.githubusercontent.com/rufsam/protocol-rfcs/master/text/0026-rest-api/0026-rest-api.yaml)) -over TLS. - -## Developer Tools - -- [Explorer](https://explorer.iota.org/mainnet). diff --git a/docs/build/introduction-docs/chrysalis/docs/resources.md b/docs/build/introduction-docs/chrysalis/docs/resources.md deleted file mode 100644 index 729afdfd3d9..00000000000 --- a/docs/build/introduction-docs/chrysalis/docs/resources.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -description: Official and Community resources to help you develop and troubleshoot your application. -image: /img/logo/Chrysalis_logo_dark.png -keywords: - - tangle explorer - - discord - - stackExchange - - community - - official - - reference ---- - -# Resources - -### **Official Support** - ---- - -#### **IOTA Explorer** - -[IOTA Explorer](https://explorer.iota.org/mainnet) - -Official Tangle explorer with a lot of tools to browse through the Tangle. - ---- - -#### **Discord** - -[IOTA Discord](https://discord.iota.org) - -The official Discord server where community members and the IOTA Foundation discuss projects and related subjects. - ---- - -#### **IOTA StackExchange** - -[IOTA StackExchange](https://iota.stackexchange.com) - -The official forum where you can ask or answer technical questions about IOTA. - ---- - -### **Community Support** - ---- - -#### TheTangle.org - IOTA Explorer - -[The Tangle](https://thetangle.org) - -A community tool for searching transactions in the Tangle. - ---- - -#### TangleBayExplorer - IOTA Explorer - -[Tangle Bay](https://explorer.tanglebay.com/mainnet) - -An community tool for searching transactions in the Tangle. - ---- diff --git a/docs/build/introduction-docs/chrysalis/docs/tutorials/.keep b/docs/build/introduction-docs/chrysalis/docs/tutorials/.keep deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/build/introduction-docs/chrysalis/docs/welcome.md b/docs/build/introduction-docs/chrysalis/docs/welcome.md deleted file mode 100644 index b4b781b1ab5..00000000000 --- a/docs/build/introduction-docs/chrysalis/docs/welcome.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -keywords: - - Welcome - - Chrysalis - - Documentation -description: Welcome to the official Chrysalis documentation -image: /img/logo/Chrysalis_logo_dark.png ---- - -# Welcome - -This page outlines the fundamental changes to the IOTA protocol which were deployed in April 2021 with the release of IOTA 1.5, also known as Chrysalis. - -This is the technical documentation for developers. For updates and network status, please visit [https://chrysalis.iota.org](https://chrysalis.iota.org). - -![Chrysalis, a new dawn](/img/introduction/01_butterfly.png) diff --git a/docs/build/introduction-docs/chrysalis/sidebars.js b/docs/build/introduction-docs/chrysalis/sidebars.js deleted file mode 100644 index 8609a158d14..00000000000 --- a/docs/build/introduction-docs/chrysalis/sidebars.js +++ /dev/null @@ -1,140 +0,0 @@ -module.exports = { - mySidebar: [ - { - type: 'doc', - id: 'welcome', - label: 'Welcome', - }, - { - type: 'category', - label: 'Explanations', - items: [ - { - type: 'category', - label: 'Chrysalis Update', - items: [ - { - type: 'doc', - id: 'explanations/update/what_is_chrysalis', - label: 'Overview', - }, - { - type: 'doc', - id: 'explanations/update/chrysalis_improvements', - label: 'Protocol Improvements', - }, - { - type: 'doc', - id: 'explanations/update/path_to_chrysalis', - label: 'Path To Chrysalis', - }, - { - type: 'doc', - id: 'explanations/update/migration_mechanism', - label: 'Migration Mechanism', - }, - ], - }, - { - type: 'doc', - id: 'explanations/node_software', - label: 'Node Software', - }, - { - type: 'doc', - id: 'explanations/libraries', - label: 'Libraries', - }, - { - type: 'doc', - id: 'explanations/protocol_tip', - label: 'TIPs', - }, - { - type: 'doc', - id: 'explanations/faq', - label: 'FAQ', - }, - ], - }, - { - type: 'category', - label: 'How Tos', - items: [ - { - type: 'doc', - id: 'how_tos/verify_firefly_download', - label: 'Verify Firefly Download', - }, - { - type: 'doc', - id: 'how_tos/backup_security', - label: 'Backup and Security', - }, - { - type: 'doc', - id: 'how_tos/exchange', - label: 'Integrate Exchange', - }, - { - type: 'category', - label: 'Migration From IOTA 1.0', - items: [ - { - type: 'doc', - id: 'how_tos/migration/token_migration', - label: 'Token Migration', - }, - { - type: 'doc', - id: 'how_tos/migration/snapshot_validation_bootstrapping', - label: 'Snapshot Validation Bootstrapping', - }, - { - type: 'doc', - id: 'how_tos/migration/hub_migration', - label: 'Hub Migration', - }, - ], - }, - ], - }, - { - type: 'category', - label: 'Reference', - items: [ - { - type: 'doc', - id: 'reference/changelog', - label: 'Changelog', - }, - { - type: 'doc', - id: 'reference/details', - label: 'Detailed Description', - }, - { - type: 'category', - label: 'Networks', - items: [ - { - type: 'doc', - id: 'reference/networks/mainnet', - label: 'Mainnet', - }, - { - type: 'doc', - id: 'reference/networks/devnet', - label: 'Devnet', - }, - ], - }, - ], - }, - { - type: 'doc', - id: 'resources', - label: 'Resources', - }, - ], -}; diff --git a/docs/build/introduction-docs/stardust/docs/explanations/libraries/client.md b/docs/build/introduction-docs/stardust/docs/explanations/libraries/client.md deleted file mode 100644 index 90074d1dcfd..00000000000 --- a/docs/build/introduction-docs/stardust/docs/explanations/libraries/client.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -description: The wallet library is a stateful library for developers who want to use IOTA for token transfers. This library has a stateful design and supports the handling and monitoring of multiple accounts and addresses. -image: /img/logo/preview.png -keywords: - - stateful - - value transactions - - Rust - - python - - nodejs - - C - - wallet - - stronghold.rs - - reference ---- - -# IOTA Client Library - -:::warning Deprecated - -The IOTA client libraries have been deprecated and replaced by the [IOTA SDK](/iota-sdk/welcome). - -::: - -The official client library for interacting with the IOTA Tangle allows you to: - -- Create blocks and transactions. -- Sign transactions. -- Generate addresses. -- Interact with an IOTA node. - -However, if you want to process value transfers, you should use our stateful [wallet library](wallet.md) instead. - -## Rust - -- [Getting Started](/iota.rs/2.0-rc.7/getting_started/rust) - Getting Started with Rust and the IOTA Client Library. -- [Examples](/iota.rs/2.0-rc.7/how_tos/run_how_tos?language=rust) - Find starting points or inspiration in the examples. -- [Repository](https://github.com/iotaledger/iota.rs/tree/develop) - Browse through the code and learn what's happening behind the scenes. Pull requests are very welcome! -- [API Documentation](/iota.rs/2.0-rc.7/libraries/rust/api_reference) - The IOTA Client Library Rust API Documentation. - -## Node.js - -- [Getting Started](/iota.rs/2.0-rc.7/getting_started/nodejs) - Getting Started with Node.js and the IOTA Client Library. -- [Examples](/iota.rs/2.0-rc.7/how_tos/run_how_tos?language=typescript-node) - Find starting points or inspiration in the examples. -- [Repository](https://github.com/iotaledger/iota.rs/tree/develop) - Browse through the code and learn what's happening behind the scenes. Pull requests are very welcome! -- [API Documentation](/iota.rs/2.0-rc.7/libraries/nodejs/references/api_ref) - The IOTA Client Library Node.js API Documentation. - -## Python - -- [Getting Started](/iota.rs/2.0-rc.7/getting_started/python) - Getting Started with Python and the IOTA Client Library. -- [Examples](/iota.rs/2.0-rc.7/how_tos/run_how_tos?language=python) - Find starting points or inspiration in the examples. -- [Repository](https://github.com/iotaledger/iota.rs/tree/develop/bindings/python) - Browse through the code and learn what's happening behind the scenes. Pull requests are very welcome! -- [API Documentation](/iota.rs/2.0-rc.7/libraries/python/references/iota_client/client) - The IOTA Client Library Python API Documentation. - -## Java - -- [Getting Started](/iota.rs/2.0-rc.7/getting_started/java) - Getting Started with Java and the IOTA Client Library. -- [Examples](/iota.rs/2.0-rc.7/how_tos/run_how_tos?language=java) - Find starting points or inspiration in the examples. -- [Repository](https://github.com/iotaledger/iota.rs/tree/develop/bindings/java) - Browse through the code and learn what's happening behind the scenes. Pull requests are very welcome! -- [API Documentation](/iota.rs/2.0-rc.7/libraries/java/api_reference) - The IOTA Client Library Java API Documentation. - -## C - -- [Getting Started](https://iota-c-client.readthedocs.io/en/latest/client_intro.html) - Getting Started with C and the IOTA Client Library. -- [Examples](https://iota-c-client.readthedocs.io/en/latest/client_examples.html) - Find starting points or inspiration in the examples. -- [Repository](https://github.com/iotaledger/iota.c) - Browse through the code and learn what's happening behind the scenes. Pull requests are very welcome! -- [API Documentation](https://iota-c-client.readthedocs.io/en/latest/api/client.html) - The IOTA Client Library C API Documentation. diff --git a/docs/build/introduction-docs/stardust/docs/explanations/libraries/overview.md b/docs/build/introduction-docs/stardust/docs/explanations/libraries/overview.md index 4151538f7f7..d4e6f3fff8e 100644 --- a/docs/build/introduction-docs/stardust/docs/explanations/libraries/overview.md +++ b/docs/build/introduction-docs/stardust/docs/explanations/libraries/overview.md @@ -24,12 +24,11 @@ The IOTA client libraries have been deprecated and replaced by the [IOTA SDK](/i The official IOTA libraries serve as `one-source-code-of-truth` to IOTA users and provide binding to other programming languages. Below is a list of the IOTA libraries. You can also check out the [IOTA client libraries blog post](https://blog.iota.org/the-new-iota-client-libraries-harder-better-faster-stronger/), to learn about the libraries' core principles. -- [IOTA SDK](/iota-sdk/welcome): The IOTA SDK replaces `iota.rs`, `iota.js` and `wallet.rs` with a convenient development kit, written +- [IOTA SDK](/iota-sdk/welcome): A convenient development kit, written in [Rust](/iota-sdk/getting-started/rust), with bindings for [Node.js](/iota-sdk/getting-started/nodejs), [Python](/iota-sdk/getting-started/python), and [Wasm](/iota-sdk/getting-started/wasm). - [iota.go](https://github.com/iotaledger/iota.go/tree/v3): an IOTA client library in Golang. -- [iota.c](https://github.com/iotaledger/iota.c/tree/develop): a special-purpose library in C for embedded devices (with microcontrollers) covering a basic features of `client-lib` or `wallet-lib.`
diff --git a/docs/build/introduction-docs/stardust/docs/explanations/libraries/wallet.md b/docs/build/introduction-docs/stardust/docs/explanations/libraries/wallet.md deleted file mode 100644 index 2c204733549..00000000000 --- a/docs/build/introduction-docs/stardust/docs/explanations/libraries/wallet.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -description: The official client library for interacting with the IOTA Tangle allows you to create blocks and transactions, sign transactions, generate addresses, and interact with an IOTA node. -image: /img/logo/preview.png -keywords: - - stateless - - Rust - - python - - nodejs - - python - - client - - reference ---- - -# IOTA Wallet Library - -:::warning Deprecated - -The IOTA client libraries have been deprecated and replaced by the [IOTA SDK](/iota-sdk/welcome). - -::: - -The wallet library is a stateful library for developers; essentially, it's a programmable wallet. However, if you use IOTA or Shimmer to transfer tokens, you should use this library as its stateful design supports the handling and monitoring of multiple accounts and addresses. - -It also supports the [Stronghold.rs](https://github.com/iotaledger/stronghold.rs) enclave, incorporating the best security practices in one package. You can read more about the [IOTA Wallet Library documentation in our wiki](/wallet.rs/1.0-rc.6/welcome). - -## Rust - ---- - -- [Getting Started](/wallet.rs/1.0-rc.6/getting_started/rust) - Getting Started with Rust and the IOTA Wallet Library. -- [Examples](/wallet.rs/1.0-rc.6/how_tos/run_how_tos?language=rust) - Find starting points or inspiration in the examples. -- [Repository](https://github.com/iotaledger/wallet.rs/tree/develop) - Browse through the code and learn what's happening behind the scenes. Pull requests are very welcome! -- [API Documentation](/wallet.rs/1.0-rc.6/references/rust_api_reference) - The IOTA Wallet Library Rust API Documentation. - -## Node.js - ---- - -- [Getting Started](/wallet.rs/1.0-rc.6/getting_started/nodejs) - Getting Started with Node.js and the IOTA Wallet Library. -- [Examples](/wallet.rs/1.0-rc.6/how_tos/run_how_tos?language=typescript-node) - Find starting points or inspiration in the examples. -- [Repository](https://github.com/iotaledger/wallet.rs/tree/develop/bindings/nodejs) - Browse through the code and learn what's happening behind the scenes. Pull requests are very welcome! -- [API Documentation](/wallet.rs/1.0-rc.6/references/nodejs/api_ref) - The IOTA Wallet Library Node.js API Documentation. - -## Python - ---- - -- [Getting Started](/wallet.rs/1.0-rc.6/getting_started/python) - Getting Started with Python and the IOTA Wallet Library. -- [Examples](/wallet.rs/1.0-rc.6/how_tos/run_how_tos?language=python) - Find starting points or inspiration in the examples. -- [Repository](https://github.com/iotaledger/wallet.rs/tree/develop/bindings/python) - Browse through the code and learn what's happening behind the scenes. Pull requests are very welcome! -- [API Documentation](/wallet.rs/1.0-rc.6/references/python/iota_wallet/account) - The IOTA Wallet Library Python API Documentation. diff --git a/docs/build/introduction-docs/stardust/docs/welcome.md b/docs/build/introduction-docs/stardust/docs/welcome.md index 0c96c6c79d5..ffc97342632 100644 --- a/docs/build/introduction-docs/stardust/docs/welcome.md +++ b/docs/build/introduction-docs/stardust/docs/welcome.md @@ -9,7 +9,7 @@ image: /img/logo/preview.png # Welcome -Stardust protocol is the successor to IOTA 1.5, also known as [Chrysalis](/introduction/welcome), that transforms IOTA into a multi-asset ledger and enables the operation of [IOTA Smart Contracts](/learn/smart-contracts/introduction/). This page outlines the new concepts +Stardust protocol is the successor to IOTA 1.5, also known as _Chrysalis_, that transforms IOTA into a multi-asset ledger and enables the operation of [IOTA Smart Contracts](/learn/smart-contracts/introduction/). This page outlines the new concepts and differences compared to Chrysalis, furthermore gives an overview of different components of the IOTA technology stack. Stardust debuts on [Shimmer](https://shimmer.network/), the new staging network for IOTA, before being fully supported on the IOTA Mainnet. diff --git a/docs/build/introduction-docs/stardust/sidebars.js b/docs/build/introduction-docs/stardust/sidebars.js index 08c2ef7569f..53dfb818769 100644 --- a/docs/build/introduction-docs/stardust/sidebars.js +++ b/docs/build/introduction-docs/stardust/sidebars.js @@ -110,16 +110,6 @@ module.exports = { id: 'explanations/libraries/overview', label: 'Overview', }, - { - type: 'doc', - id: 'explanations/libraries/client', - label: 'Client Lib', - }, - { - type: 'doc', - id: 'explanations/libraries/wallet', - label: 'Wallet Lib', - }, ], }, { diff --git a/docs/build/iota-sdk/1.0/docs/_admonitions/_warning-password-storage.md b/docs/build/iota-sdk/1.0/docs/_admonitions/_warning-password-storage.md index bd0a57dcebe..ca770a3344e 100644 --- a/docs/build/iota-sdk/1.0/docs/_admonitions/_warning-password-storage.md +++ b/docs/build/iota-sdk/1.0/docs/_admonitions/_warning-password-storage.md @@ -1,7 +1,7 @@ :::warning Safe Password Storage In a production setup, do not store passwords in the host's environment variables or in the source code. See -our [backup and security recommendations](/introduction/how_tos/backup_security) for +our [backup and security recommendations](/introduction/stardust/how_tos/backup_security) for production setups. ::: diff --git a/docs/build/iota-sdk/1.0/docs/how-tos/exchange-guide.mdx b/docs/build/iota-sdk/1.0/docs/how-tos/exchange-guide.mdx index cd9b1c02e90..e6dedc5f6f2 100644 --- a/docs/build/iota-sdk/1.0/docs/how-tos/exchange-guide.mdx +++ b/docs/build/iota-sdk/1.0/docs/how-tos/exchange-guide.mdx @@ -78,16 +78,16 @@ Most of the APIs are the same and the changes are fairly minimal, here are some - The npm package changes from [`@iota/wallet`](https://www.npmjs.com/package/@iota/wallet) to [`@iota/sdk`](https://www.npmjs.com/package/@iota/sdk). -- [`AccountManager`](/wallet.rs/1.0-rc.6/references/nodejs/classes/AccountManager) +- `AccountManager` becomes [`Wallet`](../references/nodejs/classes/Wallet.md). -- [`manager.generateMnemonic()`](/wallet.rs/1.0-rc.6/references/nodejs/classes/AccountManager#generatemnemonic) +- `manager.generateMnemonic()` becomes [`Utils.generateMnemonic()`](../references/nodejs/classes/Utils.md#generatemnemonic). -- [`AccountManager.generateAddress`](/wallet.rs/1.0-rc.6/references/nodejs/classes/AccountManager#generateaddress) +- `AccountManager.generateAddress` becomes [`Wallet.generateEd25519Addresses`](../references/nodejs/classes/Wallet.md#generateed25519address). -- [`Account.sendAmount`](/wallet.rs/1.0-rc.6/references/nodejs/classes/Account) becomes +- `Account.sendAmount` becomes [`send`](../references/nodejs/classes/Account.md#send). - The callbacks to `listen` now provide a properly typed [`Event`](../references/nodejs/classes/Event.md). @@ -96,13 +96,13 @@ Most of the APIs are the same and the changes are fairly minimal, here are some - The pip package changes from `iota-wallet` to [`iota-sdk`](https://pypi.org/project/iota-sdk.md). -- [`wallet.generate_mnemonic()`](/wallet.rs/1.0-rc.6/references/python/iota_wallet/wallet#generate_mnemonic) +- `wallet.generate_mnemonic()` becomes [`utils.generate_mnemonic()`](../references/python/iota_sdk/utils.md#generate_mnemonic). -- [`wallet.generate_address()`](/wallet.rs/1.0-rc.6/references/python/iota_wallet/wallet#generate_address) +- `wallet.generate_address()` becomes [`wallet.generate_ed25519_addresses()`](../references/python/iota_sdk/wallet/wallet.md#generate_ed25519_address). -- [`account.send_amount`](/wallet.rs/1.0-rc.6/references/python/iota_wallet/account#send_amount) +- `account.send_amount` becomes [`account.send`](../references/python/iota_sdk/wallet/account.md#send). - The callbacks to `listen` now provide a properly typed @@ -120,7 +120,7 @@ Most of the APIs are the same and the changes are fairly minimal, here are some First, you should install the components needed to use the IOTA SDK and the binding of your choice; it may vary a bit from language to language. -You can read more about [backup and security in this guide](/introduction/how_tos/backup_security). +You can read more about [backup and security in this guide](/introduction/stardust/how_tos/backup_security). diff --git a/docs/build/iota.js/2.0-rc.1/admonitions/_enable_pow.md b/docs/build/iota.js/2.0-rc.1/admonitions/_enable_pow.md deleted file mode 100644 index d983624be29..00000000000 --- a/docs/build/iota.js/2.0-rc.1/admonitions/_enable_pow.md +++ /dev/null @@ -1,7 +0,0 @@ -:::note Enable Proof of Work (POW) - -This example requires an API endpoint that has "Proof of Work" enabled. -The [public Alphanet API](https://api.alphanet.iotaledger.net/) does not have this feature. To run the example, please -choose an API which does, or [run your own Hornet node](/hornet/getting_started). - -::: diff --git a/docs/build/iota.js/2.0-rc.1/docs/contribute.md b/docs/build/iota.js/2.0-rc.1/docs/contribute.md deleted file mode 100644 index cab72150c06..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/contribute.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -description: "Contribute to the Iota.js library by contributing to the official GitHub repository or sharing your -knowledge on Discord." -image: /img/client_banner.png -keywords: -- join -- documentation -- project -- contribute -- discord -- GitHub -- reference ---- - -# Contribute to the Project - -Thank you for considering a contribution to this project. You can help it in the following ways: - -## Contribute to the Project’s GitHub Repository - -All the code is open source and hosted on [GitHub](https://github.com/iotaledger/iota.js) where you can: - -- [Report a bug](https://github.com/iotaledger/iota.js/issues/new?assignees=&labels=c-bug&template=bug_report.md&title=). -- [Suggest a new feature](https://github.com/iotaledger/iota.js/issues/new?assignees=&labels=&template=feature_request.md). -- [Contribute to the documentation](#contribute-to-the-documentation). - -## Contribute to the Documentation - -This documentation is also open source and hosted on GitHub. - -If you want to contribute new documentation or fix an error, see -the [Code of Conduct](https://github.com/iotaledger/iota.js/blob/feat/stardust/.github/CODE_OF_CONDUCT.md). - -## Share Your Knowledge - -Helping others is an essential part of any open source ecosystem. - -By sharing your knowledge with others, you can provide a lot of value to the community and even inspire someone else to -learn and contribute. - -Take a look at what discussions are going on in -the [#client-libraries](https://discord.com/channels/397872799483428865/800637917189636136) -and [#javascript](https://discord.com/channels/397872799483428865/400435174518685696) channels on -our [Discord](https://discord.iota.org). diff --git a/docs/build/iota.js/2.0-rc.1/docs/getting_started.mdx b/docs/build/iota.js/2.0-rc.1/docs/getting_started.mdx deleted file mode 100644 index 853c00657f5..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/getting_started.mdx +++ /dev/null @@ -1,75 +0,0 @@ ---- -description: 'Get started with iota.js. Prequisites, required prior knowledge and install the library' -image: /img/client_banner.png -keywords: - - npm - - node - - install - - build - - example - - typescript - - javascript - - explanation ---- - -# Getting Started With iota.js - -## Required Prior Knowledge - -This wiki assumes that you already know the basics of [TypeScript](https://www.typescriptlang.org/). If you are -unfamiliar with the language, you can find documentation to get started in the official -[TypeScript documentation](https://www.typescriptlang.org/docs/). - -If you have never programmed in your life, MIT has published an open -[introductory course to programming](https://ocw.mit.edu/courses/6-00sc-introduction-to-computer-science-and-programming-spring-2011/) -which could help you get started. - -## Prerequisites - -Before you can start using the library, you will need to install the following software: - -- [node](https://nodejs.org/en/): You should use v15, or above. -- [npm](https://npmjs.com): You should use v7, or above. - -## Install the Library - -You can install the iota.js library using npm with a single command: - -```bash -npm install @iota/iota.js@next -``` - -## Use the Library - -Once you have [installed the library](#install-the-library), you can start using it by requiring the -[iota.js package](https://www.npmjs.com/package/@iota/iota.js) as shown in the following example which connects to a -Chrysalis node and logs some of its properties to the console. - -```js -const { SingleNodeClient } = require('@iota/iota.js'); - -async function run() { - const client = new SingleNodeClient('https://chrysalis-nodes.iota.org'); - - const info = await client.info(); - console.log('Node Info'); - console.log('\tName:', info.name); - console.log('\tVersion:', info.version); - console.log('\tIs Healthy:', info.isHealthy); - console.log('\tNetwork Id:', info.networkId); - console.log('\tLatest Milestone Index:', info.latestMilestoneIndex); - console.log('\tConfirmed Milestone Index:', info.confirmedMilestoneIndex); - console.log('\tPruning Index:', info.pruningIndex); - console.log('\tFeatures:', info.features); - console.log('\tMin PoW Score:', info.minPowScore); -} - -run() - .then(() => console.log('Done')) - .catch((err) => console.error(err)); -``` - -## How-To Guides - -You can find additional usage [examples](https://github.com/iotaledger/iota.js/tree/feat/stardust/packages/iota/examples) in the -[How To section](how_tos/run_how_tos.mdx). diff --git a/docs/build/iota.js/2.0-rc.1/docs/how_tos/.keep b/docs/build/iota.js/2.0-rc.1/docs/how_tos/.keep deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/build/iota.js/2.0-rc.1/docs/how_tos/address.mdx b/docs/build/iota.js/2.0-rc.1/docs/how_tos/address.mdx deleted file mode 100644 index 689879e3e50..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/how_tos/address.mdx +++ /dev/null @@ -1,157 +0,0 @@ ---- -description: 'Learn how to manage addresses with the iota.js client library.' -image: /img/client_banner.png -keywords: - - how to - - example - - address - - manage - - bip44 - - create - - generate seed - - ed25519 ---- - -# Create an Address - -## Pre-requirements - -Before you can create a transaction, you will need to: - -- [Connect to a Node](simple.mdx). - -### Generate A Seed - -#### Constructor - -You can generate a seed from random bytes by instantiating the [Ed255119Seed class](../references/client/classes/Ed25519Seed.md) using -its [constructor](../references/client/classes/Ed25519Seed.md#constructor). - -#### From Mnemonic - -You can also generate a seed from a mnemonic by using the [Ed25519Seed.fromMnemonic(mnemonic)](../references/client/classes/Ed25519Seed.md#frommnemonic) -function. - -##### Generate a Random Mnemonic - -You can generate a random mnemonic using the [Bip39.randomMnemonic(length?)](../references/crypto/classes/Bip39.md#randommnemonic) function. - -## Create an Address - -### Bip44 Address - -#### generateBip44Address() - -You can generate a new Bip44 address using the [generateBip44Address(generatorState )](../references/client/api_ref.md#generatebip44address) function. You will need to provide an [IBip44GeneratorState](../references/client/interfaces/IBip44GeneratorState.md) as `generatorState`. - -### Ed25519 Address - -You can create a new [Ed25519Address](../references/client/classes/Ed25519Address.md) by providing a public key to its -[constructor](../references/client/classes/Ed25519Address.md#constructor). - -### Retrieve an Address - -You can retrieve an address by using the [Ed25519Address.toAddress()](../references/client/classes/Ed25519Address.md#toaddress) -function. - -You can then use the [Converter.bytesToHex(array, includePrefix?, startIndex?, length?, reverse?)](../references/util/classes/Converter.md#bytestohex) and [Bech32Helper.toBech32()](../references/client/classes/Bech32Helper.md#tobech32) functions to convert the address -to Ed25519 or Bech32 formats. - -## Example Code - -```ts reference -https://github.com/iotaledger/iota.js/tree/feat/stardust/packages/iota/examples/address/src/index.ts -``` - -### Expected Output - -```plaintext - -Base - Mnemonic: chronic crucial obtain kit birth river fiber medal napkin month spare reduce increase transfer fan uncover rifle hidden quiz agent bright young bring asthma - Seed acb5eb1312a07f47d147d8ec097d82e2b807478bad17776b965b58d670c14eb35569ee525697f267e85a6c05f3f8aeb333cbbedf9a647316198a3fc423c54c95 - -Generated Addresses using Bip44 Format -Wallet Index m/44'/4218'/0'/0'/0' - Private Key 0xdad2a6b0760bf0dad66fb1fd0c7dafe6bc713ea64f44b32917c91407736fdcc0488e77cbb0075d58fecefaa1e4397148674ea54ae8fe189c8a62e99cd4a3ee24 - Public Key 0x488e77cbb0075d58fecefaa1e4397148674ea54ae8fe189c8a62e99cd4a3ee24 - Address Ed25519 0xe4c72f2db3de883e3366cb8dc7055ab5ea30d30e602ea4774dfc849bc6336cdd - Address Bech32 rms1qrjvwtedk00gs03nvm9cm3c9t2675vxnpeszafrhfh7gfx7xxdkd6j5t63e - -Wallet Index m/44'/4218'/0'/1'/0' - Private Key 0xdb3076273184f2a1c5385166cd22699dbc88f8c97e1b201b2ee505ae77e6b588ae0a85f5986547ec5137bc213c04777b6d708ae11d6fe338e9ec3970d70e2d3c - Public Key 0xae0a85f5986547ec5137bc213c04777b6d708ae11d6fe338e9ec3970d70e2d3c - Address Ed25519 0x10f48fb4680954d073bd6ec25534e64ea8b38d47e3d3c41bfe3436f845a361a4 - Address Bech32 rms1qqg0fra5dqy4f5rnh4hvy4f5ue823vudgl3a83qmlc6rd7z95ds6gg84dug - -Wallet Index m/44'/4218'/0'/0'/1' - Private Key 0xca6befa2029677174e2de4afb3a54b5a44e186b9c3466d208d083bb5215587fd6f19e84ba4e0733b9e5f984aa5b6a63832d06215bb15749dd415e3bab2a0f3bf - Public Key 0x6f19e84ba4e0733b9e5f984aa5b6a63832d06215bb15749dd415e3bab2a0f3bf - Address Ed25519 0x5786019fde4a7b5568c2ee277c29df1aebaa6013c990e18f3eaea726a57a51d6 - Address Bech32 rms1qptcvqvlme98k4tgcthzwlpfmudwh2nqz0yepcv086h2wf490fgavsmad30 - -Wallet Index m/44'/4218'/0'/1'/1' - Private Key 0x538cf517996ffe0eb7fab5d3c1bf712eec8806f8c342a893cadfe951669ab30d9db8b31f652b149fc8214cfcea775731be67908f41f95058ffb32263dccedaa2 - Public Key 0x9db8b31f652b149fc8214cfcea775731be67908f41f95058ffb32263dccedaa2 - Address Ed25519 0x0e25c5ed55c498e5a643e2262ae3838a1405c85f5912e902a095158da8d884b1 - Address Bech32 rms1qq8zt30d2hzf3edxg03zv2hrsw9pgpwgtav396gz5z23trdgmzztzvwhn0t - -Wallet Index m/44'/4218'/0'/0'/2' - Private Key 0x622468ba55412093993ee9625b9ffd031311f8c998fbcb63d4ff4b0409b00142db1dfaad2a9782b965f81d8a8b919e9cf73a68478077de5760ada7e0a2f0f42b - Public Key 0xdb1dfaad2a9782b965f81d8a8b919e9cf73a68478077de5760ada7e0a2f0f42b - Address Ed25519 0x539ad9bd4ab1ce54f4433b0f51d63d3fc0d1c8e5f39063c61ea56fc6d54dfd4c - Address Bech32 rms1qpfe4kdaf2cuu485gvas75wk85lup5wguheeqc7xr6jkl3k4fh75cylay9t - -Wallet Index m/44'/4218'/0'/1'/2' - Private Key 0x580820e4a1c853831421dbf3f78084f2cade850179c0b97aa973c19981b519c21b95f800d65709cbda1dc20180d72c897439ae0e01a4ecccbb8f092cae4839b0 - Public Key 0x1b95f800d65709cbda1dc20180d72c897439ae0e01a4ecccbb8f092cae4839b0 - Address Ed25519 0xf97157ced9d74a3d5af98e4fcf9239ad520f019d9220acccfc76156da537a252 - Address Bech32 rms1qruhz47wm8t55026lx8ylnuj8xk4yrcpnkfzptxvl3mp2md9x739y9sy9cq - - -Generated Addresses manually using Bip44 Format - -Wallet Index m/44'/4218'/0'/0'/0' - Seed dad2a6b0760bf0dad66fb1fd0c7dafe6bc713ea64f44b32917c91407736fdcc0 - Private Key 0xdad2a6b0760bf0dad66fb1fd0c7dafe6bc713ea64f44b32917c91407736fdcc0488e77cbb0075d58fecefaa1e4397148674ea54ae8fe189c8a62e99cd4a3ee24 - Public Key 0x488e77cbb0075d58fecefaa1e4397148674ea54ae8fe189c8a62e99cd4a3ee24 - Address Ed25519 0xe4c72f2db3de883e3366cb8dc7055ab5ea30d30e602ea4774dfc849bc6336cdd - Address Bech32 rms1qrjvwtedk00gs03nvm9cm3c9t2675vxnpeszafrhfh7gfx7xxdkd6j5t63e - -Wallet Index m/44'/4218'/0'/1'/0' - Seed db3076273184f2a1c5385166cd22699dbc88f8c97e1b201b2ee505ae77e6b588 - Private Key 0xdb3076273184f2a1c5385166cd22699dbc88f8c97e1b201b2ee505ae77e6b588ae0a85f5986547ec5137bc213c04777b6d708ae11d6fe338e9ec3970d70e2d3c - Public Key 0xae0a85f5986547ec5137bc213c04777b6d708ae11d6fe338e9ec3970d70e2d3c - Address Ed25519 0x10f48fb4680954d073bd6ec25534e64ea8b38d47e3d3c41bfe3436f845a361a4 - Address Bech32 rms1qqg0fra5dqy4f5rnh4hvy4f5ue823vudgl3a83qmlc6rd7z95ds6gg84dug - -Wallet Index m/44'/4218'/0'/0'/1' - Seed ca6befa2029677174e2de4afb3a54b5a44e186b9c3466d208d083bb5215587fd - Private Key 0xca6befa2029677174e2de4afb3a54b5a44e186b9c3466d208d083bb5215587fd6f19e84ba4e0733b9e5f984aa5b6a63832d06215bb15749dd415e3bab2a0f3bf - Public Key 0x6f19e84ba4e0733b9e5f984aa5b6a63832d06215bb15749dd415e3bab2a0f3bf - Address Ed25519 0x5786019fde4a7b5568c2ee277c29df1aebaa6013c990e18f3eaea726a57a51d6 - Address Bech32 rms1qptcvqvlme98k4tgcthzwlpfmudwh2nqz0yepcv086h2wf490fgavsmad30 - -Wallet Index m/44'/4218'/0'/1'/1' - Seed 538cf517996ffe0eb7fab5d3c1bf712eec8806f8c342a893cadfe951669ab30d - Private Key 0x538cf517996ffe0eb7fab5d3c1bf712eec8806f8c342a893cadfe951669ab30d9db8b31f652b149fc8214cfcea775731be67908f41f95058ffb32263dccedaa2 - Public Key 0x9db8b31f652b149fc8214cfcea775731be67908f41f95058ffb32263dccedaa2 - Address Ed25519 0x0e25c5ed55c498e5a643e2262ae3838a1405c85f5912e902a095158da8d884b1 - Address Bech32 rms1qq8zt30d2hzf3edxg03zv2hrsw9pgpwgtav396gz5z23trdgmzztzvwhn0t - -Wallet Index m/44'/4218'/0'/0'/2' - Seed 622468ba55412093993ee9625b9ffd031311f8c998fbcb63d4ff4b0409b00142 - Private Key 0x622468ba55412093993ee9625b9ffd031311f8c998fbcb63d4ff4b0409b00142db1dfaad2a9782b965f81d8a8b919e9cf73a68478077de5760ada7e0a2f0f42b - Public Key 0xdb1dfaad2a9782b965f81d8a8b919e9cf73a68478077de5760ada7e0a2f0f42b - Address Ed25519 0x539ad9bd4ab1ce54f4433b0f51d63d3fc0d1c8e5f39063c61ea56fc6d54dfd4c - Address Bech32 rms1qpfe4kdaf2cuu485gvas75wk85lup5wguheeqc7xr6jkl3k4fh75cylay9t - -Wallet Index m/44'/4218'/0'/1'/2' - Seed 580820e4a1c853831421dbf3f78084f2cade850179c0b97aa973c19981b519c2 - Private Key 0x580820e4a1c853831421dbf3f78084f2cade850179c0b97aa973c19981b519c21b95f800d65709cbda1dc20180d72c897439ae0e01a4ecccbb8f092cae4839b0 - Public Key 0x1b95f800d65709cbda1dc20180d72c897439ae0e01a4ecccbb8f092cae4839b0 - Address Ed25519 0xf97157ced9d74a3d5af98e4fcf9239ad520f019d9220acccfc76156da537a252 - Address Bech32 rms1qruhz47wm8t55026lx8ylnuj8xk4yrcpnkfzptxvl3mp2md9x739y9sy9cq - -Done -``` diff --git a/docs/build/iota.js/2.0-rc.1/docs/how_tos/browser.mdx b/docs/build/iota.js/2.0-rc.1/docs/how_tos/browser.mdx deleted file mode 100644 index b0e77c79370..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/how_tos/browser.mdx +++ /dev/null @@ -1,143 +0,0 @@ ---- -description: 'Learn how to use the iota.js client library in a browser.' -image: /img/client_banner.png -keywords: - - how to - - example - - browser - - create address - - connect to node - - get node information ---- - -# Display Client Data in a Browser - -The following example covers is based on the [How to Create a Simple Connection article](simple.mdx), but it will log -the data in the browser instead of the command line interface. To run it, you simply need to open the `.html` file in -your browser of choice. - -## Example Code - -```ts reference -https://github.com/iotaledger/iota.js/tree/feat/stardust/packages/iota/examples/browser/index.html -``` - -### Expected Output - -```plaintext - -iota.js Simple Browser ExampleIs the node healthy Yes - -Node Info - Name: HORNET - Version: 2.0.0-alpha.23 - Status - Is Healthy: true - Latest Milestone Index: 54851 - Latest Milestone Timestamp: 1657543301 - Latest Milestone Id: 0x49fe39afe197426e085fc5ce61ba2168307075d13b0b311407654d09532f7efa - Confirmed Milestone Index: 54851 - Confirmed Milestone Timestamp: 1657543301 - Confirmed Milestone Id: 0x49fe39afe197426e085fc5ce61ba2168307075d13b0b311407654d09532f7efa - Pruning Index: 0 - Protocol - Network Name: alphanet-8 - Bech32 HRP: rms - Token supply: 2779530283277761 - Protocol version: - Min PoW Score: 1000 - Rent - VByte Cost: 500 - VByte Factor Data: 1 - VByte Factor Key: 10 - Base token - Name: Shimmer - Ticker Symbol: SMR - Unit: SMR - Sub unit: glow - Decimals: 6 - Use metric prefix: false - Metrics - Blocks Per Second: 5.6 - Referenced Blocks Per Second: 4.8 - Referenced Rate: 85.71428571428571 - Features: [] - -Tips - Tip 1 Block Id: 0x05789c77904b4922004c04624aff85543442634044404ecec95c8498fcb95e49 - Tip 2 Block Id: 0x5d9a4d67d86c5e5fefcbb884850e3a4ed0cb8b546fe2beb36059a150726dcfb7 - Tip 3 Block Id: 0x7c6159ac6c6473ef1e36c4de298a6b77bbb84d0ad200cfdccca5ae9a396032e7 - Tip 4 Block Id: 0xd270eba03af6b1af34845c2eebcfa6be4be225d4e3875a32d6fa7b763b88bfb2 - -Submit Block: - Block Id 0x844c9f8c363123774739acfc6ff60bc20bb61a6ddc829c9af6d3c8ccf3525111 - -Get Block - Protocol Version: 2 - Parent 1 Block Id: 0x05789c77904b4922004c04624aff85543442634044404ecec95c8498fcb95e49 - Parent 2 Block Id: 0x5d9a4d67d86c5e5fefcbb884850e3a4ed0cb8b546fe2beb36059a150726dcfb7 - Parent 3 Block Id: 0x7c6159ac6c6473ef1e36c4de298a6b77bbb84d0ad200cfdccca5ae9a396032e7 - Parent 4 Block Id: 0xd270eba03af6b1af34845c2eebcfa6be4be225d4e3875a32d6fa7b763b88bfb2 - Tagged Data Payload - Tag: Foo - Data: Bar - Nonce: 15372286728091295777 - -Block Metadata - Block Id: 0x844c9f8c363123774739acfc6ff60bc20bb61a6ddc829c9af6d3c8ccf3525111 - Parent 1 Block Id: 0x05789c77904b4922004c04624aff85543442634044404ecec95c8498fcb95e49 - Parent 2 Block Id: 0x5d9a4d67d86c5e5fefcbb884850e3a4ed0cb8b546fe2beb36059a150726dcfb7 - Parent 3 Block Id: 0x7c6159ac6c6473ef1e36c4de298a6b77bbb84d0ad200cfdccca5ae9a396032e7 - Parent 4 Block Id: 0xd270eba03af6b1af34845c2eebcfa6be4be225d4e3875a32d6fa7b763b88bfb2 - Is Solid: true - Ledger Inclusion State: - Should Promote: false - Should Reattach: false - -Block Raw - Raw: 0x020405789c77904b4922004c04624aff85543442634044404ecec95c8498fcb95e495d9a4d67d86c5e5fefcbb884850e3a4ed0cb8b546fe2beb36059a150726dcfb77c6159ac6c6473ef1e36c4de298a6b77bbb84d0ad200cfdccca5ae9a396032e7d270eba03af6b1af34845c2eebcfa6be4be225d4e3875a32d6fa7b763b88bfb20f0000000500000003466f6f0300000042617221605555555555d5 - -Block Decoded - Protocol Version: 2 - Parent 1 Block Id: 0x05789c77904b4922004c04624aff85543442634044404ecec95c8498fcb95e49 - Parent 2 Block Id: 0x5d9a4d67d86c5e5fefcbb884850e3a4ed0cb8b546fe2beb36059a150726dcfb7 - Parent 3 Block Id: 0x7c6159ac6c6473ef1e36c4de298a6b77bbb84d0ad200cfdccca5ae9a396032e7 - Parent 4 Block Id: 0xd270eba03af6b1af34845c2eebcfa6be4be225d4e3875a32d6fa7b763b88bfb2 - Tagged Data Payload - Tag: Foo - Data: Bar - Nonce: 15372286728091295777 - -Latest Milestone Payload - Milestone Index: 54851 - Included Merkel Root 0xb46f508b2dcd240cbc927453eeae3e7f800a9a0f8e0415ce577acea50da039cf - Applied Merkel Root 0x0e5751c026e543b2e8ab2eb06099daa1d1e5df47778f7787faab45cdf12fe3a8 - Previous Milestone Id: 0x5432f5761fdb156e14add8227ae7c48085011ca2097679e08e4d33fa2e34379d - Timestamp: 1657543301 - -Output - Block Id: 0x0000000000000000000000000000000000000000000000000000000000000000 - Transaction Id: 0x0000000000000000000000000000000000000000000000000000000000000000 - Output Index: 0 - Is Spent: true - Basic Output - Amount: 2779530283277761 - Native Tokens - Unlock Conditions - Address Unlock Condition - Ed25519 Address - Public Key Hash: 0x3845105b59429361a75b3203a6e24e16d19540aad6bd1936449b62f1c4bbe5da - Features - -Done -``` - -## Troubleshooting - -If you are getting the following error, it means your local Proof of Work is taking too long to finish. By the time it -finishes the _parent blocks_ are no longer valid. You can use [simple connection](simple.mdx) how-to that showcases the -functionalities as this example. - -```bash -Error: invalid parameter, error: block is below max depth: invalid block: code=400, message=invalid parameter -``` diff --git a/docs/build/iota.js/2.0-rc.1/docs/how_tos/data.mdx b/docs/build/iota.js/2.0-rc.1/docs/how_tos/data.mdx deleted file mode 100644 index a6992ac11ca..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/how_tos/data.mdx +++ /dev/null @@ -1,119 +0,0 @@ ---- -description: 'Learn how to send and retrieve data using the iota.js client library.' -image: /img/client_banner.png -keywords: - - how to - - example - - send data - - retrieve data - - bytes - - utf8 - - base64 - - binary ---- - -# Send and Retrieve Data - -## Example Code - -## Pre-requirements - -Before you can send data, you will need to: - -- [Connect to a Node](simple.mdx). -- [Convert data to bytes](#convert-data-to-bytes). - -### Convert Data to Bytes - -You can convert data to bytes by using the following functions from the [Converter](../references/util/classes/Converter.md) -class: - -- [Converter.utf8ToBytes(utf8)](../references/util/classes/Converter.md#utf8tobytes). -- [Converter.utf8ToBytes(binary)](../references/util/classes/Converter.md#binarytobytes). -- [Converter.base64ToBytes(base64)](../references/util/classes/Converter.md#base64tobytes). - -## Send Data - -You can use the [sendData(client, tag?, data?)](../references/client/api_ref.md#senddata) function to send data to a -[SingleNodeClient](../references/client/classes/SingleNodeClient.md). You will need to provide a `SingleNodeClient`, -and optionally a `tag` and `data` as bytes. - -## Retrieve Data - -You can use the [retrieveData(client, blockId)](../references/client/api_ref.md#retrievedata) function to retrieve data -from a [SingleNodeClient](../references/client/classes/SingleNodeClient.md). You will need to provide a -`SingleNodeClient` and a `blockId`. If successful, the function will return an object with the block's data. - -## Example Code - -```ts reference -https://github.com/iotaledger/iota.js/tree/feat/stardust/packages/iota/examples/data/src/index.ts -``` - -### Expected Output - -```plaintext -Sending Data -Received Block Id 0x655e3b59943252851f0d7c67cbc93a733e0950a08aa3291aac8e34e6f79334be -Sending Data -Received Block Id 0xea3d6be441d78d89782d45edc0466b26e8a5e8423851d60ce38fe97754b9406f -Sending Data -Received Block Id 0xa1691c3113cdf0e143034cf34c2a172c02c1b172a8f187203e4d177ee94fa1a5 -Sending Data -Received Block Id 0x708c4f1169269a78650ed592ef7268b7a16134240d4360ad177dbd82a2137a4f -Sending Data -Received Block Id 0x50f8804354485dc2b340d5da72cd3cf8df67e99ec0bac2d3b978b3f6d9c74be3 -Sending Data -Received Block Id 0x016ac0a64278b57e7bcb937b7c4ecd0f2869ab4ab25e46a4f9be34f65c215461 -Sending Data -Received Block Id 0x1c119d34aef307c3c90a5d8250bfebb7ab65ec5ca90533c0e38056d22f724e99 -Sending Data -Received Block Id 0xdecec0535c4b71554ad34e369bba6e2bf9a1591c779b008f0be7c8b47ea8f072 -Sending Data -Received Block Id 0x6072def2453c5ac99c54a450854eb3962e6c3a6eb8eb80863cff17f10b426034 -Sending Data -Received Block Id 0xdbc9ee326b86ce2dabd262a1054afde98ac0928b8665ae431efde3802783f487 - -Retrieving Data -Block - Tag: MY-DATA-TAG - Data: This is data 0 🚀 -Retrieving Data -Block - Tag: MY-DATA-TAG - Data: This is data 1 🚀 -Retrieving Data -Block - Tag: MY-DATA-TAG - Data: This is data 2 🚀 -Retrieving Data -Block - Tag: MY-DATA-TAG - Data: This is data 3 🚀 -Retrieving Data -Block - Tag: MY-DATA-TAG - Data: This is data 4 🚀 -Retrieving Data -Block - Tag: MY-DATA-TAG - Data: This is data 5 🚀 -Retrieving Data -Block - Tag: MY-DATA-TAG - Data: This is data 6 🚀 -Retrieving Data -Block - Tag: MY-DATA-TAG - Data: This is data 7 🚀 -Retrieving Data -Block - Tag: MY-DATA-TAG - Data: This is data 8 🚀 -Retrieving Data -Block - Tag: MY-DATA-TAG - Data: This is data 9 🚀 -Done - -``` diff --git a/docs/build/iota.js/2.0-rc.1/docs/how_tos/mint_nft.mdx b/docs/build/iota.js/2.0-rc.1/docs/how_tos/mint_nft.mdx deleted file mode 100644 index 77404887a4b..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/how_tos/mint_nft.mdx +++ /dev/null @@ -1,99 +0,0 @@ ---- -description: 'Learn how to mint NFTs with the iota.js client library.' -image: /img/client_banner.png -keywords: - - how to - - example - - nft - - min ---- - -# Mint an NFT - -## Pre-requirements - -Before you can mint an NFT, you will need to: - -- [Connect to a Node](simple.mdx). - -## Mint an NFT - -This [example](https://github.com/iotaledger/iota.js/tree/feat/stardust/packages/iota/examples/mint-nft) will connect to -a node you defined as the `API_ENDPOINT` constant. Afterwards, the example will request a Bech32 address, if you don't -have one the example will take care of generating it. - -### Create a Hot Wallet - -The example will later create a hot wallet and request funds from the -[faucet](https://faucet.alphanet.iotaledger.net/api/enqueue) defined as the `FAUCET` constant. - -### Create the Output - -Once the generated wallet has outputs to mint the NFT, it will define an -[INftOutput](../references/client/interfaces/INftOutput.md) object. The `amount` property is set to `0`, as you need to -calculate the required storage deposit using the -[TransactionHelper.getStorageDeposit(output, rentStructure)](../references/client/classes/TransactionHelper.md#getstoragedeposit) -function, which takes any of the allowed [OutputTypes](../references/client/api_ref.md#outputtypes). - -### Create the Transaction Essence - -Once you have created the [output](#create-the-output), you should create the -[ITransactionEssence](../references/client/interfaces/ITransactionEssence.md), which will include the `output`. The example will then use the -`ITransactionEssence` to generate the `essenceHash` using the -[TransactionHelper.getTransactionEssenceHash(essence)](../references/client/classes/TransactionHelper.md#gettransactionessencehash) -function. - -### Create the Transaction Payload - -With the [created the transaction essence](#create-the-transaction-essence), you are now able to create the -[ISignatureUnlock](../references/client/interfaces/ISignatureUnlock.md) which will be used to create the -[ITransactionPayload](../references/client/interfaces/ITransactionPayload.md). - -### Submit the Block - -Once you have [created the transaction payload](#create-the-transaction-payload), you can create the -[IBlock](../references/client/interfaces/IBlock.md) and submit it using the -[SingleNodeClient.blockSubmit(blockPartial)](../references/client/classes/SingleNodeClient.md#blocksubmit) function. - -## Example Code - -```ts reference -https://github.com/iotaledger/iota.js/tree/feat/stardust/packages/iota/examples/mint-nft/src/index.ts -``` - -### Expected Output - -```plaintext -Target address (Bech32 encoded) where to mint the NFT or leave empty and we will generate an address for you: -Target Address: - Seed cacc64919fd9b8b7990c8e8c579ed3e0269a101b3fa9186ae6b65edf865791ee - Address Ed25519 0xd6135c19e0f364ce3a6fe8e943a1c7ee921acb1d6a1226000e4a0345b61f5407 - Address Bech32 rms1qrtpxhqeurekfn36dl5wjsapclhfyxktr44pyfsqpe9qx3dkra2qwq3y5z4 -Sender Address: - Seed d4c0da7c0990e28036cba5807894aee23daa2ffabbfadcbfbc9ac639b2bf49c0 - Address Ed25519 0xea5b53136d6d423ed4679bfb7eb7e517d853992162b139d7eb5f69a61c6344af - Address Bech32 rms1qr49k5cnd4k5y0k5v7dlkl4hu5tas5uey93tzwwhad0knfsuvdz27rvts06 - Try # 1 : fetching basic output for address rms1qr49k5cnd4k5y0k5v7dlkl4hu5tas5uey93tzwwhad0knfsuvdz27rvts06 - Didn't find any, retrying soon... - Try # 2 : fetching basic output for address rms1qr49k5cnd4k5y0k5v7dlkl4hu5tas5uey93tzwwhad0knfsuvdz27rvts06 -OutputId: 0x5334dd8c3c3096285424bbd7ff7e5d4897bbf0cb110ecbba0f1315400384f7860000 -To be consumed output: { - type: 3, - amount: '1000000000', - unlockConditions: [ { type: 0, address: [Object] } ] -} -Input: { - type: 0, - transactionId: '0x5334dd8c3c3096285424bbd7ff7e5d4897bbf0cb110ecbba0f1315400384f786', - transactionOutputIndex: 0 -} -Required Storage Deposit of the NFT output: 270500 -Submitted blockId is: 0x510e56623975f19290445856f0c852b6504524741de58a50e77dd9cb2e9e09c5 -Check out the transaction at https://explorer.alphanet.iotaledger.net/alphanet/block/0x510e56623975f19290445856f0c852b6504524741de58a50e77dd9cb2e9e09c5 -Done -``` - -## Related How Tos - -You can explore the libraries NFT minting functionalities with the -[NFT collection code example](https://github.com/iotaledger/iota.js/tree/feat/stardust/packages/iota/examples/nft-collection). diff --git a/docs/build/iota.js/2.0-rc.1/docs/how_tos/peers.mdx b/docs/build/iota.js/2.0-rc.1/docs/how_tos/peers.mdx deleted file mode 100644 index 09d2855b5a4..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/how_tos/peers.mdx +++ /dev/null @@ -1,80 +0,0 @@ ---- -description: "Learn how to add, delete, retrieve and list your node's peers with the iota.js client library." -image: /img/client_banner.png -keywords: - - how to - - example - - peers - - manage - - create peer - - add peer - - delete peer - - retrieve peer - - retrieve peer list ---- - -# Manage Peers - -## Pre-requirements - -Before you can create add and retrieve peers, you will need to: - -- [Connect to a Node](simple.mdx). - -## Add Peers - -You can add peers using the -[SingleNodeClient.peerAdd(multiAddress, alias?)](../references/client/classes/SingleNodeClient.md#peeradd) function. -You will need to provide a `multiAddress` and, optionally, and alias. - -## Retrieve Peers - -You can retrieve a [SingleNodeClient's](../references/client/classes/SingleNodeClient.md#peeradd) peers using the -[SingleNodeClient.peers()](../references/client/classes/SingleNodeClient.md#peers) function. The `peers()` function -will return a list of [peers](../references/client/interfaces/IPeer.md). - -### Retrieve Peer Data - -Once you have [retrieved your node's peers](#retrieve-peers), you can use any of its -[properties](../references/client/interfaces/IPeer.md#properties) to retrieve the peer's data. - -## Delete Peers - -You can delete a [SingleNodeClient's](../references/client/classes/SingleNodeClient.md#peeradd) peer using the -[SingleNodeClient.peerDelete(peerId)](../references/client/classes/SingleNodeClient.md#peerdelete) function. You will -need to provide a valid `peerId`. - -## Example Code - -```ts reference -https://github.com/iotaledger/iota.js/tree/feat/stardust/packages/iota/examples/peers/src/index.ts -``` - -### Expected Output - -```plaintext -Peers - Id: 12D3KooWNSCD7hha6BTPw44XeeKXcrAPBUGnPAY55gvXPen6zEAk - Multi Address: ['/ip4/217.251.138.169/tcp/15600'] - Alias: undefined - Relation: autopeered - Connected: true - Gossip Heartbeat - Latest Milestone Index: 71452 - Pruned Milestone Index: 55600 - Solid Milestone Index: 71452 - Connected Peers: 3 - Synced Peers: 3 - Gossip Metrics - New Blocks: 4282 - Known Blocks: 6 - Received Blocks: 4291 - Received Block Requests: 0 - Received Milestone Requests: 1 - Received Hearbeats: 241 - Sent Blocks: 22 - Sent Block Requests: 6 - Sent Milestone Requests: 1 - Sent Heartbeats: 241 - Dropped Packets: 0 -``` diff --git a/docs/build/iota.js/2.0-rc.1/docs/how_tos/pow.mdx b/docs/build/iota.js/2.0-rc.1/docs/how_tos/pow.mdx deleted file mode 100644 index 0466a0c19c5..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/how_tos/pow.mdx +++ /dev/null @@ -1,73 +0,0 @@ ---- -description: 'Learn how to perform proof of work operations with the iota.js client library.' -image: /img/client_banner.png -keywords: - - how to - - example - - pow - - proof of work - - node pow - - neon pow - - wasm pow - - local pow ---- - -# Perform Proof of Work - -You can perform Proof of Work(POW) operations using the following functions : - -- [NeonPowProvider.pow(message, targetScore)](../references/pow-neon/classes/NeonPowProvider.md#pow). -- [NodePowProvider.pow(message, targetScore)](../references/pow-node/classes/NodePowProvider.md#pow). -- [WasmPowProvider.pow(message, targetScore)](../references/pow-wasm/classes/WasmPowProvider.md#pow). -- [LocalPow.pow(message, targetScore)](../references/client/classes/LocalPowProvider.md#pow). - -You will need to provide a `block` and a `targetScore` to any of these functions. If successful, they will return nonce. - -## Example Code - -```ts reference -https://github.com/iotaledger/iota.js/tree/feat/stardust/packages/iota/examples/pow/src/index.ts -``` - -### Expected Output - -```plaintext - -Neon Pow -Target Score 100 -Data Length 500 -Iterations 1 - Iteration 1 - Nonce 173109 - Score 118.098 -Average Time (s) 0.62 - -Node Pow -Target Score 100 -Data Length 500 -Iterations 1 - Iteration 1 - Nonce 173109 - Score 118.098 -Average Time (s) 27.11 - -Wasm Pow -Target Score 100 -Data Length 500 -Iterations 1 - Iteration 1 - Nonce 173109 - Score 118.098 -Average Time (s) 25.42 - -Local Pow -Target Score 100 -Data Length 500 -Iterations 1 - Iteration 1 - Nonce 173109 - Score 118.098 -Average Time (s) 24.54 - -Done -``` diff --git a/docs/build/iota.js/2.0-rc.1/docs/how_tos/run_how_tos.mdx b/docs/build/iota.js/2.0-rc.1/docs/how_tos/run_how_tos.mdx deleted file mode 100644 index 9c04a096603..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/how_tos/run_how_tos.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -description: "Learn how to run the iota.js client library's how tos and examples." -image: /img/client_banner.png -keywords: - - how to - - example - - run examples - - run how tos ---- - -# Run Code Examples - -1. Clone the project by running the following command: - -```bash -git clone git@github.com:iotaledger/iota.js.git -``` - -2. Change directory into the project by running the following command: - -```bash -cd iota.js -``` - -3. Check out the [`feat/stardust`](https://github.com/iotaledger/iota.js/tree/feat/stardust) branch by running the - following command: - -```bash -git checkout feat/stardust -``` - -4. Install the packages dependencies by running: - -```bash -npm install -``` - -5. The Iota package examples make use of the other [packages](../getting_started.mdx#additional-packages) included in this - repository. You can run the following commands to set up all of them: - -```bash -npm run dist-neon -npm run dist-all -``` - -5. Change the directory to the desired how-to. For instance, the following command will change into the - [How To Create a Simple Connection](simple.mdx) article: - -```bash -cd packages/iota/examples/simple/ -``` - -6. You can now run the example by running the following command: - -```bash -npm run start -``` diff --git a/docs/build/iota.js/2.0-rc.1/docs/how_tos/simple.mdx b/docs/build/iota.js/2.0-rc.1/docs/how_tos/simple.mdx deleted file mode 100644 index a697bb42f60..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/how_tos/simple.mdx +++ /dev/null @@ -1,196 +0,0 @@ ---- -description: 'Learn how to connect to your node and list its properties using the iota.js client library.' -image: /img/client_banner.png -keywords: - - how to - - example - - simple connection - - get node properties - - get milestone - - get outputs - - get peers - - get block - - block metadata - - get output properties ---- - -# Connect to a Node - -## Instantiate a SimpleNodeClient - -You can instantiate a [SimpleNodeClient](../references/client/classes/SingleNodeClient.md) using its -[constructor](../references/client/classes/SingleNodeClient.md#constructor). You will need to provide a valid -`API_ENDPOINT`, and can also use the -[SingleNodeClientOptions](../references/client/interfaces/SingleNodeClientOptions.md). - -### Get the SimpleNodeClient's Properties - -Once you have [instantiated the SingleNodeClient](#instantiate-a-simplenodeclient), you can retrieve its properties by -using the class's [functions](../references/client/classes/SingleNodeClient.md#methods-1). The example uses the following: - -- [SingleNodeClient.health()](../references/client/classes/SingleNodeClient.md#health) -- [SingleNodeClient.info()](../references/client/classes/SingleNodeClient.md#info) -- [SingleNodeClient.tips()](../references/client/classes/SingleNodeClient.md#tips) - -## Submit a Block - -Once you have [instantiated the SingleNodeClient](#instantiate-a-simplenodeclient), you can create and submit a new -block using the [SingleNodeClient.nodeSubmit()](../references/client/classes/SingleNodeClient.md#blocksubmit) function. To -do so, you will first need to create a [submitBlock](../references/client/classes/SingleNodeClient.md#blocksubmit) as shown -in the example. - -## Retrieve a Block - -You can use the [SingleNodeClient.block(blockId)](../references/client/classes/SingleNodeClient.md#block) function to retrieve -a block using its `blockId`. If successful, the function will return a -[block](../references/client/interfaces/IClient.md). - -## Retrieve a Block's Metadata - -You can use the [SingleNodeClient.blockMetadata(blockId)](../references/client/classes/SingleNodeClient.md#blockmetadata) function to retrieve -a block's metadata using its `blockId`. If successful, the function will return a -[IBlockMetadata](../references/client/interfaces/IBlockMetadata.md). - -## Retrieve a Raw Block - -You can use the [SingleNodeClient.blockRaw(blockId)](../references/client/classes/SingleNodeClient.md#blockraw) function to retrieve -a raw block using its `blockId`. If successful, the function will return the block's raw data which you can convert to -Hex using the [Converter.bytesToHex()](../references/util/classes/Converter.md#bytestohex) function, or decode using the -[ReadStream(blockRaw)](../references/util/classes/ReadStream.md) class. - -## Retrieve a Milestone - -You can retrieve a milestone using the -[SingleNodeClient.milestoneByIndex(index)](../references/client/classes/SingleNodeClient.md#milestonebyindex) function. The -function will return a [IMilestonePayload](../references/client/interfaces/IMilestonePayload.md) if successful. - -### Retrieve a Milestone's Properties - -Once you have [retrieved a milestone](#retrieve-a-milestone), you can retrieve any of its -[properties](../references/client/interfaces/IMilestonePayload.md#properties-1), as shown in the example. - -## Retrieve an Output - -You can retrieve an output using the -[SingleNodeClient.output(outputId)](../references/client/classes/SingleNodeClient.md#output) function. The -function will return a [IMilestonePayload](../references/client/interfaces/IOutputResponse.md) if successful. - -### Retrieve an Output's Properties - -Once you have [retrieved a output](#retrieve-an-output), you can retrieve any of its -[properties](../references/client/interfaces/IOutputResponse.md#properties-1), as shown in the example. - -## Example Code - -```ts reference -https://github.com/iotaledger/iota.js/tree/feat/stardust/packages/iota/examples/simple/src/index.ts -``` - -### Expected Output - -```plaintext -Is the node healthy Yes - -Node Info - Name: HORNET - Version: 2.0.0-alpha.23 - Status - Is Healthy: true - Latest Milestone Index: 54851 - Latest Milestone Timestamp: 1657543301 - Latest Milestone Id: 0x49fe39afe197426e085fc5ce61ba2168307075d13b0b311407654d09532f7efa - Confirmed Milestone Index: 54851 - Confirmed Milestone Timestamp: 1657543301 - Confirmed Milestone Id: 0x49fe39afe197426e085fc5ce61ba2168307075d13b0b311407654d09532f7efa - Pruning Index: 0 - Protocol - Network Name: alphanet-8 - Bech32 HRP: rms - Token supply: 2779530283277761 - Protocol version: - Min PoW Score: 1000 - Rent - VByte Cost: 500 - VByte Factor Data: 1 - VByte Factor Key: 10 - Base token - Name: Shimmer - Ticker Symbol: SMR - Unit: SMR - Sub unit: glow - Decimals: 6 - Use metric prefix: false - Metrics - Blocks Per Second: 5.6 - Referenced Blocks Per Second: 4.8 - Referenced Rate: 85.71428571428571 - Features: [] - -Tips - Tip 1 Block Id: 0x05789c77904b4922004c04624aff85543442634044404ecec95c8498fcb95e49 - Tip 2 Block Id: 0x5d9a4d67d86c5e5fefcbb884850e3a4ed0cb8b546fe2beb36059a150726dcfb7 - Tip 3 Block Id: 0x7c6159ac6c6473ef1e36c4de298a6b77bbb84d0ad200cfdccca5ae9a396032e7 - Tip 4 Block Id: 0xd270eba03af6b1af34845c2eebcfa6be4be225d4e3875a32d6fa7b763b88bfb2 - -Submit Block: - Block Id 0x844c9f8c363123774739acfc6ff60bc20bb61a6ddc829c9af6d3c8ccf3525111 - -Get Block - Protocol Version: 2 - Parent 1 Block Id: 0x05789c77904b4922004c04624aff85543442634044404ecec95c8498fcb95e49 - Parent 2 Block Id: 0x5d9a4d67d86c5e5fefcbb884850e3a4ed0cb8b546fe2beb36059a150726dcfb7 - Parent 3 Block Id: 0x7c6159ac6c6473ef1e36c4de298a6b77bbb84d0ad200cfdccca5ae9a396032e7 - Parent 4 Block Id: 0xd270eba03af6b1af34845c2eebcfa6be4be225d4e3875a32d6fa7b763b88bfb2 - Tagged Data Payload - Tag: Foo - Data: Bar - Nonce: 15372286728091295777 - -Block Metadata - Block Id: 0x844c9f8c363123774739acfc6ff60bc20bb61a6ddc829c9af6d3c8ccf3525111 - Parent 1 Block Id: 0x05789c77904b4922004c04624aff85543442634044404ecec95c8498fcb95e49 - Parent 2 Block Id: 0x5d9a4d67d86c5e5fefcbb884850e3a4ed0cb8b546fe2beb36059a150726dcfb7 - Parent 3 Block Id: 0x7c6159ac6c6473ef1e36c4de298a6b77bbb84d0ad200cfdccca5ae9a396032e7 - Parent 4 Block Id: 0xd270eba03af6b1af34845c2eebcfa6be4be225d4e3875a32d6fa7b763b88bfb2 - Is Solid: true - Ledger Inclusion State: - Should Promote: false - Should Reattach: false - -Block Raw - Raw: 0x020405789c77904b4922004c04624aff85543442634044404ecec95c8498fcb95e495d9a4d67d86c5e5fefcbb884850e3a4ed0cb8b546fe2beb36059a150726dcfb77c6159ac6c6473ef1e36c4de298a6b77bbb84d0ad200cfdccca5ae9a396032e7d270eba03af6b1af34845c2eebcfa6be4be225d4e3875a32d6fa7b763b88bfb20f0000000500000003466f6f0300000042617221605555555555d5 - -Block Decoded - Protocol Version: 2 - Parent 1 Block Id: 0x05789c77904b4922004c04624aff85543442634044404ecec95c8498fcb95e49 - Parent 2 Block Id: 0x5d9a4d67d86c5e5fefcbb884850e3a4ed0cb8b546fe2beb36059a150726dcfb7 - Parent 3 Block Id: 0x7c6159ac6c6473ef1e36c4de298a6b77bbb84d0ad200cfdccca5ae9a396032e7 - Parent 4 Block Id: 0xd270eba03af6b1af34845c2eebcfa6be4be225d4e3875a32d6fa7b763b88bfb2 - Tagged Data Payload - Tag: Foo - Data: Bar - Nonce: 15372286728091295777 - -Latest Milestone Payload - Milestone Index: 54851 - Included Merkel Root 0xb46f508b2dcd240cbc927453eeae3e7f800a9a0f8e0415ce577acea50da039cf - Applied Merkel Root 0x0e5751c026e543b2e8ab2eb06099daa1d1e5df47778f7787faab45cdf12fe3a8 - Previous Milestone Id: 0x5432f5761fdb156e14add8227ae7c48085011ca2097679e08e4d33fa2e34379d - Timestamp: 1657543301 - -Output - Block Id: 0x0000000000000000000000000000000000000000000000000000000000000000 - Transaction Id: 0x0000000000000000000000000000000000000000000000000000000000000000 - Output Index: 0 - Is Spent: true - Basic Output - Amount: 2779530283277761 - Native Tokens - Unlock Conditions - Address Unlock Condition - Ed25519 Address - Public Key Hash: 0x3845105b59429361a75b3203a6e24e16d19540aad6bd1936449b62f1c4bbe5da - Features - -Done -``` diff --git a/docs/build/iota.js/2.0-rc.1/docs/how_tos/transaction.mdx b/docs/build/iota.js/2.0-rc.1/docs/how_tos/transaction.mdx deleted file mode 100644 index 6aad646f2b0..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/how_tos/transaction.mdx +++ /dev/null @@ -1,95 +0,0 @@ ---- -description: 'Learn how to request funds and send transactions using the iota.js client library.' -image: /img/client_banner.png -keywords: - - how to - - example - - tokens - - value transactions - - request funds - - faucet - - send transaction - - retrieve transaction ---- - -# Send a Transaction - -## Pre-requirements - -Before you can create a transaction, you will need to: - -- [Connect to a Node](simple.mdx). -- [Generate a seed](address.mdx#generate-a-seed). -- [Create an address](address.mdx#create-an-address). -- [Create a wallet](#create-a-walllet). -- [Request funds](#request-funds). -- [Fetch basic outputs](#fetch-basic-outputs). - -### Create a Wallet - -#### Create a wallet seed - -You can create a wallet seed by instantiating an [Ed25519Seed](../references/client/classes/Ed25519Seed.md) using its constructor. -You will need to provide `secretBytes` to the constructor, which you can get by using the [Converter.hexToBytes(hex)](../references/util/classes/Converter.md#hextobytes) function. - -#### Retrieve the wallet's address - -Once you have [created your wallet seed](#create-a-wallet-seed), you can use it - -Once you have [generated a seed](#generate-a-seed), you can create a wallet using the [Ed25519Address.toAddress()](../references/client/classes/Ed25519Address.md#toaddress) fucntion. - -### Request Funds - -Before you can send the transaction, you will need to request funds. If you are on the alphanet, you can request test -funds from the [faucet](https://faucet.alphanet.iotaledger.net/api/enqueue). - -## Send the Transaction - -Once you have fulfilled the [pre-requirements](#pre-requirements), you can send the transaction using either the [sendAdvanced(client, inputsAndSignatureKeyPairs, outputs, taggedData?)](../references/client/api_ref.md#sendadvanced) function, which will return the created block's id, or the [send(client, seed, accountIndex, addressBech32, amount, taggedData?, addressOptions?)](../references/client/api_ref.md#send) function, which will return the created block's id, as well as the constructed blocks. - -As this example uses a genesis address, it must use the `(client, inputsAndSignatureKeyPairs, outputs, taggedData?)` function. However, if you are doing a wallet to wallet transfer, you can use the `send(client, seed, accountIndex, addressBech32, amount, taggedData?, addressOptions?)` method. - -## Example Code - -```ts reference -https://github.com/iotaledger/iota.js/tree/feat/stardust/packages/iota/examples/transaction/src/index.ts -``` - -### Expected Output - -```plaintext -Genesis - Seed bd80f079560f25b35ab6a5f95e31e57e1f549f81140d1d28884037dc9fa6ed10 - Address Ed25519 0xd49b2cf7f727faf9cad957d14d7f13993c10010f43b0c2a5de72b728b9d01835 - Address Bech32 rms1qr2fkt8h7unl47w2m9tazntlzwvncyqppapmps49meetw29e6qvr2wrxcz6 -Wallet 1 - Seed: e57fb750f3a3a67969ece5bd9ae7eef5b2256a818b2aac458941f7274985a410 - Path: m/44'/4218'/0'/0'/0' - Address Ed25519 m/44'/4218'/0'/0'/0': 0x515582fe648b0f10a2b2a1b91d7502190c979baabfee85b6bbb5020692e55d16 - Address Bech32 m/44'/4218'/0'/0'/0': rms1qpg4tqh7vj9s7y9zk2smj8t4qgvse9um42l7apdkhw6syp5ju4w3vajenuh -genesisFunds: { - address: 'rms1qr2fkt8h7unl47w2m9tazntlzwvncyqppapmps49meetw29e6qvr2wrxcz6', - waitingRequests: 1 -} - Try # 1 : fetching basic output for address rms1qr2fkt8h7unl47w2m9tazntlzwvncyqppapmps49meetw29e6qvr2wrxcz6 - Didn't find any, retrying soon... - Try # 2 : fetching basic output for address rms1qr2fkt8h7unl47w2m9tazntlzwvncyqppapmps49meetw29e6qvr2wrxcz6 - Didn't find any, retrying soon... - Try # 3 : fetching basic output for address rms1qr2fkt8h7unl47w2m9tazntlzwvncyqppapmps49meetw29e6qvr2wrxcz6 -inputsWithKeyPairs: [{"input":{"type":0,"transactionId":"0xab9c00cf096a80b8414dacb78f256d6604d968621533ca5a314c690392d5bd3d","transactionOutputIndex":0},"addressKeyPair":{"publicKey":{"0":133,"1":225,"2":45,"3":246,"4":113,"5":97,"6":179,"7":226,"8":184,"9":195,"10":212,"11":50,"12":205,"13":196,"14":138,"15":221,"16":95,"17":3,"18":229,"19":242,"20":69,"21":223,"22":2,"23":212,"24":169,"25":203,"26":248,"27":141,"28":222,"29":162,"30":252,"31":176},"privateKey":{"0":189,"1":128,"2":240,"3":121,"4":86,"5":15,"6":37,"7":179,"8":90,"9":182,"10":165,"11":249,"12":94,"13":49,"14":229,"15":126,"16":31,"17":84,"18":159,"19":129,"20":20,"21":13,"22":29,"23":40,"24":136,"25":64,"26":55,"27":220,"28":159,"29":166,"30":237,"31":16,"32":133,"33":225,"34":45,"35":246,"36":113,"37":97,"38":179,"39":226,"40":184,"41":195,"42":212,"43":50,"44":205,"45":196,"46":138,"47":221,"48":95,"49":3,"50":229,"51":242,"52":69,"53":223,"54":2,"55":212,"56":169,"57":203,"58":248,"59":141,"60":222,"61":162,"62":252,"63":176}},"consumingOutput":{"type":3,"amount":"1000000000","unlockConditions":[{"type":0,"address":{"type":0,"pubKeyHash":"0xd49b2cf7f727faf9cad957d14d7f13993c10010f43b0c2a5de72b728b9d01835"}}]}}] -Created Block Id 0xa48c85b745e964d66ca48912a88faab7c86c7662a2993a488239377f2dc07728 -Wallet 1 Address Balance Integer { value: 1010000000n } -Wallet 1 First Unspent Address { - address: 'rms1qpg4tqh7vj9s7y9zk2smj8t4qgvse9um42l7apdkhw6syp5ju4w3vajenuh', - path: "m/44'/4218'/0'/0'/0'", - balance: Integer { value: 1020000000n } -} -Wallet 1 Unspent Addresses [ - { - address: 'rms1qpg4tqh7vj9s7y9zk2smj8t4qgvse9um42l7apdkhw6syp5ju4w3vajenuh', - path: "m/44'/4218'/0'/0'/0'", - balance: Integer { value: 1020000000n } - } -] -Done -``` diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/.keep b/docs/build/iota.js/2.0-rc.1/docs/references/.keep deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/api_ref.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/api_ref.md deleted file mode 100644 index 5d7cbc7b2f2..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/api_ref.md +++ /dev/null @@ -1,4493 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# @iota/iota.js - -## Table of contents - -### Classes - -- [Ed25519Address](classes/Ed25519Address.md) -- [ClientError](classes/ClientError.md) -- [IndexerPluginClient](classes/IndexerPluginClient.md) -- [SingleNodeClient](classes/SingleNodeClient.md) -- [B1T6](classes/B1T6.md) -- [LocalPowProvider](classes/LocalPowProvider.md) -- [Ed25519Seed](classes/Ed25519Seed.md) -- [Bech32Helper](classes/Bech32Helper.md) -- [PowHelper](classes/PowHelper.md) -- [TransactionHelper](classes/TransactionHelper.md) -- [UnitsHelper](classes/UnitsHelper.md) - -### Variables - -- [MIN_ADDRESS_LENGTH](api_ref.md#min_address_length) -- [ALIAS_ID_LENGTH](api_ref.md#alias_id_length) -- [MIN_ALIAS_ADDRESS_LENGTH](api_ref.md#min_alias_address_length) -- [MIN_ED25519_ADDRESS_LENGTH](api_ref.md#min_ed25519_address_length) -- [NFT_ID_LENGTH](api_ref.md#nft_id_length) -- [MIN_NFT_ADDRESS_LENGTH](api_ref.md#min_nft_address_length) -- [MAX_BLOCK_LENGTH](api_ref.md#max_block_length) -- [MAX_NUMBER_PARENTS](api_ref.md#max_number_parents) -- [MIN_NUMBER_PARENTS](api_ref.md#min_number_parents) -- [UINT8_SIZE](api_ref.md#uint8_size) -- [UINT16_SIZE](api_ref.md#uint16_size) -- [UINT32_SIZE](api_ref.md#uint32_size) -- [UINT64_SIZE](api_ref.md#uint64_size) -- [UINT256_SIZE](api_ref.md#uint256_size) -- [BLOCK_ID_LENGTH](api_ref.md#block_id_length) -- [TRANSACTION_ID_LENGTH](api_ref.md#transaction_id_length) -- [MERKLE_PROOF_LENGTH](api_ref.md#merkle_proof_length) -- [TYPE_LENGTH](api_ref.md#type_length) -- [SMALL_TYPE_LENGTH](api_ref.md#small_type_length) -- [STRING_LENGTH](api_ref.md#string_length) -- [ARRAY_LENGTH](api_ref.md#array_length) -- [MIN_FEATURES_LENGTH](api_ref.md#min_features_length) -- [MIN_FEATURE_LENGTH](api_ref.md#min_feature_length) -- [MIN_ISSUER_FEATURE_LENGTH](api_ref.md#min_issuer_feature_length) -- [MIN_METADATA_FEATURE_LENGTH](api_ref.md#min_metadata_feature_length) -- [MIN_SENDER_FEATURE_LENGTH](api_ref.md#min_sender_feature_length) -- [MIN_TAG_FEATURE_LENGTH](api_ref.md#min_tag_feature_length) -- [TAIL_HASH_LENGTH](api_ref.md#tail_hash_length) -- [MIN_MIGRATED_FUNDS_LENGTH](api_ref.md#min_migrated_funds_length) -- [MAX_FUNDS_COUNT](api_ref.md#max_funds_count) -- [MIN_INPUT_LENGTH](api_ref.md#min_input_length) -- [MIN_INPUT_COUNT](api_ref.md#min_input_count) -- [MAX_INPUT_COUNT](api_ref.md#max_input_count) -- [MIN_TREASURY_INPUT_LENGTH](api_ref.md#min_treasury_input_length) -- [MIN_UTXO_INPUT_LENGTH](api_ref.md#min_utxo_input_length) -- [MIN_MILESTONE_OPTION_LENGTH](api_ref.md#min_milestone_option_length) -- [MIN_PROTOCOL_PARAMS_MILESTONE_OPTION_LENGTH](api_ref.md#min_protocol_params_milestone_option_length) -- [MIN_RECEIPT_MILESTONE_OPTION_LENGTH](api_ref.md#min_receipt_milestone_option_length) -- [MIN_ALIAS_OUTPUT_LENGTH](api_ref.md#min_alias_output_length) -- [MIN_BASIC_OUTPUT_LENGTH](api_ref.md#min_basic_output_length) -- [MIN_FOUNDRY_OUTPUT_LENGTH](api_ref.md#min_foundry_output_length) -- [MIN_NFT_OUTPUT_LENGTH](api_ref.md#min_nft_output_length) -- [MIN_OUTPUT_LENGTH](api_ref.md#min_output_length) -- [MIN_OUTPUT_COUNT](api_ref.md#min_output_count) -- [MAX_OUTPUT_COUNT](api_ref.md#max_output_count) -- [MIN_TREASURY_OUTPUT_LENGTH](api_ref.md#min_treasury_output_length) -- [MIN_MILESTONE_PAYLOAD_LENGTH](api_ref.md#min_milestone_payload_length) -- [MIN_PAYLOAD_LENGTH](api_ref.md#min_payload_length) -- [MIN_TAGGED_DATA_PAYLOAD_LENGTH](api_ref.md#min_tagged_data_payload_length) -- [MAX_TAG_LENGTH](api_ref.md#max_tag_length) -- [MIN_TRANSACTION_PAYLOAD_LENGTH](api_ref.md#min_transaction_payload_length) -- [MIN_TREASURY_TRANSACTION_PAYLOAD_LENGTH](api_ref.md#min_treasury_transaction_payload_length) -- [MIN_ED25519_SIGNATURE_LENGTH](api_ref.md#min_ed25519_signature_length) -- [MIN_SIGNATURE_LENGTH](api_ref.md#min_signature_length) -- [MIN_SIMPLE_TOKEN_SCHEME_LENGTH](api_ref.md#min_simple_token_scheme_length) -- [MIN_TOKEN_SCHEME_LENGTH](api_ref.md#min_token_scheme_length) -- [MIN_TRANSACTION_ESSENCE_LENGTH](api_ref.md#min_transaction_essence_length) -- [MIN_ADDRESS_UNLOCK_CONDITION_LENGTH](api_ref.md#min_address_unlock_condition_length) -- [MIN_EXPIRATION_UNLOCK_CONDITION_LENGTH](api_ref.md#min_expiration_unlock_condition_length) -- [MIN_GOVERNOR_ADDRESS_UNLOCK_CONDITION_LENGTH](api_ref.md#min_governor_address_unlock_condition_length) -- [MIN_IMMUTABLE_ALIAS_UNLOCK_CONDITION_LENGTH](api_ref.md#min_immutable_alias_unlock_condition_length) -- [MIN_STATE_CONTROLLER_ADDRESS_UNLOCK_CONDITION_LENGTH](api_ref.md#min_state_controller_address_unlock_condition_length) -- [MIN_STORAGE_DEPOSIT_RETURN_UNLOCK_CONDITION_LENGTH](api_ref.md#min_storage_deposit_return_unlock_condition_length) -- [MIN_TIMELOCK_UNLOCK_CONDITION_LENGTH](api_ref.md#min_timelock_unlock_condition_length) -- [MIN_UNLOCK_CONDITIONS_LENGTH](api_ref.md#min_unlock_conditions_length) -- [MIN_UNLOCK_CONDITION_LENGTH](api_ref.md#min_unlock_condition_length) -- [MIN_ALIAS_UNLOCK_LENGTH](api_ref.md#min_alias_unlock_length) -- [MIN_NFT_UNLOCK_LENGTH](api_ref.md#min_nft_unlock_length) -- [MIN_REFERENCE_UNLOCK_LENGTH](api_ref.md#min_reference_unlock_length) -- [MIN_SIGNATURE_UNLOCK_LENGTH](api_ref.md#min_signature_unlock_length) -- [MIN_UNLOCK_LENGTH](api_ref.md#min_unlock_length) -- [DEFAULT_PROTOCOL_VERSION](api_ref.md#default_protocol_version) -- [TRANSACTION_ESSENCE_TYPE](api_ref.md#transaction_essence_type) -- [INPUTS_COMMITMENT_SIZE](api_ref.md#inputs_commitment_size) -- [ALIAS_ADDRESS_TYPE](api_ref.md#alias_address_type) -- [ED25519_ADDRESS_TYPE](api_ref.md#ed25519_address_type) -- [NFT_ADDRESS_TYPE](api_ref.md#nft_address_type) -- [ISSUER_FEATURE_TYPE](api_ref.md#issuer_feature_type) -- [METADATA_FEATURE_TYPE](api_ref.md#metadata_feature_type) -- [SENDER_FEATURE_TYPE](api_ref.md#sender_feature_type) -- [TAG_FEATURE_TYPE](api_ref.md#tag_feature_type) -- [TREASURY_INPUT_TYPE](api_ref.md#treasury_input_type) -- [UTXO_INPUT_TYPE](api_ref.md#utxo_input_type) -- [PROTOCOL_PARAMETERS_MILESTONE_OPTION_TYPE](api_ref.md#protocol_parameters_milestone_option_type) -- [RECEIPT_MILESTONE_OPTION_TYPE](api_ref.md#receipt_milestone_option_type) -- [ALIAS_OUTPUT_TYPE](api_ref.md#alias_output_type) -- [BASIC_OUTPUT_TYPE](api_ref.md#basic_output_type) -- [FOUNDRY_OUTPUT_TYPE](api_ref.md#foundry_output_type) -- [NFT_OUTPUT_TYPE](api_ref.md#nft_output_type) -- [TREASURY_OUTPUT_TYPE](api_ref.md#treasury_output_type) -- [MILESTONE_PAYLOAD_TYPE](api_ref.md#milestone_payload_type) -- [TAGGED_DATA_PAYLOAD_TYPE](api_ref.md#tagged_data_payload_type) -- [TRANSACTION_PAYLOAD_TYPE](api_ref.md#transaction_payload_type) -- [TREASURY_TRANSACTION_PAYLOAD_TYPE](api_ref.md#treasury_transaction_payload_type) -- [ED25519_SIGNATURE_TYPE](api_ref.md#ed25519_signature_type) -- [SIMPLE_TOKEN_SCHEME_TYPE](api_ref.md#simple_token_scheme_type) -- [ADDRESS_UNLOCK_CONDITION_TYPE](api_ref.md#address_unlock_condition_type) -- [EXPIRATION_UNLOCK_CONDITION_TYPE](api_ref.md#expiration_unlock_condition_type) -- [GOVERNOR_ADDRESS_UNLOCK_CONDITION_TYPE](api_ref.md#governor_address_unlock_condition_type) -- [IMMUTABLE_ALIAS_UNLOCK_CONDITION_TYPE](api_ref.md#immutable_alias_unlock_condition_type) -- [STATE_CONTROLLER_ADDRESS_UNLOCK_CONDITION_TYPE](api_ref.md#state_controller_address_unlock_condition_type) -- [STORAGE_DEPOSIT_RETURN_UNLOCK_CONDITION_TYPE](api_ref.md#storage_deposit_return_unlock_condition_type) -- [TIMELOCK_UNLOCK_CONDITION_TYPE](api_ref.md#timelock_unlock_condition_type) -- [ALIAS_UNLOCK_TYPE](api_ref.md#alias_unlock_type) -- [NFT_UNLOCK_TYPE](api_ref.md#nft_unlock_type) -- [REFERENCE_UNLOCK_TYPE](api_ref.md#reference_unlock_type) -- [SIGNATURE_UNLOCK_TYPE](api_ref.md#signature_unlock_type) -- [CONFLICT_REASON_STRINGS](api_ref.md#conflict_reason_strings) -- [ED25519_SEED_TYPE](api_ref.md#ed25519_seed_type) - -### Functions - -- [deserializeAddress](api_ref.md#deserializeaddress) -- [serializeAddress](api_ref.md#serializeaddress) -- [deserializeAliasAddress](api_ref.md#deserializealiasaddress) -- [serializeAliasAddress](api_ref.md#serializealiasaddress) -- [deserializeEd25519Address](api_ref.md#deserializeed25519address) -- [serializeEd25519Address](api_ref.md#serializeed25519address) -- [deserializeNftAddress](api_ref.md#deserializenftaddress) -- [serializeNftAddress](api_ref.md#serializenftaddress) -- [deserializeBlock](api_ref.md#deserializeblock) -- [serializeBlock](api_ref.md#serializeblock) -- [deserializeFeatures](api_ref.md#deserializefeatures) -- [serializeFeatures](api_ref.md#serializefeatures) -- [deserializeFeature](api_ref.md#deserializefeature) -- [serializeFeature](api_ref.md#serializefeature) -- [deserializeIssuerFeature](api_ref.md#deserializeissuerfeature) -- [serializeIssuerFeature](api_ref.md#serializeissuerfeature) -- [deserializeMetadataFeature](api_ref.md#deserializemetadatafeature) -- [serializeMetadataFeature](api_ref.md#serializemetadatafeature) -- [deserializeSenderFeature](api_ref.md#deserializesenderfeature) -- [serializeSenderFeature](api_ref.md#serializesenderfeature) -- [deserializeTagFeature](api_ref.md#deserializetagfeature) -- [serializeTagFeature](api_ref.md#serializetagfeature) -- [deserializeFunds](api_ref.md#deserializefunds) -- [serializeFunds](api_ref.md#serializefunds) -- [deserializeMigratedFunds](api_ref.md#deserializemigratedfunds) -- [serializeMigratedFunds](api_ref.md#serializemigratedfunds) -- [deserializeInputs](api_ref.md#deserializeinputs) -- [serializeInputs](api_ref.md#serializeinputs) -- [deserializeInput](api_ref.md#deserializeinput) -- [serializeInput](api_ref.md#serializeinput) -- [deserializeTreasuryInput](api_ref.md#deserializetreasuryinput) -- [serializeTreasuryInput](api_ref.md#serializetreasuryinput) -- [deserializeUTXOInput](api_ref.md#deserializeutxoinput) -- [serializeUTXOInput](api_ref.md#serializeutxoinput) -- [deserializeMilestoneOptions](api_ref.md#deserializemilestoneoptions) -- [serializeMilestoneOptions](api_ref.md#serializemilestoneoptions) -- [deserializeMilestoneOption](api_ref.md#deserializemilestoneoption) -- [serializeMilestoneOption](api_ref.md#serializemilestoneoption) -- [deserializeProtocolParamsMilestoneOption](api_ref.md#deserializeprotocolparamsmilestoneoption) -- [serializeProtocolParamsMilestoneOption](api_ref.md#serializeprotocolparamsmilestoneoption) -- [deserializeReceiptMilestoneOption](api_ref.md#deserializereceiptmilestoneoption) -- [serializeReceiptMilestoneOption](api_ref.md#serializereceiptmilestoneoption) -- [deserializeAliasOutput](api_ref.md#deserializealiasoutput) -- [serializeAliasOutput](api_ref.md#serializealiasoutput) -- [deserializeBasicOutput](api_ref.md#deserializebasicoutput) -- [serializeBasicOutput](api_ref.md#serializebasicoutput) -- [deserializeFoundryOutput](api_ref.md#deserializefoundryoutput) -- [serializeFoundryOutput](api_ref.md#serializefoundryoutput) -- [deserializeNftOutput](api_ref.md#deserializenftoutput) -- [serializeNftOutput](api_ref.md#serializenftoutput) -- [deserializeOutputs](api_ref.md#deserializeoutputs) -- [serializeOutputs](api_ref.md#serializeoutputs) -- [deserializeOutput](api_ref.md#deserializeoutput) -- [serializeOutput](api_ref.md#serializeoutput) -- [deserializeTreasuryOutput](api_ref.md#deserializetreasuryoutput) -- [serializeTreasuryOutput](api_ref.md#serializetreasuryoutput) -- [deserializeMilestonePayload](api_ref.md#deserializemilestonepayload) -- [serializeMilestonePayload](api_ref.md#serializemilestonepayload) -- [serializeMilestoneEssence](api_ref.md#serializemilestoneessence) -- [deserializePayload](api_ref.md#deserializepayload) -- [serializePayload](api_ref.md#serializepayload) -- [deserializeTaggedDataPayload](api_ref.md#deserializetaggeddatapayload) -- [serializeTaggedDataPayload](api_ref.md#serializetaggeddatapayload) -- [deserializeTransactionPayload](api_ref.md#deserializetransactionpayload) -- [serializeTransactionPayload](api_ref.md#serializetransactionpayload) -- [deserializeTreasuryTransactionPayload](api_ref.md#deserializetreasurytransactionpayload) -- [serializeTreasuryTransactionPayload](api_ref.md#serializetreasurytransactionpayload) -- [deserializeEd25519Signature](api_ref.md#deserializeed25519signature) -- [serializeEd25519Signature](api_ref.md#serializeed25519signature) -- [deserializeSignature](api_ref.md#deserializesignature) -- [serializeSignature](api_ref.md#serializesignature) -- [deserializeSimpleTokenScheme](api_ref.md#deserializesimpletokenscheme) -- [serializeSimpleTokenScheme](api_ref.md#serializesimpletokenscheme) -- [deserializeTokenScheme](api_ref.md#deserializetokenscheme) -- [serializeTokenScheme](api_ref.md#serializetokenscheme) -- [deserializeTransactionEssence](api_ref.md#deserializetransactionessence) -- [serializeTransactionEssence](api_ref.md#serializetransactionessence) -- [deserializeAddressUnlockCondition](api_ref.md#deserializeaddressunlockcondition) -- [serializeAddressUnlockCondition](api_ref.md#serializeaddressunlockcondition) -- [deserializeExpirationUnlockCondition](api_ref.md#deserializeexpirationunlockcondition) -- [serializeExpirationUnlockCondition](api_ref.md#serializeexpirationunlockcondition) -- [deserializeGovernorAddressUnlockCondition](api_ref.md#deserializegovernoraddressunlockcondition) -- [serializeGovernorAddressUnlockCondition](api_ref.md#serializegovernoraddressunlockcondition) -- [deserializeImmutableAliasUnlockCondition](api_ref.md#deserializeimmutablealiasunlockcondition) -- [serializeImmutableAliasUnlockCondition](api_ref.md#serializeimmutablealiasunlockcondition) -- [deserializeStateControllerAddressUnlockCondition](api_ref.md#deserializestatecontrolleraddressunlockcondition) -- [serializeStateControllerAddressUnlockCondition](api_ref.md#serializestatecontrolleraddressunlockcondition) -- [deserializeStorageDepositReturnUnlockCondition](api_ref.md#deserializestoragedepositreturnunlockcondition) -- [serializeStorageDepositReturnUnlockCondition](api_ref.md#serializestoragedepositreturnunlockcondition) -- [deserializeTimelockUnlockCondition](api_ref.md#deserializetimelockunlockcondition) -- [serializeTimelockUnlockCondition](api_ref.md#serializetimelockunlockcondition) -- [deserializeUnlockConditions](api_ref.md#deserializeunlockconditions) -- [serializeUnlockConditions](api_ref.md#serializeunlockconditions) -- [deserializeUnlockCondition](api_ref.md#deserializeunlockcondition) -- [serializeUnlockCondition](api_ref.md#serializeunlockcondition) -- [deserializeAliasUnlock](api_ref.md#deserializealiasunlock) -- [serializeAliasUnlock](api_ref.md#serializealiasunlock) -- [deserializeNftUnlock](api_ref.md#deserializenftunlock) -- [serializeNftUnlock](api_ref.md#serializenftunlock) -- [deserializeReferenceUnlock](api_ref.md#deserializereferenceunlock) -- [serializeReferenceUnlock](api_ref.md#serializereferenceunlock) -- [deserializeSignatureUnlock](api_ref.md#deserializesignatureunlock) -- [serializeSignatureUnlock](api_ref.md#serializesignatureunlock) -- [deserializeUnlocks](api_ref.md#deserializeunlocks) -- [serializeUnlocks](api_ref.md#serializeunlocks) -- [deserializeUnlock](api_ref.md#deserializeunlock) -- [serializeUnlock](api_ref.md#serializeunlock) -- [addressBalance](api_ref.md#addressbalance) -- [generateBip44Path](api_ref.md#generatebip44path) -- [generateBip44Address](api_ref.md#generatebip44address) -- [getBalance](api_ref.md#getbalance) -- [getUnspentAddress](api_ref.md#getunspentaddress) -- [getUnspentAddresses](api_ref.md#getunspentaddresses) -- [getUnspentAddressesWithAddressGenerator](api_ref.md#getunspentaddresseswithaddressgenerator) -- [promote](api_ref.md#promote) -- [reattach](api_ref.md#reattach) -- [retrieveData](api_ref.md#retrievedata) -- [retry](api_ref.md#retry) -- [send](api_ref.md#send) -- [sendEd25519](api_ref.md#sended25519) -- [sendMultiple](api_ref.md#sendmultiple) -- [sendMultipleEd25519](api_ref.md#sendmultipleed25519) -- [sendWithAddressGenerator](api_ref.md#sendwithaddressgenerator) -- [calculateInputs](api_ref.md#calculateinputs) -- [sendAdvanced](api_ref.md#sendadvanced) -- [buildTransactionPayload](api_ref.md#buildtransactionpayload) -- [sendData](api_ref.md#senddata) -- [setLogger](api_ref.md#setlogger) -- [logRoutes](api_ref.md#logroutes) -- [logInfo](api_ref.md#loginfo) -- [logTips](api_ref.md#logtips) -- [logBlock](api_ref.md#logblock) -- [logBlockMetadata](api_ref.md#logblockmetadata) -- [logPayload](api_ref.md#logpayload) -- [logTransactionPayload](api_ref.md#logtransactionpayload) -- [logTaggedDataPayload](api_ref.md#logtaggeddatapayload) -- [logMilestonePayload](api_ref.md#logmilestonepayload) -- [logMilestoneOptions](api_ref.md#logmilestoneoptions) -- [logMilestoneOption](api_ref.md#logmilestoneoption) -- [logReceiptMilestoneOption](api_ref.md#logreceiptmilestoneoption) -- [logProtocolParamsMilestoneOption](api_ref.md#logprotocolparamsmilestoneoption) -- [logTreasuryTransactionPayload](api_ref.md#logtreasurytransactionpayload) -- [logAddress](api_ref.md#logaddress) -- [logSignature](api_ref.md#logsignature) -- [logInput](api_ref.md#loginput) -- [logOutput](api_ref.md#logoutput) -- [logUnlock](api_ref.md#logunlock) -- [logFunds](api_ref.md#logfunds) -- [logNativeTokens](api_ref.md#lognativetokens) -- [logTokenScheme](api_ref.md#logtokenscheme) -- [logFeatures](api_ref.md#logfeatures) -- [logImmutableFeatures](api_ref.md#logimmutablefeatures) -- [logFeature](api_ref.md#logfeature) -- [logUnlockConditions](api_ref.md#logunlockconditions) -- [logUnlockCondition](api_ref.md#logunlockcondition) -- [milestoneIdFromMilestonePayload](api_ref.md#milestoneidfrommilestonepayload) -- [blockIdFromMilestonePayload](api_ref.md#blockidfrommilestonepayload) - -### Interfaces - -- [SingleNodeClientOptions](interfaces/SingleNodeClientOptions.md) -- [IAddress](interfaces/IAddress.md) -- [IBip44GeneratorState](interfaces/IBip44GeneratorState.md) -- [IBlock](interfaces/IBlock.md) -- [IBlockMetadata](interfaces/IBlockMetadata.md) -- [IClient](interfaces/IClient.md) -- [IGossipHeartbeat](interfaces/IGossipHeartbeat.md) -- [IGossipMetrics](interfaces/IGossipMetrics.md) -- [IKeyPair](interfaces/IKeyPair.md) -- [IMigratedFunds](interfaces/IMigratedFunds.md) -- [INativeToken](interfaces/INativeToken.md) -- [IPeer](interfaces/IPeer.md) -- [IPowProvider](interfaces/IPowProvider.md) -- [IRent](interfaces/IRent.md) -- [ISeed](interfaces/ISeed.md) -- [ITransactionEssence](interfaces/ITransactionEssence.md) -- [ITreasury](interfaces/ITreasury.md) -- [ITypeBase](interfaces/ITypeBase.md) -- [IAliasAddress](interfaces/IAliasAddress.md) -- [IEd25519Address](interfaces/IEd25519Address.md) -- [INftAddress](interfaces/INftAddress.md) -- [IBlockIdResponse](interfaces/IBlockIdResponse.md) -- [IMilestoneUtxoChangesResponse](interfaces/IMilestoneUtxoChangesResponse.md) -- [IOutputMetadataResponse](interfaces/IOutputMetadataResponse.md) -- [IOutputResponse](interfaces/IOutputResponse.md) -- [IReceiptsResponse](interfaces/IReceiptsResponse.md) -- [IResponse](interfaces/IResponse.md) -- [ITipsResponse](interfaces/ITipsResponse.md) -- [IOutputsResponse](interfaces/IOutputsResponse.md) -- [IIssuerFeature](interfaces/IIssuerFeature.md) -- [IMetadataFeature](interfaces/IMetadataFeature.md) -- [ISenderFeature](interfaces/ISenderFeature.md) -- [ITagFeature](interfaces/ITagFeature.md) -- [INodeInfo](interfaces/INodeInfo.md) -- [INodeInfoBaseToken](interfaces/INodeInfoBaseToken.md) -- [INodeInfoMetrics](interfaces/INodeInfoMetrics.md) -- [INodeInfoMilestone](interfaces/INodeInfoMilestone.md) -- [INodeInfoProtocol](interfaces/INodeInfoProtocol.md) -- [INodeInfoProtocolParamsMilestoneOpt](interfaces/INodeInfoProtocolParamsMilestoneOpt.md) -- [INodeInfoStatus](interfaces/INodeInfoStatus.md) -- [IRoutesResponse](interfaces/IRoutesResponse.md) -- [ITreasuryInput](interfaces/ITreasuryInput.md) -- [IUTXOInput](interfaces/IUTXOInput.md) -- [IProtocolParamsMilestoneOption](interfaces/IProtocolParamsMilestoneOption.md) -- [IReceiptMilestoneOption](interfaces/IReceiptMilestoneOption.md) -- [IAliasOutput](interfaces/IAliasOutput.md) -- [IBasicOutput](interfaces/IBasicOutput.md) -- [ICommonOutput](interfaces/ICommonOutput.md) -- [IFoundryOutput](interfaces/IFoundryOutput.md) -- [INftOutput](interfaces/INftOutput.md) -- [ITreasuryOutput](interfaces/ITreasuryOutput.md) -- [IMilestonePayload](interfaces/IMilestonePayload.md) -- [ITaggedDataPayload](interfaces/ITaggedDataPayload.md) -- [ITransactionPayload](interfaces/ITransactionPayload.md) -- [ITreasuryTransactionPayload](interfaces/ITreasuryTransactionPayload.md) -- [IEd25519Signature](interfaces/IEd25519Signature.md) -- [ISimpleTokenScheme](interfaces/ISimpleTokenScheme.md) -- [IAddressUnlockCondition](interfaces/IAddressUnlockCondition.md) -- [IExpirationUnlockCondition](interfaces/IExpirationUnlockCondition.md) -- [IGovernorAddressUnlockCondition](interfaces/IGovernorAddressUnlockCondition.md) -- [IImmutableAliasUnlockCondition](interfaces/IImmutableAliasUnlockCondition.md) -- [IStateControllerAddressUnlockCondition](interfaces/IStateControllerAddressUnlockCondition.md) -- [IStorageDepositReturnUnlockCondition](interfaces/IStorageDepositReturnUnlockCondition.md) -- [ITimelockUnlockCondition](interfaces/ITimelockUnlockCondition.md) -- [IAliasUnlock](interfaces/IAliasUnlock.md) -- [INftUnlock](interfaces/INftUnlock.md) -- [IReferenceUnlock](interfaces/IReferenceUnlock.md) -- [ISignatureUnlock](interfaces/ISignatureUnlock.md) - -### Type Aliases - -- [AddressTypes](api_ref.md#addresstypes) -- [FeatureTypes](api_ref.md#featuretypes) -- [InputTypes](api_ref.md#inputtypes) -- [LedgerInclusionState](api_ref.md#ledgerinclusionstate) -- [Magnitudes](api_ref.md#magnitudes) -- [MilestoneOptionTypes](api_ref.md#milestoneoptiontypes) -- [OutputTypes](api_ref.md#outputtypes) -- [PayloadTypes](api_ref.md#payloadtypes) -- [SignatureTypes](api_ref.md#signaturetypes) -- [TokenSchemeTypes](api_ref.md#tokenschemetypes) -- [UnlockConditionTypes](api_ref.md#unlockconditiontypes) -- [UnlockTypes](api_ref.md#unlocktypes) - -### Enumerations - -- [ConflictReason](enums/ConflictReason.md) - -## Variables - -### MIN_ADDRESS_LENGTH - -• `Const` **MIN_ADDRESS_LENGTH**: `number` - -The minimum length of an address binary representation. - ---- - -### ALIAS_ID_LENGTH - -• `Const` **ALIAS_ID_LENGTH**: `number` = `32` - -The length of an alias id. - ---- - -### MIN_ALIAS_ADDRESS_LENGTH - -• `Const` **MIN_ALIAS_ADDRESS_LENGTH**: `number` - -The minimum length of an alias address binary representation. - ---- - -### MIN_ED25519_ADDRESS_LENGTH - -• `Const` **MIN_ED25519_ADDRESS_LENGTH**: `number` - -The minimum length of an ed25519 address binary representation. - ---- - -### NFT_ID_LENGTH - -• `Const` **NFT_ID_LENGTH**: `number` = `32` - -The length of an NFT Id. - ---- - -### MIN_NFT_ADDRESS_LENGTH - -• `Const` **MIN_NFT_ADDRESS_LENGTH**: `number` - -The minimum length of an nft address binary representation. - ---- - -### MAX_BLOCK_LENGTH - -• `Const` **MAX_BLOCK_LENGTH**: `number` = `32768` - -The maximum length of a block. - ---- - -### MAX_NUMBER_PARENTS - -• `Const` **MAX_NUMBER_PARENTS**: `number` = `8` - -The maximum number of parents. - ---- - -### MIN_NUMBER_PARENTS - -• `Const` **MIN_NUMBER_PARENTS**: `number` = `1` - -The minimum number of parents. - ---- - -### UINT8_SIZE - -• `Const` **UINT8_SIZE**: `number` = `1` - -Byte length for a uint8 field. - ---- - -### UINT16_SIZE - -• `Const` **UINT16_SIZE**: `number` = `2` - -Byte length for a uint16 field. - ---- - -### UINT32_SIZE - -• `Const` **UINT32_SIZE**: `number` = `4` - -Byte length for a uint32 field. - ---- - -### UINT64_SIZE - -• `Const` **UINT64_SIZE**: `number` = `8` - -Byte length for a uint64 field. - ---- - -### UINT256_SIZE - -• `Const` **UINT256_SIZE**: `number` = `32` - -Byte length for a uint256 field. - ---- - -### BLOCK_ID_LENGTH - -• `Const` **BLOCK_ID_LENGTH**: `number` = `Blake2b.SIZE_256` - -Byte length for a block id. - ---- - -### TRANSACTION_ID_LENGTH - -• `Const` **TRANSACTION_ID_LENGTH**: `number` = `Blake2b.SIZE_256` - -Byte length for a transaction id. - ---- - -### MERKLE_PROOF_LENGTH - -• `Const` **MERKLE_PROOF_LENGTH**: `number` = `Blake2b.SIZE_256` - -Byte length for a merkle prrof. - ---- - -### TYPE_LENGTH - -• `Const` **TYPE_LENGTH**: `number` = `UINT32_SIZE` - -Byte length for a type length. - ---- - -### SMALL_TYPE_LENGTH - -• `Const` **SMALL_TYPE_LENGTH**: `number` = `UINT8_SIZE` - -Byte length for a small type length. - ---- - -### STRING_LENGTH - -• `Const` **STRING_LENGTH**: `number` = `UINT16_SIZE` - -Byte length for a string length. - ---- - -### ARRAY_LENGTH - -• `Const` **ARRAY_LENGTH**: `number` = `UINT16_SIZE` - -Byte length for an array length. - ---- - -### MIN_FEATURES_LENGTH - -• `Const` **MIN_FEATURES_LENGTH**: `number` = `UINT8_SIZE` - -The minimum length of a featurs tokens list. - ---- - -### MIN_FEATURE_LENGTH - -• `Const` **MIN_FEATURE_LENGTH**: `number` - -The minimum length of a feature binary representation. - ---- - -### MIN_ISSUER_FEATURE_LENGTH - -• `Const` **MIN_ISSUER_FEATURE_LENGTH**: `number` - -The minimum length of a issuer feature binary representation. - ---- - -### MIN_METADATA_FEATURE_LENGTH - -• `Const` **MIN_METADATA_FEATURE_LENGTH**: `number` - -The minimum length of a metadata feature block binary representation. - ---- - -### MIN_SENDER_FEATURE_LENGTH - -• `Const` **MIN_SENDER_FEATURE_LENGTH**: `number` - -The minimum length of a sender feature binary representation. - ---- - -### MIN_TAG_FEATURE_LENGTH - -• `Const` **MIN_TAG_FEATURE_LENGTH**: `number` - -The minimum length of a tag feature binary representation. - ---- - -### TAIL_HASH_LENGTH - -• `Const` **TAIL_HASH_LENGTH**: `number` = `49` - -The length of the tail hash length in bytes. - ---- - -### MIN_MIGRATED_FUNDS_LENGTH - -• `Const` **MIN_MIGRATED_FUNDS_LENGTH**: `number` - -The minimum length of a migrated fund binary representation. - ---- - -### MAX_FUNDS_COUNT - -• `Const` **MAX_FUNDS_COUNT**: `number` = `127` - -The maximum number of funds. - ---- - -### MIN_INPUT_LENGTH - -• `Const` **MIN_INPUT_LENGTH**: `number` - -The minimum length of an input binary representation. - ---- - -### MIN_INPUT_COUNT - -• `Const` **MIN_INPUT_COUNT**: `number` = `1` - -The minimum number of inputs. - ---- - -### MAX_INPUT_COUNT - -• `Const` **MAX_INPUT_COUNT**: `number` = `128` - -The maximum number of inputs. - ---- - -### MIN_TREASURY_INPUT_LENGTH - -• `Const` **MIN_TREASURY_INPUT_LENGTH**: `number` - -The minimum length of a treasury input binary representation. - ---- - -### MIN_UTXO_INPUT_LENGTH - -• `Const` **MIN_UTXO_INPUT_LENGTH**: `number` - -The minimum length of a utxo input binary representation. - ---- - -### MIN_MILESTONE_OPTION_LENGTH - -• `Const` **MIN_MILESTONE_OPTION_LENGTH**: `number` - -The minimum length of a milestone option binary representation. - ---- - -### MIN_PROTOCOL_PARAMS_MILESTONE_OPTION_LENGTH - -• `Const` **MIN_PROTOCOL_PARAMS_MILESTONE_OPTION_LENGTH**: `number` - -The minimum length of a protocol params milestone option binary representation. - ---- - -### MIN_RECEIPT_MILESTONE_OPTION_LENGTH - -• `Const` **MIN_RECEIPT_MILESTONE_OPTION_LENGTH**: `number` - -The minimum length of a receipt milestone option binary representation. - ---- - -### MIN_ALIAS_OUTPUT_LENGTH - -• `Const` **MIN_ALIAS_OUTPUT_LENGTH**: `number` - -The minimum length of a alias output binary representation. - ---- - -### MIN_BASIC_OUTPUT_LENGTH - -• `Const` **MIN_BASIC_OUTPUT_LENGTH**: `number` - -The minimum length of a basic output binary representation. - ---- - -### MIN_FOUNDRY_OUTPUT_LENGTH - -• `Const` **MIN_FOUNDRY_OUTPUT_LENGTH**: `number` - -The minimum length of a foundry output binary representation. - ---- - -### MIN_NFT_OUTPUT_LENGTH - -• `Const` **MIN_NFT_OUTPUT_LENGTH**: `number` - -The minimum length of a nft output binary representation. - ---- - -### MIN_OUTPUT_LENGTH - -• `Const` **MIN_OUTPUT_LENGTH**: `number` - -The minimum length of an output binary representation. - ---- - -### MIN_OUTPUT_COUNT - -• `Const` **MIN_OUTPUT_COUNT**: `number` = `1` - -The minimum number of outputs. - ---- - -### MAX_OUTPUT_COUNT - -• `Const` **MAX_OUTPUT_COUNT**: `number` = `128` - -The maximum number of outputs. - ---- - -### MIN_TREASURY_OUTPUT_LENGTH - -• `Const` **MIN_TREASURY_OUTPUT_LENGTH**: `number` - -The minimum length of a treasury output binary representation. - ---- - -### MIN_MILESTONE_PAYLOAD_LENGTH - -• `Const` **MIN_MILESTONE_PAYLOAD_LENGTH**: `number` - -The minimum length of a milestone payload binary representation. - ---- - -### MIN_PAYLOAD_LENGTH - -• `Const` **MIN_PAYLOAD_LENGTH**: `number` - -The minimum length of a payload binary representation. - ---- - -### MIN_TAGGED_DATA_PAYLOAD_LENGTH - -• `Const` **MIN_TAGGED_DATA_PAYLOAD_LENGTH**: `number` - -The minimum length of a tagged data payload binary representation. - ---- - -### MAX_TAG_LENGTH - -• `Const` **MAX_TAG_LENGTH**: `number` = `64` - -The maximum length of a tag. - ---- - -### MIN_TRANSACTION_PAYLOAD_LENGTH - -• `Const` **MIN_TRANSACTION_PAYLOAD_LENGTH**: `number` - -The minimum length of a transaction payload binary representation. - ---- - -### MIN_TREASURY_TRANSACTION_PAYLOAD_LENGTH - -• `Const` **MIN_TREASURY_TRANSACTION_PAYLOAD_LENGTH**: `number` - -The minimum length of a treasury transaction payload binary representation. - ---- - -### MIN_ED25519_SIGNATURE_LENGTH - -• `Const` **MIN_ED25519_SIGNATURE_LENGTH**: `number` - -The minimum length of an ed25519 signature binary representation. - ---- - -### MIN_SIGNATURE_LENGTH - -• `Const` **MIN_SIGNATURE_LENGTH**: `number` = `MIN_ED25519_SIGNATURE_LENGTH` - -The minimum length of a signature binary representation. - ---- - -### MIN_SIMPLE_TOKEN_SCHEME_LENGTH - -• `Const` **MIN_SIMPLE_TOKEN_SCHEME_LENGTH**: `number` - -The minimum length of an simple token scheme binary representation. - ---- - -### MIN_TOKEN_SCHEME_LENGTH - -• `Const` **MIN_TOKEN_SCHEME_LENGTH**: `number` = `MIN_SIMPLE_TOKEN_SCHEME_LENGTH` - -The minimum length of a simple token scheme binary representation. - ---- - -### MIN_TRANSACTION_ESSENCE_LENGTH - -• `Const` **MIN_TRANSACTION_ESSENCE_LENGTH**: `number` - -The minimum length of a transaction essence binary representation. - ---- - -### MIN_ADDRESS_UNLOCK_CONDITION_LENGTH - -• `Const` **MIN_ADDRESS_UNLOCK_CONDITION_LENGTH**: `number` - -The minimum length of an address unlock condition binary representation. - ---- - -### MIN_EXPIRATION_UNLOCK_CONDITION_LENGTH - -• `Const` **MIN_EXPIRATION_UNLOCK_CONDITION_LENGTH**: `number` - -The minimum length of an expiration unlock condition binary representation. - ---- - -### MIN_GOVERNOR_ADDRESS_UNLOCK_CONDITION_LENGTH - -• `Const` **MIN_GOVERNOR_ADDRESS_UNLOCK_CONDITION_LENGTH**: `number` - -The minimum length of an governor unlock condition binary representation. - ---- - -### MIN_IMMUTABLE_ALIAS_UNLOCK_CONDITION_LENGTH - -• `Const` **MIN_IMMUTABLE_ALIAS_UNLOCK_CONDITION_LENGTH**: `number` - -The minimum length of an immutable alias unlock condition binary representation. - ---- - -### MIN_STATE_CONTROLLER_ADDRESS_UNLOCK_CONDITION_LENGTH - -• `Const` **MIN_STATE_CONTROLLER_ADDRESS_UNLOCK_CONDITION_LENGTH**: `number` - -The minimum length of an state controller address unlock condition binary representation. - ---- - -### MIN_STORAGE_DEPOSIT_RETURN_UNLOCK_CONDITION_LENGTH - -• `Const` **MIN_STORAGE_DEPOSIT_RETURN_UNLOCK_CONDITION_LENGTH**: `number` - -The minimum length of an storage deposit return unlock condition binary representation. - ---- - -### MIN_TIMELOCK_UNLOCK_CONDITION_LENGTH - -• `Const` **MIN_TIMELOCK_UNLOCK_CONDITION_LENGTH**: `number` - -The minimum length of an timelock unlock condition binary representation. - ---- - -### MIN_UNLOCK_CONDITIONS_LENGTH - -• `Const` **MIN_UNLOCK_CONDITIONS_LENGTH**: `number` = `UINT8_SIZE` - -The minimum length of a unlock conditions list. - ---- - -### MIN_UNLOCK_CONDITION_LENGTH - -• `Const` **MIN_UNLOCK_CONDITION_LENGTH**: `number` - -The minimum length of a unlock conditions binary representation. - ---- - -### MIN_ALIAS_UNLOCK_LENGTH - -• `Const` **MIN_ALIAS_UNLOCK_LENGTH**: `number` - -The minimum length of a alias unlock binary representation. - ---- - -### MIN_NFT_UNLOCK_LENGTH - -• `Const` **MIN_NFT_UNLOCK_LENGTH**: `number` - -The minimum length of a nft unlock binary representation. - ---- - -### MIN_REFERENCE_UNLOCK_LENGTH - -• `Const` **MIN_REFERENCE_UNLOCK_LENGTH**: `number` - -The minimum length of a reference unlock binary representation. - ---- - -### MIN_SIGNATURE_UNLOCK_LENGTH - -• `Const` **MIN_SIGNATURE_UNLOCK_LENGTH**: `number` - -The minimum length of a signature unlock binary representation. - ---- - -### MIN_UNLOCK_LENGTH - -• `Const` **MIN_UNLOCK_LENGTH**: `number` - -The minimum length of an unlock binary representation. - ---- - -### DEFAULT_PROTOCOL_VERSION - -• `Const` **DEFAULT_PROTOCOL_VERSION**: `number` = `2` - -The default protocol version. - ---- - -### TRANSACTION_ESSENCE_TYPE - -• `Const` **TRANSACTION_ESSENCE_TYPE**: `1` - -The global type for the transaction essence. - ---- - -### INPUTS_COMMITMENT_SIZE - -• `Const` **INPUTS_COMMITMENT_SIZE**: `number` = `Blake2b.SIZE_256` - -Inputs commitment size. - ---- - -### ALIAS_ADDRESS_TYPE - -• `Const` **ALIAS_ADDRESS_TYPE**: `8` - -The global type for the alias address type. - ---- - -### ED25519_ADDRESS_TYPE - -• `Const` **ED25519_ADDRESS_TYPE**: `0` - -The global type for the ed25519 address type. - ---- - -### NFT_ADDRESS_TYPE - -• `Const` **NFT_ADDRESS_TYPE**: `16` - -The global type for the NFT address type. - ---- - -### ISSUER_FEATURE_TYPE - -• `Const` **ISSUER_FEATURE_TYPE**: `1` - -The global type for the issuer feature. - ---- - -### METADATA_FEATURE_TYPE - -• `Const` **METADATA_FEATURE_TYPE**: `2` - -The global type for the metadata feature. - ---- - -### SENDER_FEATURE_TYPE - -• `Const` **SENDER_FEATURE_TYPE**: `0` - -The global type for the sender feature. - ---- - -### TAG_FEATURE_TYPE - -• `Const` **TAG_FEATURE_TYPE**: `3` - -The global type for the tag feature. - ---- - -### TREASURY_INPUT_TYPE - -• `Const` **TREASURY_INPUT_TYPE**: `1` - -The global type for the treasury input. - ---- - -### UTXO_INPUT_TYPE - -• `Const` **UTXO_INPUT_TYPE**: `0` - -The global type for the input. - ---- - -### PROTOCOL_PARAMETERS_MILESTONE_OPTION_TYPE - -• `Const` **PROTOCOL_PARAMETERS_MILESTONE_OPTION_TYPE**: `1` - -The global type for the option. - ---- - -### RECEIPT_MILESTONE_OPTION_TYPE - -• `Const` **RECEIPT_MILESTONE_OPTION_TYPE**: `0` - -The global type for the option. - ---- - -### ALIAS_OUTPUT_TYPE - -• `Const` **ALIAS_OUTPUT_TYPE**: `4` - -The global type for the alias output. - ---- - -### BASIC_OUTPUT_TYPE - -• `Const` **BASIC_OUTPUT_TYPE**: `3` - -The global type for the basic output. - ---- - -### FOUNDRY_OUTPUT_TYPE - -• `Const` **FOUNDRY_OUTPUT_TYPE**: `5` - -The global type for the foundry output. - ---- - -### NFT_OUTPUT_TYPE - -• `Const` **NFT_OUTPUT_TYPE**: `6` - -The global type for the NFT output. - ---- - -### TREASURY_OUTPUT_TYPE - -• `Const` **TREASURY_OUTPUT_TYPE**: `2` - -The global type for the treasury output. - ---- - -### MILESTONE_PAYLOAD_TYPE - -• `Const` **MILESTONE_PAYLOAD_TYPE**: `7` - -The global type for the payload. - ---- - -### TAGGED_DATA_PAYLOAD_TYPE - -• `Const` **TAGGED_DATA_PAYLOAD_TYPE**: `5` - -The global type for the payload. - ---- - -### TRANSACTION_PAYLOAD_TYPE - -• `Const` **TRANSACTION_PAYLOAD_TYPE**: `6` - -The global type for the payload. - ---- - -### TREASURY_TRANSACTION_PAYLOAD_TYPE - -• `Const` **TREASURY_TRANSACTION_PAYLOAD_TYPE**: `4` - -The global type for the payload. - ---- - -### ED25519_SIGNATURE_TYPE - -• `Const` **ED25519_SIGNATURE_TYPE**: `0` - -The global type for the signature type. - ---- - -### SIMPLE_TOKEN_SCHEME_TYPE - -• `Const` **SIMPLE_TOKEN_SCHEME_TYPE**: `0` - -The global type for the simple token scheme. - ---- - -### ADDRESS_UNLOCK_CONDITION_TYPE - -• `Const` **ADDRESS_UNLOCK_CONDITION_TYPE**: `0` - -The global type for the address unlock condition. - ---- - -### EXPIRATION_UNLOCK_CONDITION_TYPE - -• `Const` **EXPIRATION_UNLOCK_CONDITION_TYPE**: `3` - -The global type for the expiration unlock condition. - ---- - -### GOVERNOR_ADDRESS_UNLOCK_CONDITION_TYPE - -• `Const` **GOVERNOR_ADDRESS_UNLOCK_CONDITION_TYPE**: `5` - -The global type for the governor address unlock condition. - ---- - -### IMMUTABLE_ALIAS_UNLOCK_CONDITION_TYPE - -• `Const` **IMMUTABLE_ALIAS_UNLOCK_CONDITION_TYPE**: `6` - -The global type for the immutable alias unlock condition. - ---- - -### STATE_CONTROLLER_ADDRESS_UNLOCK_CONDITION_TYPE - -• `Const` **STATE_CONTROLLER_ADDRESS_UNLOCK_CONDITION_TYPE**: `4` - -The global type for the state controller unlock condition. - ---- - -### STORAGE_DEPOSIT_RETURN_UNLOCK_CONDITION_TYPE - -• `Const` **STORAGE_DEPOSIT_RETURN_UNLOCK_CONDITION_TYPE**: `1` - -The global type for the storage deposit return unlock condition. - ---- - -### TIMELOCK_UNLOCK_CONDITION_TYPE - -• `Const` **TIMELOCK_UNLOCK_CONDITION_TYPE**: `2` - -The global type for the timelock unlock condition. - ---- - -### ALIAS_UNLOCK_TYPE - -• `Const` **ALIAS_UNLOCK_TYPE**: `2` - -The global type for the alias unlock. - ---- - -### NFT_UNLOCK_TYPE - -• `Const` **NFT_UNLOCK_TYPE**: `3` - -The global type for the NFT unlock. - ---- - -### REFERENCE_UNLOCK_TYPE - -• `Const` **REFERENCE_UNLOCK_TYPE**: `1` - -The global type for the reference unlock. - ---- - -### SIGNATURE_UNLOCK_TYPE - -• `Const` **SIGNATURE_UNLOCK_TYPE**: `0` - -The global type for the unlock. - ---- - -### CONFLICT_REASON_STRINGS - -• `Const` **CONFLICT_REASON_STRINGS**: { [key in ConflictReason]: string } - -Conflict reason strings. - ---- - -### ED25519_SEED_TYPE - -• `Const` **ED25519_SEED_TYPE**: `number` = `1` - -The global type for the seed. - -## Functions - -### deserializeAddress - -▸ **deserializeAddress**(`readStream`): [`AddressTypes`](api_ref.md#addresstypes) - -Deserialize the address from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`AddressTypes`](api_ref.md#addresstypes) - -The deserialized object. - ---- - -### serializeAddress - -▸ **serializeAddress**(`writeStream`, `object`): `void` - -Serialize the address to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------ | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`ITypeBase`](interfaces/ITypeBase.md)<`number`\> | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeAliasAddress - -▸ **deserializeAliasAddress**(`readStream`): [`IAliasAddress`](interfaces/IAliasAddress.md) - -Deserialize the alias address from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`IAliasAddress`](interfaces/IAliasAddress.md) - -The deserialized object. - ---- - -### serializeAliasAddress - -▸ **serializeAliasAddress**(`writeStream`, `object`): `void` - -Serialize the alias address to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :--------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IAliasAddress`](interfaces/IAliasAddress.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeEd25519Address - -▸ **deserializeEd25519Address**(`readStream`): [`IEd25519Address`](interfaces/IEd25519Address.md) - -Deserialize the Ed25519 address from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`IEd25519Address`](interfaces/IEd25519Address.md) - -The deserialized object. - ---- - -### serializeEd25519Address - -▸ **serializeEd25519Address**(`writeStream`, `object`): `void` - -Serialize the ed25519 address to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IEd25519Address`](interfaces/IEd25519Address.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeNftAddress - -▸ **deserializeNftAddress**(`readStream`): [`INftAddress`](interfaces/INftAddress.md) - -Deserialize the nft address from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`INftAddress`](interfaces/INftAddress.md) - -The deserialized object. - ---- - -### serializeNftAddress - -▸ **serializeNftAddress**(`writeStream`, `object`): `void` - -Serialize the nft address to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`INftAddress`](interfaces/INftAddress.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeBlock - -▸ **deserializeBlock**(`readStream`): [`IBlock`](interfaces/IBlock.md) - -Deserialize the block from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :------------------------ | -| `readStream` | `ReadStream` | The block to deserialize. | - -#### Returns - -[`IBlock`](interfaces/IBlock.md) - -The deserialized block. - ---- - -### serializeBlock - -▸ **serializeBlock**(`writeStream`, `object`): `void` - -Serialize the block essence to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IBlock`](interfaces/IBlock.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeFeatures - -▸ **deserializeFeatures**(`readStream`): [`FeatureTypes`](api_ref.md#featuretypes)[] \| `undefined` - -Deserialize the feature from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`FeatureTypes`](api_ref.md#featuretypes)[] \| `undefined` - -The deserialized object. - ---- - -### serializeFeatures - -▸ **serializeFeatures**(`writeStream`, `objects`): `void` - -Serialize the feature to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :--------------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `objects` | `undefined` \| [`FeatureTypes`](api_ref.md#featuretypes)[] | The objects to serialize. | - -#### Returns - -`void` - ---- - -### deserializeFeature - -▸ **deserializeFeature**(`readStream`): [`FeatureTypes`](api_ref.md#featuretypes) - -Deserialize the feature from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`FeatureTypes`](api_ref.md#featuretypes) - -The deserialized object. - ---- - -### serializeFeature - -▸ **serializeFeature**(`writeStream`, `object`): `void` - -Serialize the feature to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------ | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`ITypeBase`](interfaces/ITypeBase.md)<`number`\> | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeIssuerFeature - -▸ **deserializeIssuerFeature**(`readStream`): [`IIssuerFeature`](interfaces/IIssuerFeature.md) - -Deserialize the issuer feature from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`IIssuerFeature`](interfaces/IIssuerFeature.md) - -The deserialized object. - ---- - -### serializeIssuerFeature - -▸ **serializeIssuerFeature**(`writeStream`, `object`): `void` - -Serialize the issuer feature to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IIssuerFeature`](interfaces/IIssuerFeature.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeMetadataFeature - -▸ **deserializeMetadataFeature**(`readStream`): [`IMetadataFeature`](interfaces/IMetadataFeature.md) - -Deserialize the metadata feature block from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`IMetadataFeature`](interfaces/IMetadataFeature.md) - -The deserialized object. - ---- - -### serializeMetadataFeature - -▸ **serializeMetadataFeature**(`writeStream`, `object`): `void` - -Serialize the metadata feature to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :--------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IMetadataFeature`](interfaces/IMetadataFeature.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeSenderFeature - -▸ **deserializeSenderFeature**(`readStream`): [`ISenderFeature`](interfaces/ISenderFeature.md) - -Deserialize the sender feature from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`ISenderFeature`](interfaces/ISenderFeature.md) - -The deserialized object. - ---- - -### serializeSenderFeature - -▸ **serializeSenderFeature**(`writeStream`, `object`): `void` - -Serialize the sender feature to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`ISenderFeature`](interfaces/ISenderFeature.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeTagFeature - -▸ **deserializeTagFeature**(`readStream`): [`ITagFeature`](interfaces/ITagFeature.md) - -Deserialize the tag feature from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`ITagFeature`](interfaces/ITagFeature.md) - -The deserialized object. - ---- - -### serializeTagFeature - -▸ **serializeTagFeature**(`writeStream`, `object`): `void` - -Serialize the tag feature to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`ITagFeature`](interfaces/ITagFeature.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeFunds - -▸ **deserializeFunds**(`readStream`): [`IMigratedFunds`](interfaces/IMigratedFunds.md)[] - -Deserialize the receipt payload funds from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`IMigratedFunds`](interfaces/IMigratedFunds.md)[] - -The deserialized object. - ---- - -### serializeFunds - -▸ **serializeFunds**(`writeStream`, `objects`): `void` - -Serialize the receipt payload funds to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `objects` | [`IMigratedFunds`](interfaces/IMigratedFunds.md)[] | The objects to serialize. | - -#### Returns - -`void` - ---- - -### deserializeMigratedFunds - -▸ **deserializeMigratedFunds**(`readStream`): [`IMigratedFunds`](interfaces/IMigratedFunds.md) - -Deserialize the migrated fund from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`IMigratedFunds`](interfaces/IMigratedFunds.md) - -The deserialized object. - ---- - -### serializeMigratedFunds - -▸ **serializeMigratedFunds**(`writeStream`, `object`): `void` - -Serialize the migrated funds to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IMigratedFunds`](interfaces/IMigratedFunds.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeInputs - -▸ **deserializeInputs**(`readStream`): [`InputTypes`](api_ref.md#inputtypes)[] - -Deserialize the inputs from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`InputTypes`](api_ref.md#inputtypes)[] - -The deserialized object. - ---- - -### serializeInputs - -▸ **serializeInputs**(`writeStream`, `objects`): `void` - -Serialize the inputs to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :-------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `objects` | [`InputTypes`](api_ref.md#inputtypes)[] | The objects to serialize. | - -#### Returns - -`void` - ---- - -### deserializeInput - -▸ **deserializeInput**(`readStream`): [`InputTypes`](api_ref.md#inputtypes) - -Deserialize the input from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`InputTypes`](api_ref.md#inputtypes) - -The deserialized object. - ---- - -### serializeInput - -▸ **serializeInput**(`writeStream`, `object`): `void` - -Serialize the input to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------ | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`InputTypes`](api_ref.md#inputtypes) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeTreasuryInput - -▸ **deserializeTreasuryInput**(`readStream`): [`ITreasuryInput`](interfaces/ITreasuryInput.md) - -Deserialize the treasury input from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`ITreasuryInput`](interfaces/ITreasuryInput.md) - -The deserialized object. - ---- - -### serializeTreasuryInput - -▸ **serializeTreasuryInput**(`writeStream`, `object`): `void` - -Serialize the treasury input to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`ITreasuryInput`](interfaces/ITreasuryInput.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeUTXOInput - -▸ **deserializeUTXOInput**(`readStream`): [`IUTXOInput`](interfaces/IUTXOInput.md) - -Deserialize the utxo input from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`IUTXOInput`](interfaces/IUTXOInput.md) - -The deserialized object. - ---- - -### serializeUTXOInput - -▸ **serializeUTXOInput**(`writeStream`, `object`): `void` - -Serialize the utxo input to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :--------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IUTXOInput`](interfaces/IUTXOInput.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeMilestoneOptions - -▸ **deserializeMilestoneOptions**(`readStream`): [`MilestoneOptionTypes`](api_ref.md#milestoneoptiontypes)[] - -Deserialize the milestone options from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`MilestoneOptionTypes`](api_ref.md#milestoneoptiontypes)[] - -The deserialized object. - ---- - -### serializeMilestoneOptions - -▸ **serializeMilestoneOptions**(`writeStream`, `objects`): `void` - -Serialize the milestone options to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :---------------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `objects` | [`MilestoneOptionTypes`](api_ref.md#milestoneoptiontypes)[] | The objects to serialize. | - -#### Returns - -`void` - ---- - -### deserializeMilestoneOption - -▸ **deserializeMilestoneOption**(`readStream`): [`MilestoneOptionTypes`](api_ref.md#milestoneoptiontypes) - -Deserialize the milestone options from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`MilestoneOptionTypes`](api_ref.md#milestoneoptiontypes) - -The deserialized object. - ---- - -### serializeMilestoneOption - -▸ **serializeMilestoneOption**(`writeStream`, `object`): `void` - -Serialize the milestone option to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------ | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`ITypeBase`](interfaces/ITypeBase.md)<`number`\> | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeProtocolParamsMilestoneOption - -▸ **deserializeProtocolParamsMilestoneOption**(`readStream`): [`IProtocolParamsMilestoneOption`](interfaces/IProtocolParamsMilestoneOption.md) - -Deserialize the protocol params milestone option from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`IProtocolParamsMilestoneOption`](interfaces/IProtocolParamsMilestoneOption.md) - -The deserialized object. - ---- - -### serializeProtocolParamsMilestoneOption - -▸ **serializeProtocolParamsMilestoneOption**(`writeStream`, `object`): `void` - -Serialize the protocol params milestone option to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IProtocolParamsMilestoneOption`](interfaces/IProtocolParamsMilestoneOption.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeReceiptMilestoneOption - -▸ **deserializeReceiptMilestoneOption**(`readStream`): [`IReceiptMilestoneOption`](interfaces/IReceiptMilestoneOption.md) - -Deserialize the receipt milestone option from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`IReceiptMilestoneOption`](interfaces/IReceiptMilestoneOption.md) - -The deserialized object. - ---- - -### serializeReceiptMilestoneOption - -▸ **serializeReceiptMilestoneOption**(`writeStream`, `object`): `void` - -Serialize the receipt milestone option to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------------------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IReceiptMilestoneOption`](interfaces/IReceiptMilestoneOption.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeAliasOutput - -▸ **deserializeAliasOutput**(`readStream`): [`IAliasOutput`](interfaces/IAliasOutput.md) - -Deserialize the alias output from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`IAliasOutput`](interfaces/IAliasOutput.md) - -The deserialized object. - ---- - -### serializeAliasOutput - -▸ **serializeAliasOutput**(`writeStream`, `object`): `void` - -Serialize the alias output to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IAliasOutput`](interfaces/IAliasOutput.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeBasicOutput - -▸ **deserializeBasicOutput**(`readStream`): [`IBasicOutput`](interfaces/IBasicOutput.md) - -Deserialize the basic output from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`IBasicOutput`](interfaces/IBasicOutput.md) - -The deserialized object. - ---- - -### serializeBasicOutput - -▸ **serializeBasicOutput**(`writeStream`, `object`): `void` - -Serialize the basic output to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IBasicOutput`](interfaces/IBasicOutput.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeFoundryOutput - -▸ **deserializeFoundryOutput**(`readStream`): [`IFoundryOutput`](interfaces/IFoundryOutput.md) - -Deserialize the foundry output from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`IFoundryOutput`](interfaces/IFoundryOutput.md) - -The deserialized object. - ---- - -### serializeFoundryOutput - -▸ **serializeFoundryOutput**(`writeStream`, `object`): `void` - -Serialize the foundry output to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IFoundryOutput`](interfaces/IFoundryOutput.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeNftOutput - -▸ **deserializeNftOutput**(`readStream`): [`INftOutput`](interfaces/INftOutput.md) - -Deserialize the nft output from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`INftOutput`](interfaces/INftOutput.md) - -The deserialized object. - ---- - -### serializeNftOutput - -▸ **serializeNftOutput**(`writeStream`, `object`): `void` - -Serialize the nft output to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :--------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`INftOutput`](interfaces/INftOutput.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeOutputs - -▸ **deserializeOutputs**(`readStream`): [`OutputTypes`](api_ref.md#outputtypes)[] - -Deserialize the outputs from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`OutputTypes`](api_ref.md#outputtypes)[] - -The deserialized object. - ---- - -### serializeOutputs - -▸ **serializeOutputs**(`writeStream`, `objects`): `void` - -Serialize the outputs to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :---------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `objects` | [`OutputTypes`](api_ref.md#outputtypes)[] | The objects to serialize. | - -#### Returns - -`void` - ---- - -### deserializeOutput - -▸ **deserializeOutput**(`readStream`): [`OutputTypes`](api_ref.md#outputtypes) - -Deserialize the output from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`OutputTypes`](api_ref.md#outputtypes) - -The deserialized object. - ---- - -### serializeOutput - -▸ **serializeOutput**(`writeStream`, `object`): `void` - -Serialize the output to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------ | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`ITypeBase`](interfaces/ITypeBase.md)<`number`\> | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeTreasuryOutput - -▸ **deserializeTreasuryOutput**(`readStream`): [`ITreasuryOutput`](interfaces/ITreasuryOutput.md) - -Deserialize the treasury output from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`ITreasuryOutput`](interfaces/ITreasuryOutput.md) - -The deserialized object. - ---- - -### serializeTreasuryOutput - -▸ **serializeTreasuryOutput**(`writeStream`, `object`): `void` - -Serialize the treasury output to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`ITreasuryOutput`](interfaces/ITreasuryOutput.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeMilestonePayload - -▸ **deserializeMilestonePayload**(`readStream`): [`IMilestonePayload`](interfaces/IMilestonePayload.md) - -Deserialize the milestone payload from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`IMilestonePayload`](interfaces/IMilestonePayload.md) - -The deserialized object. - ---- - -### serializeMilestonePayload - -▸ **serializeMilestonePayload**(`writeStream`, `object`): `void` - -Serialize the milestone payload to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IMilestonePayload`](interfaces/IMilestonePayload.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### serializeMilestoneEssence - -▸ **serializeMilestoneEssence**(`writeStream`, `object`): `void` - -Serialize the milestone payload to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IMilestonePayload`](interfaces/IMilestonePayload.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializePayload - -▸ **deserializePayload**(`readStream`): [`PayloadTypes`](api_ref.md#payloadtypes) \| `undefined` - -Deserialize the payload from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`PayloadTypes`](api_ref.md#payloadtypes) \| `undefined` - -The deserialized object. - ---- - -### serializePayload - -▸ **serializePayload**(`writeStream`, `object`): `void` - -Serialize the payload essence to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | `undefined` \| [`PayloadTypes`](api_ref.md#payloadtypes) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeTaggedDataPayload - -▸ **deserializeTaggedDataPayload**(`readStream`): [`ITaggedDataPayload`](interfaces/ITaggedDataPayload.md) - -Deserialize the tagged data payload from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`ITaggedDataPayload`](interfaces/ITaggedDataPayload.md) - -The deserialized object. - ---- - -### serializeTaggedDataPayload - -▸ **serializeTaggedDataPayload**(`writeStream`, `object`): `void` - -Serialize the tagged data payload to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`ITaggedDataPayload`](interfaces/ITaggedDataPayload.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeTransactionPayload - -▸ **deserializeTransactionPayload**(`readStream`): [`ITransactionPayload`](interfaces/ITransactionPayload.md) - -Deserialize the transaction payload from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`ITransactionPayload`](interfaces/ITransactionPayload.md) - -The deserialized object. - ---- - -### serializeTransactionPayload - -▸ **serializeTransactionPayload**(`writeStream`, `object`): `void` - -Serialize the transaction payload to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :--------------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`ITransactionPayload`](interfaces/ITransactionPayload.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeTreasuryTransactionPayload - -▸ **deserializeTreasuryTransactionPayload**(`readStream`): [`ITreasuryTransactionPayload`](interfaces/ITreasuryTransactionPayload.md) - -Deserialize the treasury transaction payload from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`ITreasuryTransactionPayload`](interfaces/ITreasuryTransactionPayload.md) - -The deserialized object. - ---- - -### serializeTreasuryTransactionPayload - -▸ **serializeTreasuryTransactionPayload**(`writeStream`, `object`): `void` - -Serialize the treasury transaction payload to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`ITreasuryTransactionPayload`](interfaces/ITreasuryTransactionPayload.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeEd25519Signature - -▸ **deserializeEd25519Signature**(`readStream`): [`IEd25519Signature`](interfaces/IEd25519Signature.md) - -Deserialize the Ed25519 signature from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`IEd25519Signature`](interfaces/IEd25519Signature.md) - -The deserialized object. - ---- - -### serializeEd25519Signature - -▸ **serializeEd25519Signature**(`writeStream`, `object`): `void` - -Serialize the Ed25519 signature to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IEd25519Signature`](interfaces/IEd25519Signature.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeSignature - -▸ **deserializeSignature**(`readStream`): [`SignatureTypes`](api_ref.md#signaturetypes) - -Deserialize the signature from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`SignatureTypes`](api_ref.md#signaturetypes) - -The deserialized object. - ---- - -### serializeSignature - -▸ **serializeSignature**(`writeStream`, `object`): `void` - -Serialize the signature to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IEd25519Signature`](interfaces/IEd25519Signature.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeSimpleTokenScheme - -▸ **deserializeSimpleTokenScheme**(`readStream`): [`ISimpleTokenScheme`](interfaces/ISimpleTokenScheme.md) - -Deserialize the simple token scheme from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`ISimpleTokenScheme`](interfaces/ISimpleTokenScheme.md) - -The deserialized object. - ---- - -### serializeSimpleTokenScheme - -▸ **serializeSimpleTokenScheme**(`writeStream`, `object`): `void` - -Serialize the simple token scheme to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`ISimpleTokenScheme`](interfaces/ISimpleTokenScheme.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeTokenScheme - -▸ **deserializeTokenScheme**(`readStream`): [`TokenSchemeTypes`](api_ref.md#tokenschemetypes) - -Deserialize the token scheme from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`TokenSchemeTypes`](api_ref.md#tokenschemetypes) - -The deserialized object. - ---- - -### serializeTokenScheme - -▸ **serializeTokenScheme**(`writeStream`, `object`): `void` - -Serialize the token scheme to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`ISimpleTokenScheme`](interfaces/ISimpleTokenScheme.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeTransactionEssence - -▸ **deserializeTransactionEssence**(`readStream`): [`ITransactionEssence`](interfaces/ITransactionEssence.md) - -Deserialize the transaction essence from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`ITransactionEssence`](interfaces/ITransactionEssence.md) - -The deserialized object. - ---- - -### serializeTransactionEssence - -▸ **serializeTransactionEssence**(`writeStream`, `object`): `void` - -Serialize the transaction essence to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :--------------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`ITransactionEssence`](interfaces/ITransactionEssence.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeAddressUnlockCondition - -▸ **deserializeAddressUnlockCondition**(`readStream`): [`IAddressUnlockCondition`](interfaces/IAddressUnlockCondition.md) - -Deserialize the address unlock condition from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`IAddressUnlockCondition`](interfaces/IAddressUnlockCondition.md) - -The deserialized object. - ---- - -### serializeAddressUnlockCondition - -▸ **serializeAddressUnlockCondition**(`writeStream`, `object`): `void` - -Serialize the address unlock condition to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------------------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IAddressUnlockCondition`](interfaces/IAddressUnlockCondition.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeExpirationUnlockCondition - -▸ **deserializeExpirationUnlockCondition**(`readStream`): [`IExpirationUnlockCondition`](interfaces/IExpirationUnlockCondition.md) - -Deserialize the expiration unlock condition from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`IExpirationUnlockCondition`](interfaces/IExpirationUnlockCondition.md) - -The deserialized object. - ---- - -### serializeExpirationUnlockCondition - -▸ **serializeExpirationUnlockCondition**(`writeStream`, `object`): `void` - -Serialize the expiration unlock condition to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------------------------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IExpirationUnlockCondition`](interfaces/IExpirationUnlockCondition.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeGovernorAddressUnlockCondition - -▸ **deserializeGovernorAddressUnlockCondition**(`readStream`): [`IGovernorAddressUnlockCondition`](interfaces/IGovernorAddressUnlockCondition.md) - -Deserialize the governor address unlock condition from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`IGovernorAddressUnlockCondition`](interfaces/IGovernorAddressUnlockCondition.md) - -The deserialized object. - ---- - -### serializeGovernorAddressUnlockCondition - -▸ **serializeGovernorAddressUnlockCondition**(`writeStream`, `object`): `void` - -Serialize the governor address unlock condition to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :--------------------------------------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IGovernorAddressUnlockCondition`](interfaces/IGovernorAddressUnlockCondition.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeImmutableAliasUnlockCondition - -▸ **deserializeImmutableAliasUnlockCondition**(`readStream`): [`IImmutableAliasUnlockCondition`](interfaces/IImmutableAliasUnlockCondition.md) - -Deserialize the immutable alias unlock condition from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`IImmutableAliasUnlockCondition`](interfaces/IImmutableAliasUnlockCondition.md) - -The deserialized object. - ---- - -### serializeImmutableAliasUnlockCondition - -▸ **serializeImmutableAliasUnlockCondition**(`writeStream`, `object`): `void` - -Serialize the immutable alias unlock condition to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IImmutableAliasUnlockCondition`](interfaces/IImmutableAliasUnlockCondition.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeStateControllerAddressUnlockCondition - -▸ **deserializeStateControllerAddressUnlockCondition**(`readStream`): [`IStateControllerAddressUnlockCondition`](interfaces/IStateControllerAddressUnlockCondition.md) - -Deserialize the state controller address unlock condition from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`IStateControllerAddressUnlockCondition`](interfaces/IStateControllerAddressUnlockCondition.md) - -The deserialized object. - ---- - -### serializeStateControllerAddressUnlockCondition - -▸ **serializeStateControllerAddressUnlockCondition**(`writeStream`, `object`): `void` - -Serialize the state controller address unlock condition to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------------------------------------------------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IStateControllerAddressUnlockCondition`](interfaces/IStateControllerAddressUnlockCondition.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeStorageDepositReturnUnlockCondition - -▸ **deserializeStorageDepositReturnUnlockCondition**(`readStream`): [`IStorageDepositReturnUnlockCondition`](interfaces/IStorageDepositReturnUnlockCondition.md) - -Deserialize the storage deposit return unlock condition from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`IStorageDepositReturnUnlockCondition`](interfaces/IStorageDepositReturnUnlockCondition.md) - -The deserialized object. - ---- - -### serializeStorageDepositReturnUnlockCondition - -▸ **serializeStorageDepositReturnUnlockCondition**(`writeStream`, `object`): `void` - -Serialize the storage deposit return unlock condition to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IStorageDepositReturnUnlockCondition`](interfaces/IStorageDepositReturnUnlockCondition.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeTimelockUnlockCondition - -▸ **deserializeTimelockUnlockCondition**(`readStream`): [`ITimelockUnlockCondition`](interfaces/ITimelockUnlockCondition.md) - -Deserialize the timelock unlock condition from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`ITimelockUnlockCondition`](interfaces/ITimelockUnlockCondition.md) - -The deserialized object. - ---- - -### serializeTimelockUnlockCondition - -▸ **serializeTimelockUnlockCondition**(`writeStream`, `object`): `void` - -Serialize the timelock unlock condition to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`ITimelockUnlockCondition`](interfaces/ITimelockUnlockCondition.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeUnlockConditions - -▸ **deserializeUnlockConditions**(`readStream`): [`UnlockConditionTypes`](api_ref.md#unlockconditiontypes)[] - -Deserialize the unlock conditions from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`UnlockConditionTypes`](api_ref.md#unlockconditiontypes)[] - -The deserialized object. - ---- - -### serializeUnlockConditions - -▸ **serializeUnlockConditions**(`writeStream`, `objects`): `void` - -Serialize the unlock conditions to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :---------------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `objects` | [`UnlockConditionTypes`](api_ref.md#unlockconditiontypes)[] | The objects to serialize. | - -#### Returns - -`void` - ---- - -### deserializeUnlockCondition - -▸ **deserializeUnlockCondition**(`readStream`): [`UnlockConditionTypes`](api_ref.md#unlockconditiontypes) - -Deserialize the unlock condition from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`UnlockConditionTypes`](api_ref.md#unlockconditiontypes) - -The deserialized object. - ---- - -### serializeUnlockCondition - -▸ **serializeUnlockCondition**(`writeStream`, `object`): `void` - -Serialize the unlock condition to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------ | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`ITypeBase`](interfaces/ITypeBase.md)<`number`\> | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeAliasUnlock - -▸ **deserializeAliasUnlock**(`readStream`): [`IAliasUnlock`](interfaces/IAliasUnlock.md) - -Deserialize the alias unlock from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`IAliasUnlock`](interfaces/IAliasUnlock.md) - -The deserialized object. - ---- - -### serializeAliasUnlock - -▸ **serializeAliasUnlock**(`writeStream`, `object`): `void` - -Serialize the alias unlock to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IAliasUnlock`](interfaces/IAliasUnlock.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeNftUnlock - -▸ **deserializeNftUnlock**(`readStream`): [`INftUnlock`](interfaces/INftUnlock.md) - -Deserialize the nft unlock from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`INftUnlock`](interfaces/INftUnlock.md) - -The deserialized object. - ---- - -### serializeNftUnlock - -▸ **serializeNftUnlock**(`writeStream`, `object`): `void` - -Serialize the nft unlock to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :--------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`INftUnlock`](interfaces/INftUnlock.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeReferenceUnlock - -▸ **deserializeReferenceUnlock**(`readStream`): [`IReferenceUnlock`](interfaces/IReferenceUnlock.md) - -Deserialize the reference unlock from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`IReferenceUnlock`](interfaces/IReferenceUnlock.md) - -The deserialized object. - ---- - -### serializeReferenceUnlock - -▸ **serializeReferenceUnlock**(`writeStream`, `object`): `void` - -Serialize the reference unlock to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :--------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`IReferenceUnlock`](interfaces/IReferenceUnlock.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeSignatureUnlock - -▸ **deserializeSignatureUnlock**(`readStream`): [`ISignatureUnlock`](interfaces/ISignatureUnlock.md) - -Deserialize the signature unlock from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`ISignatureUnlock`](interfaces/ISignatureUnlock.md) - -The deserialized object. - ---- - -### serializeSignatureUnlock - -▸ **serializeSignatureUnlock**(`writeStream`, `object`): `void` - -Serialize the signature unlock to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :--------------------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`ISignatureUnlock`](interfaces/ISignatureUnlock.md) | The object to serialize. | - -#### Returns - -`void` - ---- - -### deserializeUnlocks - -▸ **deserializeUnlocks**(`readStream`): [`UnlockTypes`](api_ref.md#unlocktypes)[] - -Deserialize the unlocks from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`UnlockTypes`](api_ref.md#unlocktypes)[] - -The deserialized object. - ---- - -### serializeUnlocks - -▸ **serializeUnlocks**(`writeStream`, `objects`): `void` - -Serialize the unlocks to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :---------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `objects` | [`UnlockTypes`](api_ref.md#unlocktypes)[] | The objects to serialize. | - -#### Returns - -`void` - ---- - -### deserializeUnlock - -▸ **deserializeUnlock**(`readStream`): [`UnlockTypes`](api_ref.md#unlocktypes) - -Deserialize the unlock from binary. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :-------------------------------- | -| `readStream` | `ReadStream` | The stream to read the data from. | - -#### Returns - -[`UnlockTypes`](api_ref.md#unlocktypes) - -The deserialized object. - ---- - -### serializeUnlock - -▸ **serializeUnlock**(`writeStream`, `object`): `void` - -Serialize the unlock to binary. - -#### Parameters - -| Name | Type | Description | -| :------------ | :-------------------------------------- | :------------------------------- | -| `writeStream` | `WriteStream` | The stream to write the data to. | -| `object` | [`UnlockTypes`](api_ref.md#unlocktypes) | The object to serialize. | - -#### Returns - -`void` - ---- - -### addressBalance - -▸ **addressBalance**(`client`, `addressBech32`): `Promise`<{}\> - -Get the balance for an address. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :--------------------------------------------- | :------------------------------------------------------- | -| `client` | `string` \| [`IClient`](interfaces/IClient.md) | The client or node endpoint to get the information from. | -| `addressBech32` | `string` | The address to get the balances for. | - -#### Returns - -`Promise`<{}\> - -The balance. - ---- - -### generateBip44Path - -▸ **generateBip44Path**(`accountIndex`, `addressIndex`, `isInternal`): `Bip32Path` - -Generate a bip44 path based on all its parts. - -#### Parameters - -| Name | Type | Description | -| :------------- | :-------- | :--------------------------- | -| `accountIndex` | `number` | The account index. | -| `addressIndex` | `number` | The address index. | -| `isInternal` | `boolean` | Is this an internal address. | - -#### Returns - -`Bip32Path` - -The generated address. - ---- - -### generateBip44Address - -▸ **generateBip44Address**(`generatorState`): `string` - -Generate addresses based on the account indexing style. - -#### Parameters - -| Name | Type | Description | -| :--------------- | :----------------------------------------------------------- | :----------------- | -| `generatorState` | [`IBip44GeneratorState`](interfaces/IBip44GeneratorState.md) | The address state. | - -#### Returns - -`string` - -The key pair for the address. - ---- - -### getBalance - -▸ **getBalance**(`client`, `seed`, `accountIndex`, `addressOptions?`): `Promise`<`BigInteger`\> - -Get the balance for a list of addresses. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :--------------------------------------------- | :---------------------------------------------------------- | -| `client` | `string` \| [`IClient`](interfaces/IClient.md) | The client or node endpoint to send the transfer with. | -| `seed` | [`ISeed`](interfaces/ISeed.md) | The seed. | -| `accountIndex` | `number` | The account index in the wallet. | -| `addressOptions?` | `Object` | Optional address configuration for balance address lookups. | - -#### Returns - -`Promise`<`BigInteger`\> - -The balance. - ---- - -### getUnspentAddress - -▸ **getUnspentAddress**(`client`, `seed`, `accountIndex`, `addressOptions?`): `Promise`<{} \| `undefined`\> - -Get the first unspent address. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :--------------------------------------------- | :---------------------------------------------------------- | -| `client` | `string` \| [`IClient`](interfaces/IClient.md) | The client or node endpoint to send the transfer with. | -| `seed` | [`ISeed`](interfaces/ISeed.md) | The seed to use for address generation. | -| `accountIndex` | `number` | The account index in the wallet. | -| `addressOptions?` | `Object` | Optional address configuration for balance address lookups. | - -#### Returns - -`Promise`<{} \| `undefined`\> - -The first unspent address. - ---- - -### getUnspentAddresses - -▸ **getUnspentAddresses**(`client`, `seed`, `accountIndex`, `addressOptions?`): `Promise`<{}[]\> - -Get all the unspent addresses. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :--------------------------------------------- | :---------------------------------------------------------- | -| `client` | `string` \| [`IClient`](interfaces/IClient.md) | The client or node endpoint to send the transfer with. | -| `seed` | [`ISeed`](interfaces/ISeed.md) | The seed to use for address generation. | -| `accountIndex` | `number` | The account index in the wallet. | -| `addressOptions?` | `Object` | Optional address configuration for balance address lookups. | - -#### Returns - -`Promise`<{}[]\> - -All the unspent addresses. - ---- - -### getUnspentAddressesWithAddressGenerator - -▸ **getUnspentAddressesWithAddressGenerator**<`T`\>(`client`, `seed`, `initialAddressState`, `nextAddressPath`, `addressOptions?`): `Promise`<{}[]\> - -Get all the unspent addresses using an address generator. - -#### Type parameters - -| Name | -| :--- | -| `T` | - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :--------------------------------------------- | :---------------------------------------------------------- | -| `client` | `string` \| [`IClient`](interfaces/IClient.md) | The client or node endpoint to get the addresses from. | -| `seed` | [`ISeed`](interfaces/ISeed.md) | The seed to use for address generation. | -| `initialAddressState` | `T` | The initial address state for calculating the addresses. | -| `nextAddressPath` | (`addressState`: `T`) => `string` | Calculate the next address for inputs. | -| `addressOptions?` | `Object` | Optional address configuration for balance address lookups. | - -#### Returns - -`Promise`<{}[]\> - -All the unspent addresses. - ---- - -### promote - -▸ **promote**(`client`, `blockId`): `Promise`<{}\> - -Promote an existing block. - -#### Parameters - -| Name | Type | Description | -| :-------- | :--------------------------------------------- | :------------------------------------------------------ | -| `client` | `string` \| [`IClient`](interfaces/IClient.md) | The clientor node endpoint to perform the promote with. | -| `blockId` | `string` | The block to promote. | - -#### Returns - -`Promise`<{}\> - -The id and block that were promoted. - ---- - -### reattach - -▸ **reattach**(`client`, `blockId`): `Promise`<{}\> - -Reattach an existing block. - -#### Parameters - -| Name | Type | Description | -| :-------- | :--------------------------------------------- | :-------------------------------------------------------- | -| `client` | `string` \| [`IClient`](interfaces/IClient.md) | The client or node endpoint to perform the reattach with. | -| `blockId` | `string` | The block to reattach. | - -#### Returns - -`Promise`<{}\> - -The id and block that were reattached. - ---- - -### retrieveData - -▸ **retrieveData**(`client`, `blockId`): `Promise`<{} \| `undefined`\> - -Retrieve a data block. - -#### Parameters - -| Name | Type | Description | -| :-------- | :--------------------------------------------- | :----------------------------------------------------- | -| `client` | `string` \| [`IClient`](interfaces/IClient.md) | The client or node endpoint to retrieve the data with. | -| `blockId` | `string` | The block id of the data to get. | - -#### Returns - -`Promise`<{} \| `undefined`\> - -The block tag and data. - ---- - -### retry - -▸ **retry**(`client`, `blockId`): `Promise`<{}\> - -Retry an existing block either by promoting or reattaching. - -#### Parameters - -| Name | Type | Description | -| :-------- | :--------------------------------------------- | :----------------------------------------------------- | -| `client` | `string` \| [`IClient`](interfaces/IClient.md) | The client or node endpoint to perform the retry with. | -| `blockId` | `string` | The block to retry. | - -#### Returns - -`Promise`<{}\> - -The id and block that were retried. - ---- - -### send - -▸ **send**(`client`, `seed`, `accountIndex`, `addressBech32`, `amount`, `taggedData?`, `addressOptions?`): `Promise`<{}\> - -Send a transfer from the balance on the seed to a single output. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :--------------------------------------------- | :---------------------------------------------------------- | -| `client` | `string` \| [`IClient`](interfaces/IClient.md) | The client or node endpoint to send the transfer with. | -| `seed` | [`ISeed`](interfaces/ISeed.md) | The seed to use for address generation. | -| `accountIndex` | `number` | The account index in the wallet. | -| `addressBech32` | `string` | The address to send the funds to in bech32 format. | -| `amount` | `BigInteger` | The amount to send. | -| `taggedData?` | `Object` | Optional tagged data to associate with the transaction. | -| `addressOptions?` | `Object` | Optional address configuration for balance address lookups. | - -#### Returns - -`Promise`<{}\> - -The id of the block created and the contructed block. - ---- - -### sendEd25519 - -▸ **sendEd25519**(`client`, `seed`, `accountIndex`, `addressEd25519`, `amount`, `taggedData?`, `addressOptions?`): `Promise`<{}\> - -Send a transfer from the balance on the seed to a single output. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :--------------------------------------------- | :---------------------------------------------------------- | -| `client` | `string` \| [`IClient`](interfaces/IClient.md) | The client or node endpoint to send the transfer with. | -| `seed` | [`ISeed`](interfaces/ISeed.md) | The seed to use for address generation. | -| `accountIndex` | `number` | The account index in the wallet. | -| `addressEd25519` | `string` | The address to send the funds to in ed25519 format. | -| `amount` | `BigInteger` | The amount to send. | -| `taggedData?` | `Object` | Optional tagged data to associate with the transaction. | -| `addressOptions?` | `Object` | Optional address configuration for balance address lookups. | - -#### Returns - -`Promise`<{}\> - -The id of the block created and the contructed block. - ---- - -### sendMultiple - -▸ **sendMultiple**(`client`, `seed`, `accountIndex`, `outputs`, `taggedData?`, `addressOptions?`): `Promise`<{}\> - -Send a transfer from the balance on the seed to multiple outputs. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :--------------------------------------------- | :------------------------------------------------------------- | -| `client` | `string` \| [`IClient`](interfaces/IClient.md) | The client or node endpoint to send the transfer with. | -| `seed` | [`ISeed`](interfaces/ISeed.md) | The seed to use for address generation. | -| `accountIndex` | `number` | The account index in the wallet. | -| `outputs` | {}[] | The address to send the funds to in bech32 format and amounts. | -| `taggedData?` | `Object` | Optional tagged data to associate with the transaction. | -| `addressOptions?` | `Object` | Optional address configuration for balance address lookups. | - -#### Returns - -`Promise`<{}\> - -The id of the block created and the contructed block. - ---- - -### sendMultipleEd25519 - -▸ **sendMultipleEd25519**(`client`, `seed`, `accountIndex`, `outputs`, `taggedData?`, `addressOptions?`): `Promise`<{}\> - -Send a transfer from the balance on the seed. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :--------------------------------------------- | :------------------------------------------------------------------------------- | -| `client` | `string` \| [`IClient`](interfaces/IClient.md) | The client or node endpoint to send the transfer with. | -| `seed` | [`ISeed`](interfaces/ISeed.md) | The seed to use for address generation. | -| `accountIndex` | `number` | The account index in the wallet. | -| `outputs` | {}[] | The outputs including address to send the funds to in ed25519 format and amount. | -| `taggedData?` | `Object` | Optional tagged data to associate with the transaction. | -| `addressOptions?` | `Object` | Optional address configuration for balance address lookups. | - -#### Returns - -`Promise`<{}\> - -The id of the block created and the contructed block. - ---- - -### sendWithAddressGenerator - -▸ **sendWithAddressGenerator**<`T`\>(`client`, `seed`, `initialAddressState`, `nextAddressPath`, `outputs`, `taggedData?`, `zeroCount?`): `Promise`<{}\> - -Send a transfer using account based indexing for the inputs. - -#### Type parameters - -| Name | -| :--- | -| `T` | - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :--------------------------------------------- | :-------------------------------------------------------------------- | -| `client` | `string` \| [`IClient`](interfaces/IClient.md) | The client or node endpoint to send the transfer with. | -| `seed` | [`ISeed`](interfaces/ISeed.md) | The seed to use for address generation. | -| `initialAddressState` | `T` | The initial address state for calculating the addresses. | -| `nextAddressPath` | (`addressState`: `T`) => `string` | Calculate the next address for inputs. | -| `outputs` | {}[] | The address to send the funds to in bech32 format and amounts. | -| `taggedData?` | `Object` | Optional tagged data to associate with the transaction. | -| `zeroCount?` | `number` | The number of addresses with 0 balance during lookup before aborting. | - -#### Returns - -`Promise`<{}\> - -The id of the block created and the contructed block. - ---- - -### calculateInputs - -▸ **calculateInputs**<`T`\>(`client`, `seed`, `initialAddressState`, `nextAddressPath`, `outputs`, `zeroCount?`): `Promise`<{}[]\> - -Calculate the inputs from the seed and basePath. - -#### Type parameters - -| Name | -| :--- | -| `T` | - -#### Parameters - -| Name | Type | Default value | Description | -| :-------------------- | :--------------------------------------------- | :------------ | :-------------------------------------------------------- | -| `client` | `string` \| [`IClient`](interfaces/IClient.md) | `undefined` | The client or node endpoint to calculate the inputs with. | -| `seed` | [`ISeed`](interfaces/ISeed.md) | `undefined` | The seed to use for address generation. | -| `initialAddressState` | `T` | `undefined` | The initial address state for calculating the addresses. | -| `nextAddressPath` | (`addressState`: `T`) => `string` | `undefined` | Calculate the next address for inputs. | -| `outputs` | {}[] | `undefined` | The outputs to send. | -| `zeroCount` | `number` | `5` | Abort when the number of zero balances is exceeded. | - -#### Returns - -`Promise`<{}[]\> - -The id of the block created and the contructed block. - ---- - -### sendAdvanced - -▸ **sendAdvanced**(`client`, `inputsAndSignatureKeyPairs`, `outputs`, `taggedData?`): `Promise`<{}\> - -Send a transfer from the balance on the seed. - -#### Parameters - -| Name | Type | Description | -| :--------------------------- | :--------------------------------------------- | :---------------------------------------------------------------- | -| `client` | `string` \| [`IClient`](interfaces/IClient.md) | The client or node endpoint to send the transfer with. | -| `inputsAndSignatureKeyPairs` | {}[] | The inputs with the signature key pairs needed to sign transfers. | -| `outputs` | {}[] | The outputs to send. | -| `taggedData?` | `Object` | Optional tagged data to associate with the transaction. | - -#### Returns - -`Promise`<{}\> - -The id of the block created and the remainder address if one was needed. - ---- - -### buildTransactionPayload - -▸ **buildTransactionPayload**(`networkId`, `inputsAndSignatureKeyPairs`, `outputs`, `taggedData?`): [`ITransactionPayload`](interfaces/ITransactionPayload.md) - -Build a transaction payload. - -#### Parameters - -| Name | Type | Description | -| :--------------------------- | :------- | :---------------------------------------------------------------- | -| `networkId` | `string` | The network id we are sending the payload on. | -| `inputsAndSignatureKeyPairs` | {}[] | The inputs with the signature key pairs needed to sign transfers. | -| `outputs` | {}[] | The outputs to send. | -| `taggedData?` | `Object` | Optional tagged data to associate with the transaction. | - -#### Returns - -[`ITransactionPayload`](interfaces/ITransactionPayload.md) - -The transaction payload. - ---- - -### sendData - -▸ **sendData**(`client`, `tag?`, `data?`): `Promise`<{}\> - -Send a data block. - -#### Parameters - -| Name | Type | Description | -| :------- | :--------------------------------------------- | :------------------------------------------------- | -| `client` | `string` \| [`IClient`](interfaces/IClient.md) | The client or node endpoint to send the data with. | -| `tag?` | `string` \| `Uint8Array` | The tag for the data. | -| `data?` | `string` \| `Uint8Array` | The data as either UTF8 text or Uint8Array bytes. | - -#### Returns - -`Promise`<{}\> - -The id of the block created and the block. - ---- - -### setLogger - -▸ **setLogger**(`log`): `void` - -Set the logger for output. - -#### Parameters - -| Name | Type | Description | -| :---- | :-------------------------------------------------- | :---------- | -| `log` | (`message`: `string`, `data?`: `unknown`) => `void` | The logger. | - -#### Returns - -`void` - ---- - -### logRoutes - -▸ **logRoutes**(`prefix`, `routes`): `void` - -Log the routes of the node. - -#### Parameters - -| Name | Type | Description | -| :------- | :------------------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `routes` | [`IRoutesResponse`](interfaces/IRoutesResponse.md) | The available routes. | - -#### Returns - -`void` - ---- - -### logInfo - -▸ **logInfo**(`prefix`, `info`): `void` - -Log the node information. - -#### Parameters - -| Name | Type | Description | -| :------- | :------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `info` | [`INodeInfo`](interfaces/INodeInfo.md) | The info to log. | - -#### Returns - -`void` - ---- - -### logTips - -▸ **logTips**(`prefix`, `tipsResponse`): `void` - -Log the tips information. - -#### Parameters - -| Name | Type | Description | -| :------------- | :--------------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `tipsResponse` | [`ITipsResponse`](interfaces/ITipsResponse.md) | The tips to log. | - -#### Returns - -`void` - ---- - -### logBlock - -▸ **logBlock**(`prefix`, `block`): `void` - -Log a block to the console. - -#### Parameters - -| Name | Type | Description | -| :------- | :------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `block` | [`IBlock`](interfaces/IBlock.md) | The block to log. | - -#### Returns - -`void` - ---- - -### logBlockMetadata - -▸ **logBlockMetadata**(`prefix`, `blockMetadata`): `void` - -Log the block metadata to the console. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :----------------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `blockMetadata` | [`IBlockMetadata`](interfaces/IBlockMetadata.md) | The blockMetadata to log. | - -#### Returns - -`void` - ---- - -### logPayload - -▸ **logPayload**(`prefix`, `payload?`): `void` - -Log a block to the console. - -#### Parameters - -| Name | Type | Description | -| :--------- | :---------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `payload?` | [`PayloadTypes`](api_ref.md#payloadtypes) | The payload. | - -#### Returns - -`void` - ---- - -### logTransactionPayload - -▸ **logTransactionPayload**(`prefix`, `payload?`): `void` - -Log a transaction payload to the console. - -#### Parameters - -| Name | Type | Description | -| :--------- | :--------------------------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `payload?` | [`ITransactionPayload`](interfaces/ITransactionPayload.md) | The payload. | - -#### Returns - -`void` - ---- - -### logTaggedDataPayload - -▸ **logTaggedDataPayload**(`prefix`, `payload?`): `void` - -Log a tagged data payload to the console. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `payload?` | [`ITaggedDataPayload`](interfaces/ITaggedDataPayload.md) | The payload. | - -#### Returns - -`void` - ---- - -### logMilestonePayload - -▸ **logMilestonePayload**(`prefix`, `payload?`): `void` - -Log a milestone payload to the console. - -#### Parameters - -| Name | Type | Description | -| :--------- | :----------------------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `payload?` | [`IMilestonePayload`](interfaces/IMilestonePayload.md) | The payload. | - -#### Returns - -`void` - ---- - -### logMilestoneOptions - -▸ **logMilestoneOptions**(`prefix`, `milestoneOptions?`): `void` - -Log milestone options to the console. - -#### Parameters - -| Name | Type | Description | -| :------------------ | :---------------------------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `milestoneOptions?` | [`MilestoneOptionTypes`](api_ref.md#milestoneoptiontypes)[] | The milestone options. | - -#### Returns - -`void` - ---- - -### logMilestoneOption - -▸ **logMilestoneOption**(`prefix`, `milestoneOption`): `void` - -Log milestone option to the console. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :-------------------------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `milestoneOption` | [`MilestoneOptionTypes`](api_ref.md#milestoneoptiontypes) | The milestone option. | - -#### Returns - -`void` - ---- - -### logReceiptMilestoneOption - -▸ **logReceiptMilestoneOption**(`prefix`, `option?`): `void` - -Log a receipt milestone option to the console. - -#### Parameters - -| Name | Type | Description | -| :-------- | :----------------------------------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `option?` | [`IReceiptMilestoneOption`](interfaces/IReceiptMilestoneOption.md) | The option. | - -#### Returns - -`void` - ---- - -### logProtocolParamsMilestoneOption - -▸ **logProtocolParamsMilestoneOption**(`prefix`, `option?`): `void` - -Log a protocol params milestone option to the console. - -#### Parameters - -| Name | Type | Description | -| :-------- | :------------------------------------------------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `option?` | [`IProtocolParamsMilestoneOption`](interfaces/IProtocolParamsMilestoneOption.md) | The option. | - -#### Returns - -`void` - ---- - -### logTreasuryTransactionPayload - -▸ **logTreasuryTransactionPayload**(`prefix`, `payload?`): `void` - -Log a treasury transaction payload to the console. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `payload?` | [`ITreasuryTransactionPayload`](interfaces/ITreasuryTransactionPayload.md) | The payload. | - -#### Returns - -`void` - ---- - -### logAddress - -▸ **logAddress**(`prefix`, `address?`): `void` - -Log an address to the console. - -#### Parameters - -| Name | Type | Description | -| :--------- | :---------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `address?` | [`AddressTypes`](api_ref.md#addresstypes) | The address to log. | - -#### Returns - -`void` - ---- - -### logSignature - -▸ **logSignature**(`prefix`, `signature?`): `void` - -Log signature to the console. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------------------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `signature?` | [`IEd25519Signature`](interfaces/IEd25519Signature.md) | The signature to log. | - -#### Returns - -`void` - ---- - -### logInput - -▸ **logInput**(`prefix`, `input?`): `void` - -Log input to the console. - -#### Parameters - -| Name | Type | Description | -| :------- | :------------------------------------ | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `input?` | [`InputTypes`](api_ref.md#inputtypes) | The input to log. | - -#### Returns - -`void` - ---- - -### logOutput - -▸ **logOutput**(`prefix`, `output?`): `void` - -Log output to the console. - -#### Parameters - -| Name | Type | Description | -| :-------- | :-------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `output?` | [`OutputTypes`](api_ref.md#outputtypes) | The output to log. | - -#### Returns - -`void` - ---- - -### logUnlock - -▸ **logUnlock**(`prefix`, `unlock?`): `void` - -Log unlock to the console. - -#### Parameters - -| Name | Type | Description | -| :-------- | :-------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `unlock?` | [`UnlockTypes`](api_ref.md#unlocktypes) | The unlock to log. | - -#### Returns - -`void` - ---- - -### logFunds - -▸ **logFunds**(`prefix`, `fund?`): `void` - -Log fund to the console. - -#### Parameters - -| Name | Type | Description | -| :------- | :----------------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `fund?` | [`IMigratedFunds`](interfaces/IMigratedFunds.md) | The fund to log. | - -#### Returns - -`void` - ---- - -### logNativeTokens - -▸ **logNativeTokens**(`prefix`, `nativeTokens`): `void` - -Log native tokens to the console. - -#### Parameters - -| Name | Type | Description | -| :------------- | :------------------------------------------------------------ | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `nativeTokens` | `undefined` \| [`INativeToken`](interfaces/INativeToken.md)[] | The native tokens. | - -#### Returns - -`void` - ---- - -### logTokenScheme - -▸ **logTokenScheme**(`prefix`, `tokenScheme`): `void` - -Log token scheme to the console. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `tokenScheme` | [`ISimpleTokenScheme`](interfaces/ISimpleTokenScheme.md) | The token scheme. | - -#### Returns - -`void` - ---- - -### logFeatures - -▸ **logFeatures**(`prefix`, `features`): `void` - -Log featurew to the console. - -#### Parameters - -| Name | Type | Description | -| :--------- | :--------------------------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `features` | `undefined` \| [`FeatureTypes`](api_ref.md#featuretypes)[] | The features. | - -#### Returns - -`void` - ---- - -### logImmutableFeatures - -▸ **logImmutableFeatures**(`prefix`, `immutableFeatures`): `void` - -Log immutable featuress to the console. - -#### Parameters - -| Name | Type | Description | -| :------------------ | :--------------------------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `immutableFeatures` | `undefined` \| [`FeatureTypes`](api_ref.md#featuretypes)[] | The features. | - -#### Returns - -`void` - ---- - -### logFeature - -▸ **logFeature**(`prefix`, `feature`): `void` - -Log feature to the console. - -#### Parameters - -| Name | Type | Description | -| :-------- | :---------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `feature` | [`FeatureTypes`](api_ref.md#featuretypes) | The feature. | - -#### Returns - -`void` - ---- - -### logUnlockConditions - -▸ **logUnlockConditions**(`prefix`, `unlockConditions`): `void` - -Log unlock conditions to the console. - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `unlockConditions` | [`UnlockConditionTypes`](api_ref.md#unlockconditiontypes)[] | The unlock conditions. | - -#### Returns - -`void` - ---- - -### logUnlockCondition - -▸ **logUnlockCondition**(`prefix`, `unlockCondition`): `void` - -Log feature block to the console. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :-------------------------------------------------------- | :------------------------- | -| `prefix` | `string` | The prefix for the output. | -| `unlockCondition` | [`UnlockConditionTypes`](api_ref.md#unlockconditiontypes) | The unlock condition. | - -#### Returns - -`void` - ---- - -### milestoneIdFromMilestonePayload - -▸ **milestoneIdFromMilestonePayload**(`payload`): `string` - -Compute a milestoneId from a milestone payload. - -#### Parameters - -| Name | Type | Description | -| :-------- | :----------------------------------------------------- | :--------------------- | -| `payload` | [`IMilestonePayload`](interfaces/IMilestonePayload.md) | The milestone payload. | - -#### Returns - -`string` - -The milestone id hex prefixed string. - ---- - -### blockIdFromMilestonePayload - -▸ **blockIdFromMilestonePayload**(`protocolVersion`, `payload`): `string` - -Compute a blockId from a milestone payload. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :----------------------------------------------------- | :--------------------------- | -| `protocolVersion` | `number` | The protocol version to use. | -| `payload` | [`IMilestonePayload`](interfaces/IMilestonePayload.md) | The milestone payload. | - -#### Returns - -`string` - -The blockId of the block with the milestone payload. - -## Type Aliases - -### AddressTypes - -Ƭ **AddressTypes**: [`IEd25519Address`](interfaces/IEd25519Address.md) \| [`IAliasAddress`](interfaces/IAliasAddress.md) \| [`INftAddress`](interfaces/INftAddress.md) - -All of the address types. - ---- - -### FeatureTypes - -Ƭ **FeatureTypes**: [`ISenderFeature`](interfaces/ISenderFeature.md) \| [`IIssuerFeature`](interfaces/IIssuerFeature.md) \| [`IMetadataFeature`](interfaces/IMetadataFeature.md) \| [`ITagFeature`](interfaces/ITagFeature.md) - -All of the feature block types. - ---- - -### InputTypes - -Ƭ **InputTypes**: [`IUTXOInput`](interfaces/IUTXOInput.md) \| [`ITreasuryInput`](interfaces/ITreasuryInput.md) - -All of the input types. - ---- - -### LedgerInclusionState - -Ƭ **LedgerInclusionState**: `"noTransaction"` \| `"included"` \| `"conflicting"` - -The different states of ledger inclusion. - ---- - -### Magnitudes - -Ƭ **Magnitudes**: `"P"` \| `"T"` \| `"G"` \| `"M"` \| `"K"` \| `""` - -Magnitudes for the numbers. - ---- - -### MilestoneOptionTypes - -Ƭ **MilestoneOptionTypes**: [`IReceiptMilestoneOption`](interfaces/IReceiptMilestoneOption.md) \| [`IProtocolParamsMilestoneOption`](interfaces/IProtocolParamsMilestoneOption.md) - -All of the milestone option types. - ---- - -### OutputTypes - -Ƭ **OutputTypes**: [`ITreasuryOutput`](interfaces/ITreasuryOutput.md) \| [`IBasicOutput`](interfaces/IBasicOutput.md) \| [`IAliasOutput`](interfaces/IAliasOutput.md) \| [`IFoundryOutput`](interfaces/IFoundryOutput.md) \| [`INftOutput`](interfaces/INftOutput.md) - -All of the output types. - ---- - -### PayloadTypes - -Ƭ **PayloadTypes**: [`ITransactionPayload`](interfaces/ITransactionPayload.md) \| [`IMilestonePayload`](interfaces/IMilestonePayload.md) \| [`ITreasuryTransactionPayload`](interfaces/ITreasuryTransactionPayload.md) \| [`ITaggedDataPayload`](interfaces/ITaggedDataPayload.md) - -All of the payload types. - ---- - -### SignatureTypes - -Ƭ **SignatureTypes**: [`IEd25519Signature`](interfaces/IEd25519Signature.md) - -All of the signature types. - ---- - -### TokenSchemeTypes - -Ƭ **TokenSchemeTypes**: [`ISimpleTokenScheme`](interfaces/ISimpleTokenScheme.md) - -All of the token scheme types. - ---- - -### UnlockConditionTypes - -Ƭ **UnlockConditionTypes**: [`IAddressUnlockCondition`](interfaces/IAddressUnlockCondition.md) \| [`IStorageDepositReturnUnlockCondition`](interfaces/IStorageDepositReturnUnlockCondition.md) \| [`ITimelockUnlockCondition`](interfaces/ITimelockUnlockCondition.md) \| [`IExpirationUnlockCondition`](interfaces/IExpirationUnlockCondition.md) \| [`IStateControllerAddressUnlockCondition`](interfaces/IStateControllerAddressUnlockCondition.md) \| [`IGovernorAddressUnlockCondition`](interfaces/IGovernorAddressUnlockCondition.md) \| [`IImmutableAliasUnlockCondition`](interfaces/IImmutableAliasUnlockCondition.md) - -All of the unlock condition types. - ---- - -### UnlockTypes - -Ƭ **UnlockTypes**: [`ISignatureUnlock`](interfaces/ISignatureUnlock.md) \| [`IReferenceUnlock`](interfaces/IReferenceUnlock.md) \| [`IAliasUnlock`](interfaces/IAliasUnlock.md) \| [`INftUnlock`](interfaces/INftUnlock.md) - -All of the unlock types. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/B1T6.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/B1T6.md deleted file mode 100644 index e8ce9f17dba..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/B1T6.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: B1T6 - -Class implements the b1t6 encoding encoding which uses a group of 6 trits to encode each byte. - -## Table of contents - -### Methods - -- [encodedLen](B1T6.md#encodedlen) -- [encode](B1T6.md#encode) - -### Constructors - -- [constructor](B1T6.md#constructor) - -## Methods - -### encodedLen - -▸ `Static` **encodedLen**(`data`): `number` - -The encoded length of the data. - -#### Parameters - -| Name | Type | Description | -| :----- | :----------- | :---------- | -| `data` | `Uint8Array` | The data. | - -#### Returns - -`number` - -The encoded length. - ---- - -### encode - -▸ `Static` **encode**(`dst`, `startIndex`, `src`): `number` - -Encode a byte array into trits. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :------------------------------------- | -| `dst` | `Int8Array` | The destination array. | -| `startIndex` | `number` | The start index to write in the array. | -| `src` | `Uint8Array` | The source data. | - -#### Returns - -`number` - -The length of the encode. - -## Constructors - -### constructor - -• **new B1T6**() diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/Bech32Helper.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/Bech32Helper.md deleted file mode 100644 index 63a363b00bb..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/Bech32Helper.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: Bech32Helper - -Convert address to bech32. - -## Table of contents - -### Properties - -- [BECH32_DEFAULT_HRP_MAIN](Bech32Helper.md#bech32_default_hrp_main) -- [BECH32_DEFAULT_HRP_DEV](Bech32Helper.md#bech32_default_hrp_dev) - -### Methods - -- [toBech32](Bech32Helper.md#tobech32) -- [fromBech32](Bech32Helper.md#frombech32) -- [addressFromBech32](Bech32Helper.md#addressfrombech32) -- [matches](Bech32Helper.md#matches) - -### Constructors - -- [constructor](Bech32Helper.md#constructor) - -## Properties - -### BECH32_DEFAULT_HRP_MAIN - -▪ `Static` **BECH32_DEFAULT_HRP_MAIN**: `string` = `"iota"` - -The default human readable part of the bech32 addresses for mainnet, currently 'iota'. - ---- - -### BECH32_DEFAULT_HRP_DEV - -▪ `Static` **BECH32_DEFAULT_HRP_DEV**: `string` = `"atoi"` - -The default human readable part of the bech32 addresses for devnet, currently 'atoi'. - -## Methods - -### toBech32 - -▸ `Static` **toBech32**(`addressType`, `addressBytes`, `humanReadablePart`): `string` - -Encode an address to bech32. - -#### Parameters - -| Name | Type | Description | -| :------------------ | :----------- | :------------------------------ | -| `addressType` | `number` | The address type to encode. | -| `addressBytes` | `Uint8Array` | The address bytes to encode. | -| `humanReadablePart` | `string` | The human readable part to use. | - -#### Returns - -`string` - -The array formated as hex. - ---- - -### fromBech32 - -▸ `Static` **fromBech32**(`bech32Text`, `humanReadablePart`): `undefined` \| {} - -Decode an address from bech32. - -#### Parameters - -| Name | Type | Description | -| :------------------ | :------- | :------------------------------ | -| `bech32Text` | `string` | The bech32 text to decode. | -| `humanReadablePart` | `string` | The human readable part to use. | - -#### Returns - -`undefined` \| {} - -The address type and address bytes or undefined if it cannot be decoded. - ---- - -### addressFromBech32 - -▸ `Static` **addressFromBech32**(`bech32Address`, `humanReadablePart`): [`AddressTypes`](../api_ref.md#addresstypes) - -Decode an address from bech32. - -#### Parameters - -| Name | Type | Description | -| :------------------ | :------- | :------------------------------ | -| `bech32Address` | `string` | The bech32 address to decode. | -| `humanReadablePart` | `string` | The human readable part to use. | - -#### Returns - -[`AddressTypes`](../api_ref.md#addresstypes) - -The address type. - ---- - -### matches - -▸ `Static` **matches**(`bech32Text`, `humanReadablePart`): `boolean` - -Does the provided string look like it might be an bech32 address with matching hrp. - -#### Parameters - -| Name | Type | Description | -| :------------------ | :------- | :-------------------------------- | -| `bech32Text` | `string` | The bech32 text to text. | -| `humanReadablePart` | `string` | The human readable part to match. | - -#### Returns - -`boolean` - -True if the passed address matches the pattern for a bech32 address. - -## Constructors - -### constructor - -• **new Bech32Helper**() diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/ClientError.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/ClientError.md deleted file mode 100644 index aca9bededc4..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/ClientError.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: ClientError - -Class to represent errors from Client. - -## Hierarchy - -- `Error` - - ↳ **`ClientError`** - -## Table of contents - -### Methods - -- [captureStackTrace](ClientError.md#capturestacktrace) - -### Properties - -- [prepareStackTrace](ClientError.md#preparestacktrace) -- [route](ClientError.md#route) -- [httpStatus](ClientError.md#httpstatus) -- [code](ClientError.md#code) - -### Constructors - -- [constructor](ClientError.md#constructor) - -## Methods - -### captureStackTrace - -▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -Error.captureStackTrace - -## Properties - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -##### Parameters - -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -##### Returns - -`any` - -#### Inherited from - -Error.prepareStackTrace - ---- - -### route - -• **route**: `string` - -The route the request was made to. - ---- - -### httpStatus - -• **httpStatus**: `number` - -The HTTP status code returned. - ---- - -### code - -• `Optional` **code**: `string` - -The code return in the payload. - -## Constructors - -### constructor - -• **new ClientError**(`message`, `route`, `httpStatus`, `code?`) - -Create a new instance of ClientError. - -#### Parameters - -| Name | Type | Description | -| :----------- | :------- | :--------------------------------- | -| `message` | `string` | The message for the error. | -| `route` | `string` | The route the request was made to. | -| `httpStatus` | `number` | The http status code. | -| `code?` | `string` | The code in the payload. | - -#### Overrides - -Error.constructor diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/Ed25519Address.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/Ed25519Address.md deleted file mode 100644 index 12557eae7f1..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/Ed25519Address.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: Ed25519Address - -Class to help with Ed25519 Signature scheme. - -## Implements - -- [`IAddress`](../interfaces/IAddress.md) - -## Table of contents - -### Constructors - -- [constructor](Ed25519Address.md#constructor) - -### Methods - -- [toAddress](Ed25519Address.md#toaddress) -- [verify](Ed25519Address.md#verify) - -## Constructors - -### constructor - -• **new Ed25519Address**(`publicKey`) - -Create a new instance of Ed25519Address. - -#### Parameters - -| Name | Type | Description | -| :---------- | :----------- | :------------------------------ | -| `publicKey` | `Uint8Array` | The public key for the address. | - -## Methods - -### toAddress - -▸ **toAddress**(): `Uint8Array` - -Convert the public key to an address. - -#### Returns - -`Uint8Array` - -The address. - -#### Implementation of - -[IAddress](../interfaces/IAddress.md).[toAddress](../interfaces/IAddress.md#toaddress) - ---- - -### verify - -▸ **verify**(`address`): `boolean` - -Use the public key to validate the address. - -#### Parameters - -| Name | Type | Description | -| :-------- | :----------- | :--------------------- | -| `address` | `Uint8Array` | The address to verify. | - -#### Returns - -`boolean` - -True if the data and address is verified. - -#### Implementation of - -[IAddress](../interfaces/IAddress.md).[verify](../interfaces/IAddress.md#verify) diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/Ed25519Seed.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/Ed25519Seed.md deleted file mode 100644 index eeec9ec59b8..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/Ed25519Seed.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: Ed25519Seed - -Class to help with seeds. - -## Implements - -- [`ISeed`](../interfaces/ISeed.md) - -## Table of contents - -### Constructors - -- [constructor](Ed25519Seed.md#constructor) - -### Methods - -- [fromMnemonic](Ed25519Seed.md#frommnemonic) -- [keyPair](Ed25519Seed.md#keypair) -- [generateSeedFromPath](Ed25519Seed.md#generateseedfrompath) -- [toBytes](Ed25519Seed.md#tobytes) - -## Constructors - -### constructor - -• **new Ed25519Seed**(`secretKeyBytes?`) - -Create a new instance of Ed25519Seed. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :----------- | :---------- | -| `secretKeyBytes?` | `Uint8Array` | The bytes. | - -## Methods - -### fromMnemonic - -▸ `Static` **fromMnemonic**(`mnemonic`): [`Ed25519Seed`](Ed25519Seed.md) - -Create the seed from a Bip39 mnemonic. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :------------------------------------ | -| `mnemonic` | `string` | The mnemonic to create the seed from. | - -#### Returns - -[`Ed25519Seed`](Ed25519Seed.md) - -A new instance of Ed25519Seed. - ---- - -### keyPair - -▸ **keyPair**(): [`IKeyPair`](../interfaces/IKeyPair.md) - -Get the key pair from the seed. - -#### Returns - -[`IKeyPair`](../interfaces/IKeyPair.md) - -The key pair. - -#### Implementation of - -[ISeed](../interfaces/ISeed.md).[keyPair](../interfaces/ISeed.md#keypair) - ---- - -### generateSeedFromPath - -▸ **generateSeedFromPath**(`path`): [`ISeed`](../interfaces/ISeed.md) - -Generate a new seed from the path. - -#### Parameters - -| Name | Type | Description | -| :----- | :---------- | :--------------------------------- | -| `path` | `Bip32Path` | The path to generate the seed for. | - -#### Returns - -[`ISeed`](../interfaces/ISeed.md) - -The generated seed. - -#### Implementation of - -[ISeed](../interfaces/ISeed.md).[generateSeedFromPath](../interfaces/ISeed.md#generateseedfrompath) - ---- - -### toBytes - -▸ **toBytes**(): `Uint8Array` - -Return the key as bytes. - -#### Returns - -`Uint8Array` - -The key as bytes. - -#### Implementation of - -[ISeed](../interfaces/ISeed.md).[toBytes](../interfaces/ISeed.md#tobytes) diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/IndexerPluginClient.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/IndexerPluginClient.md deleted file mode 100644 index fae1b5060a8..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/IndexerPluginClient.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: IndexerPluginClient - -Indexer plugin which provides access to the indexer plugin API. - -## Table of contents - -### Constructors - -- [constructor](IndexerPluginClient.md#constructor) - -### Methods - -- [basicOutputs](IndexerPluginClient.md#basicOutputs) -- [aliases](IndexerPluginClient.md#aliases) -- [alias](IndexerPluginClient.md#alias) -- [nfts](IndexerPluginClient.md#nfts) -- [nft](IndexerPluginClient.md#nft) -- [foundries](IndexerPluginClient.md#foundries) -- [foundry](IndexerPluginClient.md#foundry) - -## Constructors - -### constructor - -• **new IndexerPluginClient**(`client`, `options?`) - -Create a new instance of IndexerPluginClient. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------ | :----------------------------- | -| `client` | `string` \| [`IClient`](../interfaces/IClient.md) | The client for communications. | -| `options?` | `Object` | Options for the plugin. | - -## Methods - -### basicOutputs - -▸ **outputs**(`filterOptions?`): `Promise`<[`IOutputsResponse`](../interfaces/IOutputsResponse.md)\> - -Find outputs using filter options. - -#### Parameters - -| Name | Type | Description | -| :--------------- | :------- | :------------------------- | -| `filterOptions?` | `Object` | The options for filtering. | - -#### Returns - -`Promise`<[`IOutputsResponse`](../interfaces/IOutputsResponse.md)\> - -The outputs with the requested filters. - ---- - -### aliases - -▸ **aliases**(`filterOptions?`): `Promise`<[`IOutputsResponse`](../interfaces/IOutputsResponse.md)\> - -Find alises using filter options. - -#### Parameters - -| Name | Type | Description | -| :--------------- | :------- | :------------------------- | -| `filterOptions?` | `Object` | The options for filtering. | - -#### Returns - -`Promise`<[`IOutputsResponse`](../interfaces/IOutputsResponse.md)\> - -The outputs with the requested filters. - ---- - -### alias - -▸ **alias**(`aliasId`): `Promise`<[`IOutputsResponse`](../interfaces/IOutputsResponse.md)\> - -Get the output for an alias. - -#### Parameters - -| Name | Type | Description | -| :-------- | :------- | :------------------------------- | -| `aliasId` | `string` | The alias to get the output for. | - -#### Returns - -`Promise`<[`IOutputsResponse`](../interfaces/IOutputsResponse.md)\> - -The output. - ---- - -### nfts - -▸ **nfts**(`filterOptions?`): `Promise`<[`IOutputsResponse`](../interfaces/IOutputsResponse.md)\> - -Find nfts using filter options. - -#### Parameters - -| Name | Type | Description | -| :--------------- | :------- | :------------------------- | -| `filterOptions?` | `Object` | The options for filtering. | - -#### Returns - -`Promise`<[`IOutputsResponse`](../interfaces/IOutputsResponse.md)\> - -The outputs with the requested filters. - ---- - -### nft - -▸ **nft**(`nftId`): `Promise`<[`IOutputsResponse`](../interfaces/IOutputsResponse.md)\> - -Get the output for a nft. - -#### Parameters - -| Name | Type | Description | -| :------ | :------- | :----------------------------- | -| `nftId` | `string` | The nft to get the output for. | - -#### Returns - -`Promise`<[`IOutputsResponse`](../interfaces/IOutputsResponse.md)\> - -The output. - ---- - -### foundries - -▸ **foundries**(`filterOptions?`): `Promise`<[`IOutputsResponse`](../interfaces/IOutputsResponse.md)\> - -Find foundries using filter options. - -#### Parameters - -| Name | Type | Description | -| :--------------- | :------- | :------------------------- | -| `filterOptions?` | `Object` | The options for filtering. | - -#### Returns - -`Promise`<[`IOutputsResponse`](../interfaces/IOutputsResponse.md)\> - -The outputs with the requested filters. - ---- - -### foundry - -▸ **foundry**(`foundryId`): `Promise`<[`IOutputsResponse`](../interfaces/IOutputsResponse.md)\> - -Get the output for a foundry. - -#### Parameters - -| Name | Type | Description | -| :---------- | :------- | :--------------------------------- | -| `foundryId` | `string` | The foundry to get the output for. | - -#### Returns - -`Promise`<[`IOutputsResponse`](../interfaces/IOutputsResponse.md)\> - -The output. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/LocalPowProvider.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/LocalPowProvider.md deleted file mode 100644 index fe3879c2fe3..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/LocalPowProvider.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: LocalPowProvider - -Local POW Provider. -WARNING - This is really slow. - -## Implements - -- [`IPowProvider`](../interfaces/IPowProvider.md) - -## Table of contents - -### Methods - -- [pow](LocalPowProvider.md#pow) - -## Methods - -### pow - -▸ **pow**(`block`, `targetScore`): `Promise`<`string`\> - -Perform pow on the block and return the nonce of at least targetScore. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------- | :-------------------- | -| `block` | `Uint8Array` | The block to process. | -| `targetScore` | `number` | The target score. | - -#### Returns - -`Promise`<`string`\> - -The nonce. - -#### Implementation of - -[IPowProvider](../interfaces/IPowProvider.md).[pow](../interfaces/IPowProvider.md#pow) diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/PowHelper.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/PowHelper.md deleted file mode 100644 index 59c4fc439d0..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/PowHelper.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: PowHelper - -Helper methods for POW. - -## Table of contents - -### Properties - -- [LN3](PowHelper.md#ln3) - -### Methods - -- [score](PowHelper.md#score) -- [calculateTargetZeros](PowHelper.md#calculatetargetzeros) -- [trailingZeros](PowHelper.md#trailingzeros) -- [trinaryTrailingZeros](PowHelper.md#trinarytrailingzeros) -- [performPow](PowHelper.md#performpow) - -## Properties - -### LN3 - -▪ `Static` `Readonly` **LN3**: `number` = `1.0986122886681098` - -LN3 Const see https://oeis.org/A002391. -1.098612288668109691395245236922525704647490557822749451734694333 . - -## Methods - -### score - -▸ `Static` **score**(`block`): `number` - -Perform the score calculation. - -#### Parameters - -| Name | Type | Description | -| :------ | :----------- | :-------------------------------- | -| `block` | `Uint8Array` | The data to perform the score on. | - -#### Returns - -`number` - -The score for the data. - ---- - -### calculateTargetZeros - -▸ `Static` **calculateTargetZeros**(`block`, `targetScore`): `number` - -Calculate the number of zeros required to get target score. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------- | :-------------------- | -| `block` | `Uint8Array` | The block to process. | -| `targetScore` | `number` | The target score. | - -#### Returns - -`number` - -The number of zeros to find. - ---- - -### trailingZeros - -▸ `Static` **trailingZeros**(`powDigest`, `nonce`): `number` - -Calculate the trailing zeros. - -#### Parameters - -| Name | Type | Description | -| :---------- | :----------- | :-------------- | -| `powDigest` | `Uint8Array` | The pow digest. | -| `nonce` | `BigInteger` | The nonce. | - -#### Returns - -`number` - -The trailing zeros. - ---- - -### trinaryTrailingZeros - -▸ `Static` **trinaryTrailingZeros**(`trits`, `endPos?`): `number` - -Find the number of trailing zeros. - -#### Parameters - -| Name | Type | Default value | Description | -| :------- | :---------- | :------------- | :------------------------------------------- | -| `trits` | `Int8Array` | `undefined` | The trits to look for zeros. | -| `endPos` | `number` | `trits.length` | The end position to start looking for zeros. | - -#### Returns - -`number` - -The number of trailing zeros. - ---- - -### performPow - -▸ `Static` **performPow**(`powDigest`, `targetZeros`, `startIndex`): `string` - -Perform the hash on the data until we reach target number of zeros. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------- | :------------------------------- | -| `powDigest` | `Uint8Array` | The pow digest. | -| `targetZeros` | `number` | The target number of zeros. | -| `startIndex` | `string` | The index to start looking from. | - -#### Returns - -`string` - -The nonce. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/SingleNodeClient.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/SingleNodeClient.md deleted file mode 100644 index 451c96e6d22..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/SingleNodeClient.md +++ /dev/null @@ -1,710 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: SingleNodeClient - -Client for API communication. - -## Implements - -- [`IClient`](../interfaces/IClient.md) - -## Table of contents - -### Constructors - -- [constructor](SingleNodeClient.md#constructor) - -### Methods - -- [health](SingleNodeClient.md#health) -- [routes](SingleNodeClient.md#routes) -- [info](SingleNodeClient.md#info) -- [tips](SingleNodeClient.md#tips) -- [block](SingleNodeClient.md#block) -- [blockMetadata](SingleNodeClient.md#blockmetadata) -- [blockRaw](SingleNodeClient.md#blockraw) -- [blockSubmit](SingleNodeClient.md#blocksubmit) -- [blockSubmitRaw](SingleNodeClient.md#blocksubmitraw) -- [transactionIncludedBlock](SingleNodeClient.md#transactionincludedblock) -- [transactionIncludedBlockRaw](SingleNodeClient.md#transactionincludedblockraw) -- [output](SingleNodeClient.md#output) -- [outputMetadata](SingleNodeClient.md#outputmetadata) -- [outputRaw](SingleNodeClient.md#outputraw) -- [milestoneByIndex](SingleNodeClient.md#milestonebyindex) -- [milestoneByIndexRaw](SingleNodeClient.md#milestonebyindexraw) -- [milestoneUtxoChangesByIndex](SingleNodeClient.md#milestoneutxochangesbyindex) -- [milestoneById](SingleNodeClient.md#milestonebyid) -- [milestoneByIdRaw](SingleNodeClient.md#milestonebyidraw) -- [milestoneUtxoChangesById](SingleNodeClient.md#milestoneutxochangesbyid) -- [treasury](SingleNodeClient.md#treasury) -- [receipts](SingleNodeClient.md#receipts) -- [peers](SingleNodeClient.md#peers) -- [peerAdd](SingleNodeClient.md#peeradd) -- [peerDelete](SingleNodeClient.md#peerdelete) -- [peer](SingleNodeClient.md#peer) -- [protocolInfo](SingleNodeClient.md#protocolinfo) -- [pluginFetch](SingleNodeClient.md#pluginfetch) - -## Constructors - -### constructor - -• **new SingleNodeClient**(`endpoint`, `options?`) - -Create a new instance of client. - -#### Parameters - -| Name | Type | Description | -| :--------- | :-------------------------------------------------------------------- | :---------------------- | -| `endpoint` | `string` | The endpoint. | -| `options?` | [`SingleNodeClientOptions`](../interfaces/SingleNodeClientOptions.md) | Options for the client. | - -## Methods - -### health - -▸ **health**(): `Promise`<`boolean`\> - -Get the health of the node. - -#### Returns - -`Promise`<`boolean`\> - -True if the node is healthy. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[health](../interfaces/IClient.md#health) - ---- - -### routes - -▸ **routes**(): `Promise`<[`IRoutesResponse`](../interfaces/IRoutesResponse.md)\> - -Get the routes the node exposes. - -#### Returns - -`Promise`<[`IRoutesResponse`](../interfaces/IRoutesResponse.md)\> - -The routes. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[routes](../interfaces/IClient.md#routes) - ---- - -### info - -▸ **info**(): `Promise`<[`INodeInfo`](../interfaces/INodeInfo.md)\> - -Get the info about the node. - -#### Returns - -`Promise`<[`INodeInfo`](../interfaces/INodeInfo.md)\> - -The node information. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[info](../interfaces/IClient.md#info) - ---- - -### tips - -▸ **tips**(): `Promise`<[`ITipsResponse`](../interfaces/ITipsResponse.md)\> - -Get the tips from the node. - -#### Returns - -`Promise`<[`ITipsResponse`](../interfaces/ITipsResponse.md)\> - -The tips. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[tips](../interfaces/IClient.md#tips) - ---- - -### block - -▸ **block**(`blockId`): `Promise`<[`IBlock`](../interfaces/IBlock.md)\> - -Get the block data by id. - -#### Parameters - -| Name | Type | Description | -| :-------- | :------- | :----------------------------- | -| `blockId` | `string` | The block to get the data for. | - -#### Returns - -`Promise`<[`IBlock`](../interfaces/IBlock.md)\> - -The block data. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[block](../interfaces/IClient.md#block) - ---- - -### blockMetadata - -▸ **blockMetadata**(`blockId`): `Promise`<[`IBlockMetadata`](../interfaces/IBlockMetadata.md)\> - -Get the block metadata by id. - -#### Parameters - -| Name | Type | Description | -| :-------- | :------- | :--------------------------------- | -| `blockId` | `string` | The block to get the metadata for. | - -#### Returns - -`Promise`<[`IBlockMetadata`](../interfaces/IBlockMetadata.md)\> - -The block metadata. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[blockMetadata](../interfaces/IClient.md#blockmetadata) - ---- - -### blockRaw - -▸ **blockRaw**(`blockId`): `Promise`<`Uint8Array`\> - -Get the block raw data by id. - -#### Parameters - -| Name | Type | Description | -| :-------- | :------- | :----------------------------- | -| `blockId` | `string` | The block to get the data for. | - -#### Returns - -`Promise`<`Uint8Array`\> - -The block raw data. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[blockRaw](../interfaces/IClient.md#blockraw) - ---- - -### blockSubmit - -▸ **blockSubmit**(`blockPartial`): `Promise`<`string`\> - -Submit block. - -#### Parameters - -| Name | Type | Description | -| :------------- | :------- | :--------------------------------------------------------------- | -| `blockPartial` | `Object` | The block to submit (possibly contains only partial block data). | - -#### Returns - -`Promise`<`string`\> - -The blockId. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[blockSubmit](../interfaces/IClient.md#blocksubmit) - ---- - -### blockSubmitRaw - -▸ **blockSubmitRaw**(`block`): `Promise`<`string`\> - -Submit block in raw format. - -#### Parameters - -| Name | Type | Description | -| :------ | :----------- | :------------------- | -| `block` | `Uint8Array` | The block to submit. | - -#### Returns - -`Promise`<`string`\> - -The blockId. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[blockSubmitRaw](../interfaces/IClient.md#blocksubmitraw) - ---- - -### transactionIncludedBlock - -▸ **transactionIncludedBlock**(`transactionId`): `Promise`<[`IBlock`](../interfaces/IBlock.md)\> - -Get the block that was included in the ledger for a transaction. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :------- | :------------------------------------------------------- | -| `transactionId` | `string` | The id of the transaction to get the included block for. | - -#### Returns - -`Promise`<[`IBlock`](../interfaces/IBlock.md)\> - -The block. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[transactionIncludedBlock](../interfaces/IClient.md#transactionincludedblock) - ---- - -### transactionIncludedBlockRaw - -▸ **transactionIncludedBlockRaw**(`transactionId`): `Promise`<`Uint8Array`\> - -Get raw block that was included in the ledger for a transaction. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :------- | :------------------------------------------------------- | -| `transactionId` | `string` | The id of the transaction to get the included block for. | - -#### Returns - -`Promise`<`Uint8Array`\> - -The block. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[transactionIncludedBlockRaw](../interfaces/IClient.md#transactionincludedblockraw) - ---- - -### output - -▸ **output**(`outputId`): `Promise`<[`IOutputResponse`](../interfaces/IOutputResponse.md)\> - -Get an output by its identifier. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :--------------------------- | -| `outputId` | `string` | The id of the output to get. | - -#### Returns - -`Promise`<[`IOutputResponse`](../interfaces/IOutputResponse.md)\> - -The output details. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[output](../interfaces/IClient.md#output) - ---- - -### outputMetadata - -▸ **outputMetadata**(`outputId`): `Promise`<[`IOutputMetadataResponse`](../interfaces/IOutputMetadataResponse.md)\> - -Get an outputs metadata by its identifier. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :-------------------------------------------- | -| `outputId` | `string` | The id of the output to get the metadata for. | - -#### Returns - -`Promise`<[`IOutputMetadataResponse`](../interfaces/IOutputMetadataResponse.md)\> - -The output metadata. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[outputMetadata](../interfaces/IClient.md#outputmetadata) - ---- - -### outputRaw - -▸ **outputRaw**(`outputId`): `Promise`<`Uint8Array`\> - -Get an outputs raw data. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :-------------------------------------------- | -| `outputId` | `string` | The id of the output to get the raw data for. | - -#### Returns - -`Promise`<`Uint8Array`\> - -The output raw bytes. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[outputRaw](../interfaces/IClient.md#outputraw) - ---- - -### milestoneByIndex - -▸ **milestoneByIndex**(`index`): `Promise`<[`IMilestonePayload`](../interfaces/IMilestonePayload.md)\> - -Get the requested milestone. - -#### Parameters - -| Name | Type | Description | -| :------ | :------- | :------------------------------------- | -| `index` | `number` | The index of the milestone to look up. | - -#### Returns - -`Promise`<[`IMilestonePayload`](../interfaces/IMilestonePayload.md)\> - -The milestone payload. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[milestoneByIndex](../interfaces/IClient.md#milestonebyindex) - ---- - -### milestoneByIndexRaw - -▸ **milestoneByIndexRaw**(`index`): `Promise`<`Uint8Array`\> - -Get the requested milestone raw. - -#### Parameters - -| Name | Type | Description | -| :------ | :------- | :------------------------------------- | -| `index` | `number` | The index of the milestone to look up. | - -#### Returns - -`Promise`<`Uint8Array`\> - -The milestone payload raw. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[milestoneByIndexRaw](../interfaces/IClient.md#milestonebyindexraw) - ---- - -### milestoneUtxoChangesByIndex - -▸ **milestoneUtxoChangesByIndex**(`index`): `Promise`<[`IMilestoneUtxoChangesResponse`](../interfaces/IMilestoneUtxoChangesResponse.md)\> - -Get the requested milestone utxo changes. - -#### Parameters - -| Name | Type | Description | -| :------ | :------- | :----------------------------------------------------- | -| `index` | `number` | The index of the milestone to request the changes for. | - -#### Returns - -`Promise`<[`IMilestoneUtxoChangesResponse`](../interfaces/IMilestoneUtxoChangesResponse.md)\> - -The milestone utxo changes details. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[milestoneUtxoChangesByIndex](../interfaces/IClient.md#milestoneutxochangesbyindex) - ---- - -### milestoneById - -▸ **milestoneById**(`milestoneId`): `Promise`<[`IMilestonePayload`](../interfaces/IMilestonePayload.md)\> - -Get the requested milestone. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :---------------------------------- | -| `milestoneId` | `string` | The id of the milestone to look up. | - -#### Returns - -`Promise`<[`IMilestonePayload`](../interfaces/IMilestonePayload.md)\> - -The milestone payload. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[milestoneById](../interfaces/IClient.md#milestonebyid) - ---- - -### milestoneByIdRaw - -▸ **milestoneByIdRaw**(`milestoneId`): `Promise`<`Uint8Array`\> - -Get the requested milestone raw. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :---------------------------------- | -| `milestoneId` | `string` | The id of the milestone to look up. | - -#### Returns - -`Promise`<`Uint8Array`\> - -The milestone payload raw. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[milestoneByIdRaw](../interfaces/IClient.md#milestonebyidraw) - ---- - -### milestoneUtxoChangesById - -▸ **milestoneUtxoChangesById**(`milestoneId`): `Promise`<[`IMilestoneUtxoChangesResponse`](../interfaces/IMilestoneUtxoChangesResponse.md)\> - -Get the requested milestone utxo changes. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :-------------------------------------------------- | -| `milestoneId` | `string` | The id of the milestone to request the changes for. | - -#### Returns - -`Promise`<[`IMilestoneUtxoChangesResponse`](../interfaces/IMilestoneUtxoChangesResponse.md)\> - -The milestone utxo changes details. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[milestoneUtxoChangesById](../interfaces/IClient.md#milestoneutxochangesbyid) - ---- - -### treasury - -▸ **treasury**(): `Promise`<[`ITreasury`](../interfaces/ITreasury.md)\> - -Get the current treasury output. - -#### Returns - -`Promise`<[`ITreasury`](../interfaces/ITreasury.md)\> - -The details for the treasury. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[treasury](../interfaces/IClient.md#treasury) - ---- - -### receipts - -▸ **receipts**(`migratedAt?`): `Promise`<[`IReceiptsResponse`](../interfaces/IReceiptsResponse.md)\> - -Get all the stored receipts or those for a given migrated at index. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :------------------------------------------------------------------------------------ | -| `migratedAt?` | `number` | The index the receipts were migrated at, if not supplied returns all stored receipts. | - -#### Returns - -`Promise`<[`IReceiptsResponse`](../interfaces/IReceiptsResponse.md)\> - -The stored receipts. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[receipts](../interfaces/IClient.md#receipts) - ---- - -### peers - -▸ **peers**(): `Promise`<[`IPeer`](../interfaces/IPeer.md)[]\> - -Get the list of peers. - -#### Returns - -`Promise`<[`IPeer`](../interfaces/IPeer.md)[]\> - -The list of peers. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[peers](../interfaces/IClient.md#peers) - ---- - -### peerAdd - -▸ **peerAdd**(`multiAddress`, `alias?`): `Promise`<[`IPeer`](../interfaces/IPeer.md)\> - -Add a new peer. - -#### Parameters - -| Name | Type | Description | -| :------------- | :------- | :------------------------------ | -| `multiAddress` | `string` | The address of the peer to add. | -| `alias?` | `string` | An optional alias for the peer. | - -#### Returns - -`Promise`<[`IPeer`](../interfaces/IPeer.md)\> - -The details for the created peer. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[peerAdd](../interfaces/IClient.md#peeradd) - ---- - -### peerDelete - -▸ **peerDelete**(`peerId`): `Promise`<`void`\> - -Delete a peer. - -#### Parameters - -| Name | Type | Description | -| :------- | :------- | :------------------ | -| `peerId` | `string` | The peer to delete. | - -#### Returns - -`Promise`<`void`\> - -Nothing. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[peerDelete](../interfaces/IClient.md#peerdelete) - ---- - -### peer - -▸ **peer**(`peerId`): `Promise`<[`IPeer`](../interfaces/IPeer.md)\> - -Get a peer. - -#### Parameters - -| Name | Type | Description | -| :------- | :------- | :------------------ | -| `peerId` | `string` | The peer to delete. | - -#### Returns - -`Promise`<[`IPeer`](../interfaces/IPeer.md)\> - -The details for the created peer. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[peer](../interfaces/IClient.md#peer) - ---- - -### protocolInfo - -▸ **protocolInfo**(): `Promise`<{}\> - -Get the protocol info from the node. - -#### Returns - -`Promise`<{}\> - -The protocol info. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[protocolInfo](../interfaces/IClient.md#protocolinfo) - ---- - -### pluginFetch - -▸ **pluginFetch**<`T`, `S`\>(`basePluginPath`, `method`, `methodPath`, `queryParams?`, `request?`): `Promise`<`S`\> - -Extension method which provides request methods for plugins. - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `S` | - -#### Parameters - -| Name | Type | Description | -| :--------------- | :-------------------------------- | :-------------------------------------------- | -| `basePluginPath` | `string` | The base path for the plugin eg indexer/v1/ . | -| `method` | `"get"` \| `"post"` \| `"delete"` | The http method. | -| `methodPath` | `string` | The path for the plugin request. | -| `queryParams?` | `string`[] | Additional query params for the request. | -| `request?` | `T` | The request object. | - -#### Returns - -`Promise`<`S`\> - -The response object. - -#### Implementation of - -[IClient](../interfaces/IClient.md).[pluginFetch](../interfaces/IClient.md#pluginfetch) diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/TransactionHelper.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/TransactionHelper.md deleted file mode 100644 index c1b230d6d81..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/TransactionHelper.md +++ /dev/null @@ -1,272 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: TransactionHelper - -Helper methods for Transactions. - -## Table of contents - -### Properties - -- [CONFIRMED_MILESTONE_INDEX_LENGTH](TransactionHelper.md#confirmed_milestone_index_length) -- [CONFIRMED_UINIX_TIMESTAMP_LENGTH](TransactionHelper.md#confirmed_uinix_timestamp_length) -- [OUTPUT_ID_LENGTH](TransactionHelper.md#output_id_length) - -### Methods - -- [calculateBlockId](TransactionHelper.md#calculateblockid) -- [outputIdFromTransactionData](TransactionHelper.md#outputidfromtransactiondata) -- [getTransactionEssenceHash](TransactionHelper.md#gettransactionessencehash) -- [getTransactionPayloadHash](TransactionHelper.md#gettransactionpayloadhash) -- [inputFromOutputId](TransactionHelper.md#inputfromoutputid) -- [getInputsCommitment](TransactionHelper.md#getinputscommitment) -- [getStorageDeposit](TransactionHelper.md#getstoragedeposit) -- [resolveIdFromOutputId](TransactionHelper.md#resolveidfromoutputid) -- [constructTokenId](TransactionHelper.md#constructtokenid) -- [networkIdFromNetworkName](TransactionHelper.md#networkidfromnetworkname) - -### Constructors - -- [constructor](TransactionHelper.md#constructor) - -## Properties - -### CONFIRMED_MILESTONE_INDEX_LENGTH - -▪ `Static` **CONFIRMED_MILESTONE_INDEX_LENGTH**: `number` = `4` - -The confirmed milestone index length. - ---- - -### CONFIRMED_UINIX_TIMESTAMP_LENGTH - -▪ `Static` **CONFIRMED_UINIX_TIMESTAMP_LENGTH**: `number` = `4` - -The confirmed unix timestamp length. - ---- - -### OUTPUT_ID_LENGTH - -▪ `Static` **OUTPUT_ID_LENGTH**: `number` = `34` - -The output Id length. - -## Methods - -### calculateBlockId - -▸ `Static` **calculateBlockId**(`block`): `string` - -Calculate blockId from a block. - -#### Parameters - -| Name | Type | Description | -| :------ | :---------------------------------- | :---------- | -| `block` | [`IBlock`](../interfaces/IBlock.md) | The block. | - -#### Returns - -`string` - -The blockId. - ---- - -### outputIdFromTransactionData - -▸ `Static` **outputIdFromTransactionData**(`transactionId`, `outputIndex`): `string` - -Returns the outputId from transation id and output index. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :------- | :------------------------- | -| `transactionId` | `string` | The id of the transaction. | -| `outputIndex` | `number` | The index of the output. | - -#### Returns - -`string` - -The output id. - ---- - -### getTransactionEssenceHash - -▸ `Static` **getTransactionEssenceHash**(`essence`): `Uint8Array` - -Calculate the Transaction Essence hash. - -#### Parameters - -| Name | Type | Description | -| :-------- | :------------------------------------------------------------ | :----------------------- | -| `essence` | [`ITransactionEssence`](../interfaces/ITransactionEssence.md) | The transaction essence. | - -#### Returns - -`Uint8Array` - -The transaction essence hash. - ---- - -### getTransactionPayloadHash - -▸ `Static` **getTransactionPayloadHash**(`transactionPayload`): `Uint8Array` - -Calculate the Transaction hash. - -#### Parameters - -| Name | Type | Description | -| :------------------- | :------------------------------------------------------------ | :------------------------------ | -| `transactionPayload` | [`ITransactionPayload`](../interfaces/ITransactionPayload.md) | The payload of the transaction. | - -#### Returns - -`Uint8Array` - -The transaction hash. - ---- - -### inputFromOutputId - -▸ `Static` **inputFromOutputId**(`outputId`): [`IUTXOInput`](../interfaces/IUTXOInput.md) - -Calculate the UTXO input from an output Id. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :-------------------- | -| `outputId` | `string` | The id of the output. | - -#### Returns - -[`IUTXOInput`](../interfaces/IUTXOInput.md) - -The UTXO Input. - ---- - -### getInputsCommitment - -▸ `Static` **getInputsCommitment**(`inputs`): `string` - -Calculate the inputCommitment from the output objects that are used as inputs to fund the transaction. - -#### Parameters - -| Name | Type | Description | -| :------- | :------------------------------------------- | :----------------------------------------------------- | -| `inputs` | [`OutputTypes`](../api_ref.md#outputtypes)[] | The output objects used as inputs for the transaction. | - -#### Returns - -`string` - -The inputs commitment. - ---- - -### getStorageDeposit - -▸ `Static` **getStorageDeposit**(`output`, `rentStructure`): `number` - -Calculates the required storage deposit of an output. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :----------------------------------------- | :---------------------------------------------- | -| `output` | [`OutputTypes`](../api_ref.md#outputtypes) | The output. | -| `rentStructure` | [`IRent`](../interfaces/IRent.md) | Rent cost of objects which take node resources. | - -#### Returns - -`number` - -The required storage deposit. - ---- - -### resolveIdFromOutputId - -▸ `Static` **resolveIdFromOutputId**(`outputId`): `string` - -Returns the nftId/aliasId from an outputId. -NftId/aliasId is Blake2b-256 hash of the outputId that created it. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :-------------------- | -| `outputId` | `string` | The id of the output. | - -#### Returns - -`string` - -The resolved Nft id or Alias id. - ---- - -### constructTokenId - -▸ `Static` **constructTokenId**(`aliasId`, `serialNumber`, `tokenSchemeType`): `string` - -Constructs a tokenId from the aliasId, serial number and token scheme type. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :------- | :--------------------------------------------------- | -| `aliasId` | `string` | The alias Id of the alias that controls the foundry. | -| `serialNumber` | `number` | The serial number of the foundry. | -| `tokenSchemeType` | `number` | The tokenSchemeType of the foundry. | - -#### Returns - -`string` - -The tokenId. - ---- - -### networkIdFromNetworkName - -▸ `Static` **networkIdFromNetworkName**(`networkName`): `string` - -Calculates the networkId value from the network name. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :----------------------- | -| `networkName` | `string` | The name of the network. | - -#### Returns - -`string` - -The networkId. - -## Constructors - -### constructor - -• **new TransactionHelper**() diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/UnitsHelper.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/UnitsHelper.md deleted file mode 100644 index 9ae6568252b..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/classes/UnitsHelper.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: UnitsHelper - -Class to help with units formatting. - -## Table of contents - -### Properties - -- [MAGNITUDE_MAP](UnitsHelper.md#magnitude_map) - -### Methods - -- [formatBest](UnitsHelper.md#formatbest) -- [formatUnits](UnitsHelper.md#formatunits) -- [calculateBest](UnitsHelper.md#calculatebest) -- [convertUnits](UnitsHelper.md#convertunits) - -### Constructors - -- [constructor](UnitsHelper.md#constructor) - -## Properties - -### MAGNITUDE_MAP - -▪ `Static` `Readonly` **MAGNITUDE_MAP**: `Object` - -Map units. - -## Methods - -### formatBest - -▸ `Static` **formatBest**(`value`, `decimalPlaces?`): `string` - -Format the value in the best units. - -#### Parameters - -| Name | Type | Default value | Description | -| :-------------- | :------- | :------------ | :--------------------------------------- | -| `value` | `number` | `undefined` | The value to format. | -| `decimalPlaces` | `number` | `2` | The number of decimal places to display. | - -#### Returns - -`string` - -The formated value. - ---- - -### formatUnits - -▸ `Static` **formatUnits**(`value`, `magnitude`, `decimalPlaces?`): `string` - -Format the value in the best units. - -#### Parameters - -| Name | Type | Default value | Description | -| :-------------- | :--------------------------------------- | :------------ | :--------------------------------------- | -| `value` | `number` | `undefined` | The value to format. | -| `magnitude` | [`Magnitudes`](../api_ref.md#magnitudes) | `undefined` | The magnitude to format with. | -| `decimalPlaces` | `number` | `2` | The number of decimal places to display. | - -#### Returns - -`string` - -The formated value. - ---- - -### calculateBest - -▸ `Static` **calculateBest**(`value`): [`Magnitudes`](../api_ref.md#magnitudes) - -Format the value in the best units. - -#### Parameters - -| Name | Type | Description | -| :------ | :------- | :------------------- | -| `value` | `number` | The value to format. | - -#### Returns - -[`Magnitudes`](../api_ref.md#magnitudes) - -The best units for the value. - ---- - -### convertUnits - -▸ `Static` **convertUnits**(`value`, `from`, `to`): `number` - -Convert the value to different units. - -#### Parameters - -| Name | Type | Description | -| :------ | :--------------------------------------- | :-------------------- | -| `value` | `number` | The value to convert. | -| `from` | [`Magnitudes`](../api_ref.md#magnitudes) | The from magnitude. | -| `to` | [`Magnitudes`](../api_ref.md#magnitudes) | The to magnitude. | - -#### Returns - -`number` - -The formatted unit. - -## Constructors - -### constructor - -• **new UnitsHelper**() diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/enums/ConflictReason.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/enums/ConflictReason.md deleted file mode 100644 index 8738a1b27f2..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/enums/ConflictReason.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Enumeration: ConflictReason - -Reason for block conflicts. - -## Table of contents - -### Enumeration Members - -- [none](ConflictReason.md#none) -- [inputUTXOAlreadySpent](ConflictReason.md#inpututxoalreadyspent) -- [inputUTXOAlreadySpentInThisMilestone](ConflictReason.md#inpututxoalreadyspentinthismilestone) -- [inputUTXONotFound](ConflictReason.md#inpututxonotfound) -- [inputOutputSumMismatch](ConflictReason.md#inputoutputsummismatch) -- [invalidSignature](ConflictReason.md#invalidsignature) -- [invalidNetworkId](ConflictReason.md#invalidnetworkid) -- [semanticValidationFailed](ConflictReason.md#semanticvalidationfailed) - -## Enumeration Members - -### none - -• **none** - -The block has no conflict. - ---- - -### inputUTXOAlreadySpent - -• **inputUTXOAlreadySpent** - -The referenced UTXO was already spent. - ---- - -### inputUTXOAlreadySpentInThisMilestone - -• **inputUTXOAlreadySpentInThisMilestone** - -The referenced UTXO was already spent while confirming this milestone. - ---- - -### inputUTXONotFound - -• **inputUTXONotFound** - -The referenced UTXO cannot be found. - ---- - -### inputOutputSumMismatch - -• **inputOutputSumMismatch** - -The sum of the inputs and output values does not match. - ---- - -### invalidSignature - -• **invalidSignature** - -The unlock block signature is invalid. - ---- - -### invalidNetworkId - -• **invalidNetworkId** - -The networkId in the essence does not match the nodes configuration. - ---- - -### semanticValidationFailed - -• **semanticValidationFailed** - -The semantic validation failed. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IAddress.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IAddress.md deleted file mode 100644 index b131cc8f62a..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IAddress.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IAddress - -Interface defining address. - -## Implemented by - -- [`Ed25519Address`](../classes/Ed25519Address.md) - -## Table of contents - -### Methods - -- [toAddress](IAddress.md#toaddress) -- [verify](IAddress.md#verify) - -## Methods - -### toAddress - -▸ **toAddress**(): `Uint8Array` - -Convert the public key to an address. - -#### Returns - -`Uint8Array` - -The address. - ---- - -### verify - -▸ **verify**(`publicKey`, `address`): `boolean` - -Use the public key to validate the address. - -#### Parameters - -| Name | Type | Description | -| :---------- | :----------- | :--------------------- | -| `publicKey` | `Uint8Array` | - | -| `address` | `Uint8Array` | The address to verify. | - -#### Returns - -`boolean` - -True if the data and address is verified. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IAddressUnlockCondition.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IAddressUnlockCondition.md deleted file mode 100644 index 1ca50bfbc21..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IAddressUnlockCondition.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IAddressUnlockCondition - -Address Unlock Condition. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`0`\> - - ↳ **`IAddressUnlockCondition`** - -## Table of contents - -### Properties - -- [type](IAddressUnlockCondition.md#type) -- [address](IAddressUnlockCondition.md#address) - -## Properties - -### type - -• **type**: `0` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### address - -• **address**: [`AddressTypes`](../api_ref.md#addresstypes) - -The address. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IAliasAddress.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IAliasAddress.md deleted file mode 100644 index 9289b8be4fa..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IAliasAddress.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IAliasAddress - -Alias address. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`8`\> - - ↳ **`IAliasAddress`** - -## Table of contents - -### Properties - -- [type](IAliasAddress.md#type) -- [aliasId](IAliasAddress.md#aliasid) - -## Properties - -### type - -• **type**: `8` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### aliasId - -• **aliasId**: `string` - -The alias id. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IAliasOutput.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IAliasOutput.md deleted file mode 100644 index 21bb14620f2..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IAliasOutput.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IAliasOutput - -Alias output. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`4`\> - -- [`ICommonOutput`](ICommonOutput.md) - - ↳ **`IAliasOutput`** - -## Table of contents - -### Properties - -- [type](IAliasOutput.md#type) -- [amount](IAliasOutput.md#amount) -- [aliasId](IAliasOutput.md#aliasid) -- [stateIndex](IAliasOutput.md#stateindex) -- [stateMetadata](IAliasOutput.md#statemetadata) -- [foundryCounter](IAliasOutput.md#foundrycounter) -- [immutableFeatures](IAliasOutput.md#immutablefeatures) -- [nativeTokens](IAliasOutput.md#nativetokens) -- [unlockConditions](IAliasOutput.md#unlockconditions) -- [features](IAliasOutput.md#features) - -## Properties - -### type - -• **type**: `4` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### amount - -• **amount**: `string` - -The amount of IOTA tokens held by the output. - ---- - -### aliasId - -• **aliasId**: `string` - -Unique identifier of the alias, which is the BLAKE2b-160 hash of the Output ID that created it. - ---- - -### stateIndex - -• **stateIndex**: `number` - -A counter that must increase by 1 every time the alias is state transitioned. - ---- - -### stateMetadata - -• `Optional` **stateMetadata**: `string` - -Metadata that can only be changed by the state controller. - ---- - -### foundryCounter - -• **foundryCounter**: `number` - -A counter that denotes the number of foundries created by this alias account. - ---- - -### immutableFeatures - -• `Optional` **immutableFeatures**: [`FeatureTypes`](../api_ref.md#featuretypes)[] - -Immutable features contained by the output. - ---- - -### nativeTokens - -• `Optional` **nativeTokens**: [`INativeToken`](INativeToken.md)[] - -The native tokens held by the output. - -#### Inherited from - -[ICommonOutput](ICommonOutput.md).[nativeTokens](ICommonOutput.md#nativetokens) - ---- - -### unlockConditions - -• **unlockConditions**: [`UnlockConditionTypes`](../api_ref.md#unlockconditiontypes)[] - -The unlock conditions for the output. - -#### Inherited from - -[ICommonOutput](ICommonOutput.md).[unlockConditions](ICommonOutput.md#unlockconditions) - ---- - -### features - -• `Optional` **features**: [`FeatureTypes`](../api_ref.md#featuretypes)[] - -Features contained by the output. - -#### Inherited from - -[ICommonOutput](ICommonOutput.md).[features](ICommonOutput.md#features) diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IAliasUnlock.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IAliasUnlock.md deleted file mode 100644 index 63b22834a12..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IAliasUnlock.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IAliasUnlock - -An unlock which must reference a previous unlock which unlocks the alias that the input is locked to. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`2`\> - - ↳ **`IAliasUnlock`** - -## Table of contents - -### Properties - -- [type](IAliasUnlock.md#type) -- [reference](IAliasUnlock.md#reference) - -## Properties - -### type - -• **type**: `2` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### reference - -• **reference**: `number` - -The reference. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IBasicOutput.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IBasicOutput.md deleted file mode 100644 index 330bbaa7ce3..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IBasicOutput.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IBasicOutput - -Basic output. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`3`\> - -- [`ICommonOutput`](ICommonOutput.md) - - ↳ **`IBasicOutput`** - -## Table of contents - -### Properties - -- [type](IBasicOutput.md#type) -- [amount](IBasicOutput.md#amount) -- [nativeTokens](IBasicOutput.md#nativetokens) -- [unlockConditions](IBasicOutput.md#unlockconditions) -- [features](IBasicOutput.md#features) - -## Properties - -### type - -• **type**: `3` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### amount - -• **amount**: `string` - -The amount of IOTA coins to held by the output. - ---- - -### nativeTokens - -• `Optional` **nativeTokens**: [`INativeToken`](INativeToken.md)[] - -The native tokens held by the output. - -#### Inherited from - -[ICommonOutput](ICommonOutput.md).[nativeTokens](ICommonOutput.md#nativetokens) - ---- - -### unlockConditions - -• **unlockConditions**: [`UnlockConditionTypes`](../api_ref.md#unlockconditiontypes)[] - -The unlock conditions for the output. - -#### Inherited from - -[ICommonOutput](ICommonOutput.md).[unlockConditions](ICommonOutput.md#unlockconditions) - ---- - -### features - -• `Optional` **features**: [`FeatureTypes`](../api_ref.md#featuretypes)[] - -Features contained by the output. - -#### Inherited from - -[ICommonOutput](ICommonOutput.md).[features](ICommonOutput.md#features) diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IBip44GeneratorState.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IBip44GeneratorState.md deleted file mode 100644 index 27713e81b94..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IBip44GeneratorState.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IBip44GeneratorState - -Definition of address generator state. - -## Table of contents - -### Properties - -- [accountIndex](IBip44GeneratorState.md#accountindex) -- [isInternal](IBip44GeneratorState.md#isinternal) -- [addressIndex](IBip44GeneratorState.md#addressindex) - -## Properties - -### accountIndex - -• **accountIndex**: `number` - -The account index. - ---- - -### isInternal - -• **isInternal**: `boolean` - -Is this an internal address. - ---- - -### addressIndex - -• **addressIndex**: `number` - -The address index. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IBlock.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IBlock.md deleted file mode 100644 index 18fd45965e8..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IBlock.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IBlock - -Block layout. - -## Table of contents - -### Properties - -- [protocolVersion](IBlock.md#protocolversion) -- [parents](IBlock.md#parents) -- [payload](IBlock.md#payload) -- [nonce](IBlock.md#nonce) - -## Properties - -### protocolVersion - -• **protocolVersion**: `number` - -The protocol version under which this block operates. - ---- - -### parents - -• **parents**: `string`[] - -The parent block ids. - ---- - -### payload - -• `Optional` **payload**: [`ITransactionPayload`](ITransactionPayload.md) \| [`IMilestonePayload`](IMilestonePayload.md) \| [`ITaggedDataPayload`](ITaggedDataPayload.md) - -The payload contents. - ---- - -### nonce - -• **nonce**: `string` - -The nonce for the block. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IBlockIdResponse.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IBlockIdResponse.md deleted file mode 100644 index b8a62c14b97..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IBlockIdResponse.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IBlockIdResponse - -Block id response. - -## Table of contents - -### Properties - -- [blockId](IBlockIdResponse.md#blockid) - -## Properties - -### blockId - -• **blockId**: `string` - -The block id. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IBlockMetadata.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IBlockMetadata.md deleted file mode 100644 index 201947ead43..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IBlockMetadata.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IBlockMetadata - -Response from the metadata endpoint. - -## Table of contents - -### Properties - -- [blockId](IBlockMetadata.md#blockid) -- [parents](IBlockMetadata.md#parents) -- [isSolid](IBlockMetadata.md#issolid) -- [referencedByMilestoneIndex](IBlockMetadata.md#referencedbymilestoneindex) -- [milestoneIndex](IBlockMetadata.md#milestoneindex) -- [ledgerInclusionState](IBlockMetadata.md#ledgerinclusionstate) -- [conflictReason](IBlockMetadata.md#conflictreason) -- [shouldPromote](IBlockMetadata.md#shouldpromote) -- [shouldReattach](IBlockMetadata.md#shouldreattach) - -## Properties - -### blockId - -• **blockId**: `string` - -The block id. - ---- - -### parents - -• **parents**: `string`[] - -The parent block ids. - ---- - -### isSolid - -• **isSolid**: `boolean` - -Is the block solid. - ---- - -### referencedByMilestoneIndex - -• `Optional` **referencedByMilestoneIndex**: `number` - -Is the block referenced by a milestone. - ---- - -### milestoneIndex - -• `Optional` **milestoneIndex**: `number` - -Is this block a valid milestone. - ---- - -### ledgerInclusionState - -• `Optional` **ledgerInclusionState**: [`LedgerInclusionState`](../api_ref.md#ledgerinclusionstate) - -The ledger inclusion state. - ---- - -### conflictReason - -• `Optional` **conflictReason**: [`ConflictReason`](../enums/ConflictReason.md) - -The conflict reason. - ---- - -### shouldPromote - -• `Optional` **shouldPromote**: `boolean` - -Should the block be promoted. - ---- - -### shouldReattach - -• `Optional` **shouldReattach**: `boolean` - -Should the block be reattached. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IClient.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IClient.md deleted file mode 100644 index 41a3fb529fe..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IClient.md +++ /dev/null @@ -1,579 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IClient - -Client interface definition for API communication. - -## Implemented by - -- [`SingleNodeClient`](../classes/SingleNodeClient.md) - -## Table of contents - -### Methods - -- [health](IClient.md#health) -- [routes](IClient.md#routes) -- [info](IClient.md#info) -- [tips](IClient.md#tips) -- [block](IClient.md#block) -- [blockMetadata](IClient.md#blockmetadata) -- [blockRaw](IClient.md#blockraw) -- [blockSubmit](IClient.md#blocksubmit) -- [blockSubmitRaw](IClient.md#blocksubmitraw) -- [transactionIncludedBlock](IClient.md#transactionincludedblock) -- [transactionIncludedBlockRaw](IClient.md#transactionincludedblockraw) -- [output](IClient.md#output) -- [outputMetadata](IClient.md#outputmetadata) -- [outputRaw](IClient.md#outputraw) -- [milestoneByIndex](IClient.md#milestonebyindex) -- [milestoneByIndexRaw](IClient.md#milestonebyindexraw) -- [milestoneUtxoChangesByIndex](IClient.md#milestoneutxochangesbyindex) -- [milestoneById](IClient.md#milestonebyid) -- [milestoneByIdRaw](IClient.md#milestonebyidraw) -- [milestoneUtxoChangesById](IClient.md#milestoneutxochangesbyid) -- [treasury](IClient.md#treasury) -- [receipts](IClient.md#receipts) -- [peers](IClient.md#peers) -- [peerAdd](IClient.md#peeradd) -- [peerDelete](IClient.md#peerdelete) -- [peer](IClient.md#peer) -- [protocolInfo](IClient.md#protocolinfo) -- [pluginFetch](IClient.md#pluginfetch) - -## Methods - -### health - -▸ **health**(): `Promise`<`boolean`\> - -Get the health of the node. - -#### Returns - -`Promise`<`boolean`\> - -True if the node is healthy. - ---- - -### routes - -▸ **routes**(): `Promise`<[`IRoutesResponse`](IRoutesResponse.md)\> - -Get the routes the node exposes. - -#### Returns - -`Promise`<[`IRoutesResponse`](IRoutesResponse.md)\> - -The routes. - ---- - -### info - -▸ **info**(): `Promise`<[`INodeInfo`](INodeInfo.md)\> - -Get the info about the node. - -#### Returns - -`Promise`<[`INodeInfo`](INodeInfo.md)\> - -The node information. - ---- - -### tips - -▸ **tips**(): `Promise`<[`ITipsResponse`](ITipsResponse.md)\> - -Get the tips from the node. - -#### Returns - -`Promise`<[`ITipsResponse`](ITipsResponse.md)\> - -The tips. - ---- - -### block - -▸ **block**(`blockId`): `Promise`<[`IBlock`](IBlock.md)\> - -Get the block data by id. - -#### Parameters - -| Name | Type | Description | -| :-------- | :------- | :----------------------------- | -| `blockId` | `string` | The block to get the data for. | - -#### Returns - -`Promise`<[`IBlock`](IBlock.md)\> - -The block data. - ---- - -### blockMetadata - -▸ **blockMetadata**(`blockId`): `Promise`<[`IBlockMetadata`](IBlockMetadata.md)\> - -Get the block metadata by id. - -#### Parameters - -| Name | Type | Description | -| :-------- | :------- | :--------------------------------- | -| `blockId` | `string` | The block to get the metadata for. | - -#### Returns - -`Promise`<[`IBlockMetadata`](IBlockMetadata.md)\> - -The block metadata. - ---- - -### blockRaw - -▸ **blockRaw**(`blockId`): `Promise`<`Uint8Array`\> - -Get the block raw data by id. - -#### Parameters - -| Name | Type | Description | -| :-------- | :------- | :----------------------------- | -| `blockId` | `string` | The block to get the data for. | - -#### Returns - -`Promise`<`Uint8Array`\> - -The block raw data. - ---- - -### blockSubmit - -▸ **blockSubmit**(`blockPartial`): `Promise`<`string`\> - -Submit block. - -#### Parameters - -| Name | Type | Description | -| :------------- | :------- | :--------------------------------------------------------------- | -| `blockPartial` | `Object` | The block to submit (possibly contains only partial block data). | - -#### Returns - -`Promise`<`string`\> - -The blockId. - ---- - -### blockSubmitRaw - -▸ **blockSubmitRaw**(`block`): `Promise`<`string`\> - -Submit block in raw format. - -#### Parameters - -| Name | Type | Description | -| :------ | :----------- | :------------------- | -| `block` | `Uint8Array` | The block to submit. | - -#### Returns - -`Promise`<`string`\> - -The blockId. - ---- - -### transactionIncludedBlock - -▸ **transactionIncludedBlock**(`transactionId`): `Promise`<[`IBlock`](IBlock.md)\> - -Get the block that was included in the ledger for a transaction. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :------- | :------------------------------------------------------- | -| `transactionId` | `string` | The id of the transaction to get the included block for. | - -#### Returns - -`Promise`<[`IBlock`](IBlock.md)\> - -The block. - ---- - -### transactionIncludedBlockRaw - -▸ **transactionIncludedBlockRaw**(`transactionId`): `Promise`<`Uint8Array`\> - -Get raw block that was included in the ledger for a transaction. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :------- | :------------------------------------------------------- | -| `transactionId` | `string` | The id of the transaction to get the included block for. | - -#### Returns - -`Promise`<`Uint8Array`\> - -The block. - ---- - -### output - -▸ **output**(`outputId`): `Promise`<[`IOutputResponse`](IOutputResponse.md)\> - -Get an output by its identifier. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :--------------------------- | -| `outputId` | `string` | The id of the output to get. | - -#### Returns - -`Promise`<[`IOutputResponse`](IOutputResponse.md)\> - -The output details. - ---- - -### outputMetadata - -▸ **outputMetadata**(`outputId`): `Promise`<[`IOutputMetadataResponse`](IOutputMetadataResponse.md)\> - -Get an outputs metadata by its identifier. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :-------------------------------------------- | -| `outputId` | `string` | The id of the output to get the metadata for. | - -#### Returns - -`Promise`<[`IOutputMetadataResponse`](IOutputMetadataResponse.md)\> - -The output metadata. - ---- - -### outputRaw - -▸ **outputRaw**(`outputId`): `Promise`<`Uint8Array`\> - -Get an outputs raw data. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :-------------------------------------------- | -| `outputId` | `string` | The id of the output to get the raw data for. | - -#### Returns - -`Promise`<`Uint8Array`\> - -The output metadata. - ---- - -### milestoneByIndex - -▸ **milestoneByIndex**(`index`): `Promise`<[`IMilestonePayload`](IMilestonePayload.md)\> - -Get the requested milestone. - -#### Parameters - -| Name | Type | Description | -| :------ | :------- | :------------------------------------- | -| `index` | `number` | The index of the milestone to look up. | - -#### Returns - -`Promise`<[`IMilestonePayload`](IMilestonePayload.md)\> - -The milestone payload. - ---- - -### milestoneByIndexRaw - -▸ **milestoneByIndexRaw**(`index`): `Promise`<`Uint8Array`\> - -Get the requested milestone raw. - -#### Parameters - -| Name | Type | Description | -| :------ | :------- | :------------------------------------- | -| `index` | `number` | The index of the milestone to look up. | - -#### Returns - -`Promise`<`Uint8Array`\> - -The milestone payload raw. - ---- - -### milestoneUtxoChangesByIndex - -▸ **milestoneUtxoChangesByIndex**(`index`): `Promise`<[`IMilestoneUtxoChangesResponse`](IMilestoneUtxoChangesResponse.md)\> - -Get the requested milestone utxo changes. - -#### Parameters - -| Name | Type | Description | -| :------ | :------- | :----------------------------------------------------- | -| `index` | `number` | The index of the milestone to request the changes for. | - -#### Returns - -`Promise`<[`IMilestoneUtxoChangesResponse`](IMilestoneUtxoChangesResponse.md)\> - -The milestone utxo changes details. - ---- - -### milestoneById - -▸ **milestoneById**(`milestoneId`): `Promise`<[`IMilestonePayload`](IMilestonePayload.md)\> - -Get the requested milestone. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :---------------------------------- | -| `milestoneId` | `string` | The id of the milestone to look up. | - -#### Returns - -`Promise`<[`IMilestonePayload`](IMilestonePayload.md)\> - -The milestone payload. - ---- - -### milestoneByIdRaw - -▸ **milestoneByIdRaw**(`milestoneId`): `Promise`<`Uint8Array`\> - -Get the requested milestone raw. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :---------------------------------- | -| `milestoneId` | `string` | The id of the milestone to look up. | - -#### Returns - -`Promise`<`Uint8Array`\> - -The milestone payload raw. - ---- - -### milestoneUtxoChangesById - -▸ **milestoneUtxoChangesById**(`milestoneId`): `Promise`<[`IMilestoneUtxoChangesResponse`](IMilestoneUtxoChangesResponse.md)\> - -Get the requested milestone utxo changes. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :-------------------------------------------------- | -| `milestoneId` | `string` | The id of the milestone to request the changes for. | - -#### Returns - -`Promise`<[`IMilestoneUtxoChangesResponse`](IMilestoneUtxoChangesResponse.md)\> - -The milestone utxo changes details. - ---- - -### treasury - -▸ **treasury**(): `Promise`<[`ITreasury`](ITreasury.md)\> - -Get the current treasury output. - -#### Returns - -`Promise`<[`ITreasury`](ITreasury.md)\> - -The details for the treasury. - ---- - -### receipts - -▸ **receipts**(`migratedAt?`): `Promise`<[`IReceiptsResponse`](IReceiptsResponse.md)\> - -Get all the stored receipts or those for a given migrated at index. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :------------------------------------------------------------------------------------ | -| `migratedAt?` | `number` | The index the receipts were migrated at, if not supplied returns all stored receipts. | - -#### Returns - -`Promise`<[`IReceiptsResponse`](IReceiptsResponse.md)\> - -The stored receipts. - ---- - -### peers - -▸ **peers**(): `Promise`<[`IPeer`](IPeer.md)[]\> - -Get the list of peers. - -#### Returns - -`Promise`<[`IPeer`](IPeer.md)[]\> - -The list of peers. - ---- - -### peerAdd - -▸ **peerAdd**(`multiAddress`, `alias?`): `Promise`<[`IPeer`](IPeer.md)\> - -Add a new peer. - -#### Parameters - -| Name | Type | Description | -| :------------- | :------- | :------------------------------ | -| `multiAddress` | `string` | The address of the peer to add. | -| `alias?` | `string` | An optional alias for the peer. | - -#### Returns - -`Promise`<[`IPeer`](IPeer.md)\> - -The details for the created peer. - ---- - -### peerDelete - -▸ **peerDelete**(`peerId`): `Promise`<`void`\> - -Delete a peer. - -#### Parameters - -| Name | Type | Description | -| :------- | :------- | :------------------ | -| `peerId` | `string` | The peer to delete. | - -#### Returns - -`Promise`<`void`\> - -Nothing. - ---- - -### peer - -▸ **peer**(`peerId`): `Promise`<[`IPeer`](IPeer.md)\> - -Get a peer. - -#### Parameters - -| Name | Type | Description | -| :------- | :------- | :------------------ | -| `peerId` | `string` | The peer to delete. | - -#### Returns - -`Promise`<[`IPeer`](IPeer.md)\> - -The details for the created peer. - ---- - -### protocolInfo - -▸ **protocolInfo**(): `Promise`<{ `networkName`: `string` ; `networkId`: `string` ; `bech32Hrp`: `string` ; `minPowScore`: `number` }\> - -Get the protocol info from the node. - -#### Returns - -`Promise`<{ `networkName`: `string` ; `networkId`: `string` ; `bech32Hrp`: `string` ; `minPowScore`: `number` }\> - -The protocol info. - ---- - -### pluginFetch - -▸ **pluginFetch**<`T`, `S`\>(`basePluginPath`, `method`, `methodPath`, `queryParams?`, `request?`): `Promise`<`S`\> - -Extension method which provides request methods for plugins. - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `S` | - -#### Parameters - -| Name | Type | Description | -| :--------------- | :-------------------------------- | :-------------------------------------------- | -| `basePluginPath` | `string` | The base path for the plugin eg indexer/v1/ . | -| `method` | `"get"` \| `"post"` \| `"delete"` | The http method. | -| `methodPath` | `string` | The path for the plugin request. | -| `queryParams?` | `string`[] | Additional query params for the request. | -| `request?` | `T` | The request object. | - -#### Returns - -`Promise`<`S`\> - -The response object. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ICommonOutput.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ICommonOutput.md deleted file mode 100644 index 5e6d8791b54..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ICommonOutput.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: ICommonOutput - -Common output properties. - -## Hierarchy - -- **`ICommonOutput`** - - ↳ [`IAliasOutput`](IAliasOutput.md) - - ↳ [`IBasicOutput`](IBasicOutput.md) - - ↳ [`IFoundryOutput`](IFoundryOutput.md) - - ↳ [`INftOutput`](INftOutput.md) - -## Table of contents - -### Properties - -- [nativeTokens](ICommonOutput.md#nativetokens) -- [unlockConditions](ICommonOutput.md#unlockconditions) -- [features](ICommonOutput.md#features) - -## Properties - -### nativeTokens - -• `Optional` **nativeTokens**: [`INativeToken`](INativeToken.md)[] - -The native tokens held by the output. - ---- - -### unlockConditions - -• **unlockConditions**: [`UnlockConditionTypes`](../api_ref.md#unlockconditiontypes)[] - -The unlock conditions for the output. - ---- - -### features - -• `Optional` **features**: [`FeatureTypes`](../api_ref.md#featuretypes)[] - -Features contained by the output. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IEd25519Address.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IEd25519Address.md deleted file mode 100644 index c150b695b04..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IEd25519Address.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IEd25519Address - -Ed25519Address address. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`0`\> - - ↳ **`IEd25519Address`** - -## Table of contents - -### Properties - -- [type](IEd25519Address.md#type) -- [pubKeyHash](IEd25519Address.md#pubkeyhash) - -## Properties - -### type - -• **type**: `0` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### pubKeyHash - -• **pubKeyHash**: `string` - -The public key hash. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IEd25519Signature.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IEd25519Signature.md deleted file mode 100644 index 3393b507fbb..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IEd25519Signature.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IEd25519Signature - -Ed25519Signature signature. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`0`\> - - ↳ **`IEd25519Signature`** - -## Table of contents - -### Properties - -- [type](IEd25519Signature.md#type) -- [publicKey](IEd25519Signature.md#publickey) -- [signature](IEd25519Signature.md#signature) - -## Properties - -### type - -• **type**: `0` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### publicKey - -• **publicKey**: `string` - -The public key. - ---- - -### signature - -• **signature**: `string` - -The signature. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IExpirationUnlockCondition.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IExpirationUnlockCondition.md deleted file mode 100644 index 954e22f35a3..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IExpirationUnlockCondition.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IExpirationUnlockCondition - -Expiration Unlock Condition. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`3`\> - - ↳ **`IExpirationUnlockCondition`** - -## Table of contents - -### Properties - -- [type](IExpirationUnlockCondition.md#type) -- [returnAddress](IExpirationUnlockCondition.md#returnaddress) -- [unixTime](IExpirationUnlockCondition.md#unixtime) - -## Properties - -### type - -• **type**: `3` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### returnAddress - -• **returnAddress**: [`AddressTypes`](../api_ref.md#addresstypes) - -The return address. - ---- - -### unixTime - -• **unixTime**: `number` - -Before this unix time, the condition is allowed to unlock the output, -after that only the address defined in return address. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IFoundryOutput.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IFoundryOutput.md deleted file mode 100644 index 0d326f32873..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IFoundryOutput.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IFoundryOutput - -Foundry output. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`5`\> - -- [`ICommonOutput`](ICommonOutput.md) - - ↳ **`IFoundryOutput`** - -## Table of contents - -### Properties - -- [type](IFoundryOutput.md#type) -- [nativeTokens](IFoundryOutput.md#nativetokens) -- [unlockConditions](IFoundryOutput.md#unlockconditions) -- [features](IFoundryOutput.md#features) -- [amount](IFoundryOutput.md#amount) -- [serialNumber](IFoundryOutput.md#serialnumber) -- [tokenScheme](IFoundryOutput.md#tokenscheme) -- [immutableFeatures](IFoundryOutput.md#immutablefeatures) - -## Properties - -### type - -• **type**: `5` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### nativeTokens - -• `Optional` **nativeTokens**: [`INativeToken`](INativeToken.md)[] - -The native tokens held by the output. - -#### Inherited from - -[ICommonOutput](ICommonOutput.md).[nativeTokens](ICommonOutput.md#nativetokens) - ---- - -### unlockConditions - -• **unlockConditions**: [`UnlockConditionTypes`](../api_ref.md#unlockconditiontypes)[] - -The unlock conditions for the output. - -#### Inherited from - -[ICommonOutput](ICommonOutput.md).[unlockConditions](ICommonOutput.md#unlockconditions) - ---- - -### features - -• `Optional` **features**: [`FeatureTypes`](../api_ref.md#featuretypes)[] - -Features contained by the output. - -#### Inherited from - -[ICommonOutput](ICommonOutput.md).[features](ICommonOutput.md#features) - ---- - -### amount - -• **amount**: `string` - -The amount of IOTA tokens held by the output. - ---- - -### serialNumber - -• **serialNumber**: `number` - -The serial number of the foundry with respect to the controlling alias. - ---- - -### tokenScheme - -• **tokenScheme**: [`ISimpleTokenScheme`](ISimpleTokenScheme.md) - -The token scheme for the foundry. - ---- - -### immutableFeatures - -• `Optional` **immutableFeatures**: [`FeatureTypes`](../api_ref.md#featuretypes)[] - -Immutable features contained by the output. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IGossipHeartbeat.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IGossipHeartbeat.md deleted file mode 100644 index 7a35e9807bc..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IGossipHeartbeat.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IGossipHeartbeat - -Gossip heartbeat. - -## Table of contents - -### Properties - -- [solidMilestoneIndex](IGossipHeartbeat.md#solidmilestoneindex) -- [prunedMilestoneIndex](IGossipHeartbeat.md#prunedmilestoneindex) -- [latestMilestoneIndex](IGossipHeartbeat.md#latestmilestoneindex) -- [connectedPeers](IGossipHeartbeat.md#connectedpeers) -- [syncedPeers](IGossipHeartbeat.md#syncedpeers) - -## Properties - -### solidMilestoneIndex - -• **solidMilestoneIndex**: `number` - -Solid milestone index. - ---- - -### prunedMilestoneIndex - -• **prunedMilestoneIndex**: `number` - -Pruned milestone index. - ---- - -### latestMilestoneIndex - -• **latestMilestoneIndex**: `number` - -Latest milestone index. - ---- - -### connectedPeers - -• **connectedPeers**: `number` - -Connected peers. - ---- - -### syncedPeers - -• **syncedPeers**: `number` - -Synced peers. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IGossipMetrics.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IGossipMetrics.md deleted file mode 100644 index 0489bcd6244..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IGossipMetrics.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IGossipMetrics - -Gossip metrics. - -## Table of contents - -### Properties - -- [newBlocks](IGossipMetrics.md#newblocks) -- [knownBlocks](IGossipMetrics.md#knownblocks) -- [receivedBlocks](IGossipMetrics.md#receivedblocks) -- [receivedBlockRequests](IGossipMetrics.md#receivedblockrequests) -- [receivedMilestoneRequests](IGossipMetrics.md#receivedmilestonerequests) -- [receivedHeartbeats](IGossipMetrics.md#receivedheartbeats) -- [sentBlocks](IGossipMetrics.md#sentblocks) -- [sentBlockRequests](IGossipMetrics.md#sentblockrequests) -- [sentMilestoneRequests](IGossipMetrics.md#sentmilestonerequests) -- [sentHeartbeats](IGossipMetrics.md#sentheartbeats) -- [droppedPackets](IGossipMetrics.md#droppedpackets) - -## Properties - -### newBlocks - -• **newBlocks**: `number` - -The number of new blocks. - ---- - -### knownBlocks - -• **knownBlocks**: `number` - -The number of known blocks. - ---- - -### receivedBlocks - -• **receivedBlocks**: `number` - -The number of received blocks. - ---- - -### receivedBlockRequests - -• **receivedBlockRequests**: `number` - -The number of received block requests. - ---- - -### receivedMilestoneRequests - -• **receivedMilestoneRequests**: `number` - -The number of received milestone requests. - ---- - -### receivedHeartbeats - -• **receivedHeartbeats**: `number` - -The number of received heartbeats. - ---- - -### sentBlocks - -• **sentBlocks**: `number` - -The number of sent blocks. - ---- - -### sentBlockRequests - -• **sentBlockRequests**: `number` - -The number of sent block requests. - ---- - -### sentMilestoneRequests - -• **sentMilestoneRequests**: `number` - -The number of sent miletsone requests. - ---- - -### sentHeartbeats - -• **sentHeartbeats**: `number` - -The number of sent heartbeats. - ---- - -### droppedPackets - -• **droppedPackets**: `number` - -The number of dropped sent packets. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IGovernorAddressUnlockCondition.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IGovernorAddressUnlockCondition.md deleted file mode 100644 index 7d62bef9e12..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IGovernorAddressUnlockCondition.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IGovernorAddressUnlockCondition - -Governor Unlock Condition. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`5`\> - - ↳ **`IGovernorAddressUnlockCondition`** - -## Table of contents - -### Properties - -- [type](IGovernorAddressUnlockCondition.md#type) -- [address](IGovernorAddressUnlockCondition.md#address) - -## Properties - -### type - -• **type**: `5` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### address - -• **address**: [`AddressTypes`](../api_ref.md#addresstypes) - -The address. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IImmutableAliasUnlockCondition.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IImmutableAliasUnlockCondition.md deleted file mode 100644 index b8a01a4c3a4..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IImmutableAliasUnlockCondition.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IImmutableAliasUnlockCondition - -Immutable Alias Unlock Condition. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`6`\> - - ↳ **`IImmutableAliasUnlockCondition`** - -## Table of contents - -### Properties - -- [type](IImmutableAliasUnlockCondition.md#type) -- [address](IImmutableAliasUnlockCondition.md#address) - -## Properties - -### type - -• **type**: `6` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### address - -• **address**: [`AddressTypes`](../api_ref.md#addresstypes) - -The address. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IIssuerFeature.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IIssuerFeature.md deleted file mode 100644 index ee6dc06044d..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IIssuerFeature.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IIssuerFeature - -Issuer feature. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`1`\> - - ↳ **`IIssuerFeature`** - -## Table of contents - -### Properties - -- [type](IIssuerFeature.md#type) -- [address](IIssuerFeature.md#address) - -## Properties - -### type - -• **type**: `1` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### address - -• **address**: [`AddressTypes`](../api_ref.md#addresstypes) - -The address. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IKeyPair.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IKeyPair.md deleted file mode 100644 index 1af4fa57c9d..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IKeyPair.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IKeyPair - -Definition of signature key pair. - -## Table of contents - -### Properties - -- [publicKey](IKeyPair.md#publickey) -- [privateKey](IKeyPair.md#privatekey) - -## Properties - -### publicKey - -• **publicKey**: `Uint8Array` - -The public key. - ---- - -### privateKey - -• **privateKey**: `Uint8Array` - -The private key. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IMetadataFeature.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IMetadataFeature.md deleted file mode 100644 index 8209b346185..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IMetadataFeature.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IMetadataFeature - -Metadata feature. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`2`\> - - ↳ **`IMetadataFeature`** - -## Table of contents - -### Properties - -- [type](IMetadataFeature.md#type) -- [data](IMetadataFeature.md#data) - -## Properties - -### type - -• **type**: `2` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### data - -• **data**: `string` - -Defines metadata (arbitrary binary data) that will be stored in the output. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IMigratedFunds.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IMigratedFunds.md deleted file mode 100644 index d106468bbe0..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IMigratedFunds.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IMigratedFunds - -The migrated funds for receipts. - -## Table of contents - -### Properties - -- [tailTransactionHash](IMigratedFunds.md#tailtransactionhash) -- [address](IMigratedFunds.md#address) -- [deposit](IMigratedFunds.md#deposit) - -## Properties - -### tailTransactionHash - -• **tailTransactionHash**: `string` - -The tail transaction hash of the migration bundle. - ---- - -### address - -• **address**: [`AddressTypes`](../api_ref.md#addresstypes) - -The target address of the migrated funds. - ---- - -### deposit - -• **deposit**: `string` - -The amount of the deposit. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IMilestonePayload.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IMilestonePayload.md deleted file mode 100644 index d9bd26b43dc..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IMilestonePayload.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IMilestonePayload - -Milestone payload. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`7`\> - - ↳ **`IMilestonePayload`** - -## Table of contents - -### Properties - -- [type](IMilestonePayload.md#type) -- [index](IMilestonePayload.md#index) -- [timestamp](IMilestonePayload.md#timestamp) -- [protocolVersion](IMilestonePayload.md#protocolversion) -- [previousMilestoneId](IMilestonePayload.md#previousmilestoneid) -- [parents](IMilestonePayload.md#parents) -- [inclusionMerkleRoot](IMilestonePayload.md#inclusionmerkleroot) -- [appliedMerkleRoot](IMilestonePayload.md#appliedmerkleroot) -- [metadata](IMilestonePayload.md#metadata) -- [options](IMilestonePayload.md#options) -- [signatures](IMilestonePayload.md#signatures) - -## Properties - -### type - -• **type**: `7` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### index - -• **index**: `number` - -The index name. - ---- - -### timestamp - -• **timestamp**: `number` - -The timestamp of the milestone. - ---- - -### protocolVersion - -• **protocolVersion**: `number` - -The protocol version. - ---- - -### previousMilestoneId - -• **previousMilestoneId**: `string` - -The id of the previous milestone. - ---- - -### parents - -• **parents**: `string`[] - -The parents where this milestone attaches to. - ---- - -### inclusionMerkleRoot - -• **inclusionMerkleRoot**: `string` - -The Merkle tree hash of all blocks confirmed by this milestone. - ---- - -### appliedMerkleRoot - -• **appliedMerkleRoot**: `string` - -The Merkle tree hash of all blocks applied by this milestone. - ---- - -### metadata - -• `Optional` **metadata**: `string` - -The metadata. - ---- - -### options - -• `Optional` **options**: [`MilestoneOptionTypes`](../api_ref.md#milestoneoptiontypes)[] - -The milestone options. - ---- - -### signatures - -• **signatures**: [`IEd25519Signature`](IEd25519Signature.md)[] - -The signatures. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IMilestoneUtxoChangesResponse.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IMilestoneUtxoChangesResponse.md deleted file mode 100644 index 8483cbfa623..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IMilestoneUtxoChangesResponse.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IMilestoneUtxoChangesResponse - -Milestone. - -## Table of contents - -### Properties - -- [index](IMilestoneUtxoChangesResponse.md#index) -- [createdOutputs](IMilestoneUtxoChangesResponse.md#createdoutputs) -- [consumedOutputs](IMilestoneUtxoChangesResponse.md#consumedoutputs) - -## Properties - -### index - -• **index**: `number` - -The milestone index. - ---- - -### createdOutputs - -• **createdOutputs**: `string`[] - -The output IDs (transaction hash + output index) of the newly created outputs. - ---- - -### consumedOutputs - -• **consumedOutputs**: `string`[] - -The output IDs (transaction hash + output index) of the consumed (spent) outputs. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INativeToken.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INativeToken.md deleted file mode 100644 index edace51b4ff..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INativeToken.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: INativeToken - -Native token. - -## Table of contents - -### Properties - -- [id](INativeToken.md#id) -- [amount](INativeToken.md#amount) - -## Properties - -### id - -• **id**: `string` - -Identifier of the native token. - ---- - -### amount - -• **amount**: `string` - -Amount of native tokens of the given Token ID. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INftAddress.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INftAddress.md deleted file mode 100644 index f3ab414dc5c..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INftAddress.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: INftAddress - -NFT address. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`16`\> - - ↳ **`INftAddress`** - -## Table of contents - -### Properties - -- [type](INftAddress.md#type) -- [nftId](INftAddress.md#nftid) - -## Properties - -### type - -• **type**: `16` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### nftId - -• **nftId**: `string` - -The NFT Id. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INftOutput.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INftOutput.md deleted file mode 100644 index a05e8cbc8a9..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INftOutput.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: INftOutput - -NFT output. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`6`\> - -- [`ICommonOutput`](ICommonOutput.md) - - ↳ **`INftOutput`** - -## Table of contents - -### Properties - -- [type](INftOutput.md#type) -- [nativeTokens](INftOutput.md#nativetokens) -- [unlockConditions](INftOutput.md#unlockconditions) -- [features](INftOutput.md#features) -- [amount](INftOutput.md#amount) -- [nftId](INftOutput.md#nftid) -- [immutableFeatures](INftOutput.md#immutablefeatures) - -## Properties - -### type - -• **type**: `6` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### nativeTokens - -• `Optional` **nativeTokens**: [`INativeToken`](INativeToken.md)[] - -The native tokens held by the output. - -#### Inherited from - -[ICommonOutput](ICommonOutput.md).[nativeTokens](ICommonOutput.md#nativetokens) - ---- - -### unlockConditions - -• **unlockConditions**: [`UnlockConditionTypes`](../api_ref.md#unlockconditiontypes)[] - -The unlock conditions for the output. - -#### Inherited from - -[ICommonOutput](ICommonOutput.md).[unlockConditions](ICommonOutput.md#unlockconditions) - ---- - -### features - -• `Optional` **features**: [`FeatureTypes`](../api_ref.md#featuretypes)[] - -Features contained by the output. - -#### Inherited from - -[ICommonOutput](ICommonOutput.md).[features](ICommonOutput.md#features) - ---- - -### amount - -• **amount**: `string` - -The amount of IOTA tokens held by the output. - ---- - -### nftId - -• **nftId**: `string` - -Unique identifier of the NFT, which is the BLAKE2b-160 hash of the Output ID that created it. - ---- - -### immutableFeatures - -• `Optional` **immutableFeatures**: [`FeatureTypes`](../api_ref.md#featuretypes)[] - -Immutable features contained by the output. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INftUnlock.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INftUnlock.md deleted file mode 100644 index b51f79853e1..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INftUnlock.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: INftUnlock - -An unlock which must reference a previous unlock which unlocks the NFT that the input is locked to. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`3`\> - - ↳ **`INftUnlock`** - -## Table of contents - -### Properties - -- [type](INftUnlock.md#type) -- [reference](INftUnlock.md#reference) - -## Properties - -### type - -• **type**: `3` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### reference - -• **reference**: `number` - -The reference. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfo.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfo.md deleted file mode 100644 index 97b1a26b641..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfo.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: INodeInfo - -Response from the /info endpoint. - -## Table of contents - -### Properties - -- [name](INodeInfo.md#name) -- [version](INodeInfo.md#version) -- [status](INodeInfo.md#status) -- [metrics](INodeInfo.md#metrics) -- [supportedProtocolVersions](INodeInfo.md#supportedprotocolversions) -- [protocol](INodeInfo.md#protocol) -- [pendingProtocolParameters](INodeInfo.md#pendingprotocolparameters) -- [baseToken](INodeInfo.md#basetoken) -- [features](INodeInfo.md#features) - -## Properties - -### name - -• **name**: `string` - -The name of the node. - ---- - -### version - -• **version**: `string` - -The version of node. - ---- - -### status - -• **status**: [`INodeInfoStatus`](INodeInfoStatus.md) - -The status of the node. - ---- - -### metrics - -• **metrics**: [`INodeInfoMetrics`](INodeInfoMetrics.md) - -The metrics for the node. - ---- - -### supportedProtocolVersions - -• **supportedProtocolVersions**: `number`[] - -The supported protocol versions. - ---- - -### protocol - -• **protocol**: [`INodeInfoProtocol`](INodeInfoProtocol.md) - -The protocol info of the node. - ---- - -### pendingProtocolParameters - -• **pendingProtocolParameters**: [`INodeInfoProtocolParamsMilestoneOpt`](INodeInfoProtocolParamsMilestoneOpt.md)[] - -Pending protocol parameters. - ---- - -### baseToken - -• **baseToken**: [`INodeInfoBaseToken`](INodeInfoBaseToken.md) - -The base token info of the node. - ---- - -### features - -• **features**: `string`[] - -Features supported by the node. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoBaseToken.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoBaseToken.md deleted file mode 100644 index f3a2adfdf09..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoBaseToken.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: INodeInfoBaseToken - -The base token info of the node. - -## Table of contents - -### Properties - -- [name](INodeInfoBaseToken.md#name) -- [tickerSymbol](INodeInfoBaseToken.md#tickersymbol) -- [unit](INodeInfoBaseToken.md#unit) -- [subunit](INodeInfoBaseToken.md#subunit) -- [decimals](INodeInfoBaseToken.md#decimals) -- [useMetricPrefix](INodeInfoBaseToken.md#usemetricprefix) - -## Properties - -### name - -• **name**: `string` - -The base token name. - ---- - -### tickerSymbol - -• **tickerSymbol**: `string` - -The base token ticker symbol. - ---- - -### unit - -• **unit**: `string` - -The base token unit. - ---- - -### subunit - -• `Optional` **subunit**: `string` - -The base token sub-unit. - ---- - -### decimals - -• **decimals**: `number` - -The base token decimals. - ---- - -### useMetricPrefix - -• **useMetricPrefix**: `boolean` - -The use metric prefix flag. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoMetrics.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoMetrics.md deleted file mode 100644 index f1701a686ae..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoMetrics.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: INodeInfoMetrics - -Response from the /info endpoint. - -## Table of contents - -### Properties - -- [blocksPerSecond](INodeInfoMetrics.md#blockspersecond) -- [referencedBlocksPerSecond](INodeInfoMetrics.md#referencedblockspersecond) -- [referencedRate](INodeInfoMetrics.md#referencedrate) - -## Properties - -### blocksPerSecond - -• **blocksPerSecond**: `number` - -Blocks per second. - ---- - -### referencedBlocksPerSecond - -• **referencedBlocksPerSecond**: `number` - -Referenced blocks per second. - ---- - -### referencedRate - -• **referencedRate**: `number` - -The rate at which rates are being referenced. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoMilestone.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoMilestone.md deleted file mode 100644 index 578155e9e02..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoMilestone.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: INodeInfoMilestone - -The milestone info. - -## Table of contents - -### Properties - -- [index](INodeInfoMilestone.md#index) -- [timestamp](INodeInfoMilestone.md#timestamp) -- [milestoneId](INodeInfoMilestone.md#milestoneid) - -## Properties - -### index - -• **index**: `number` - -The milestone index. - ---- - -### timestamp - -• `Optional` **timestamp**: `number` - -The milestone timestamp. - ---- - -### milestoneId - -• `Optional` **milestoneId**: `string` - -The milestone id. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoProtocol.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoProtocol.md deleted file mode 100644 index 29ab4ec77ed..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoProtocol.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: INodeInfoProtocol - -The Protocol Info. - -## Table of contents - -### Properties - -- [networkName](INodeInfoProtocol.md#networkname) -- [bech32Hrp](INodeInfoProtocol.md#bech32hrp) -- [tokenSupply](INodeInfoProtocol.md#tokensupply) -- [protocolVersion](INodeInfoProtocol.md#protocolversion) -- [minPowScore](INodeInfoProtocol.md#minpowscore) -- [rentStructure](INodeInfoProtocol.md#rentstructure) - -## Properties - -### networkName - -• **networkName**: `string` - -The human friendly name of the network on which the node operates on. - ---- - -### bech32Hrp - -• **bech32Hrp**: `string` - -The human readable part of bech32 addresses. - ---- - -### tokenSupply - -• **tokenSupply**: `string` - -The token supply. - ---- - -### protocolVersion - -• **protocolVersion**: `number` - -The protocol version. - ---- - -### minPowScore - -• **minPowScore**: `number` - -The minimum score required for PoW. - ---- - -### rentStructure - -• **rentStructure**: [`IRent`](IRent.md) - -The rent structure used by given node/network. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoProtocolParamsMilestoneOpt.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoProtocolParamsMilestoneOpt.md deleted file mode 100644 index e24e27c23f9..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoProtocolParamsMilestoneOpt.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: INodeInfoProtocolParamsMilestoneOpt - -Defines changing protocol parameters in a milestone. - -## Hierarchy - -- [`IProtocolParamsMilestoneOption`](IProtocolParamsMilestoneOption.md) - - ↳ **`INodeInfoProtocolParamsMilestoneOpt`** - -## Table of contents - -### Properties - -- [type](INodeInfoProtocolParamsMilestoneOpt.md#type) -- [targetMilestoneIndex](INodeInfoProtocolParamsMilestoneOpt.md#targetmilestoneindex) -- [protocolVersion](INodeInfoProtocolParamsMilestoneOpt.md#protocolversion) -- [params](INodeInfoProtocolParamsMilestoneOpt.md#params) - -## Properties - -### type - -• **type**: `1` - -The type of the object. - -#### Inherited from - -[IProtocolParamsMilestoneOption](IProtocolParamsMilestoneOption.md).[type](IProtocolParamsMilestoneOption.md#type) - ---- - -### targetMilestoneIndex - -• **targetMilestoneIndex**: `number` - -The milestone index at which these protocol parameters become active. - -#### Inherited from - -[IProtocolParamsMilestoneOption](IProtocolParamsMilestoneOption.md).[targetMilestoneIndex](IProtocolParamsMilestoneOption.md#targetmilestoneindex) - ---- - -### protocolVersion - -• **protocolVersion**: `number` - -The to be applied protocol version. - -#### Inherited from - -[IProtocolParamsMilestoneOption](IProtocolParamsMilestoneOption.md).[protocolVersion](IProtocolParamsMilestoneOption.md#protocolversion) - ---- - -### params - -• **params**: `string` - -The protocol parameters in binary form. Hex-encoded with 0x prefix. - -#### Inherited from - -[IProtocolParamsMilestoneOption](IProtocolParamsMilestoneOption.md).[params](IProtocolParamsMilestoneOption.md#params) diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoStatus.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoStatus.md deleted file mode 100644 index dcaf13abd7b..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/INodeInfoStatus.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: INodeInfoStatus - -Response from the /info endpoint. - -## Table of contents - -### Properties - -- [isHealthy](INodeInfoStatus.md#ishealthy) -- [latestMilestone](INodeInfoStatus.md#latestmilestone) -- [confirmedMilestone](INodeInfoStatus.md#confirmedmilestone) -- [pruningIndex](INodeInfoStatus.md#pruningindex) - -## Properties - -### isHealthy - -• **isHealthy**: `boolean` - -Is the node healthy. - ---- - -### latestMilestone - -• **latestMilestone**: [`INodeInfoMilestone`](INodeInfoMilestone.md) - -The latest milestone info. - ---- - -### confirmedMilestone - -• **confirmedMilestone**: [`INodeInfoMilestone`](INodeInfoMilestone.md) - -The confirmed milestone info. - ---- - -### pruningIndex - -• **pruningIndex**: `number` - -The pruning index. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IOutputMetadataResponse.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IOutputMetadataResponse.md deleted file mode 100644 index e2af9a390d8..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IOutputMetadataResponse.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IOutputMetadataResponse - -Details of an output. - -## Table of contents - -### Properties - -- [blockId](IOutputMetadataResponse.md#blockid) -- [transactionId](IOutputMetadataResponse.md#transactionid) -- [outputIndex](IOutputMetadataResponse.md#outputindex) -- [isSpent](IOutputMetadataResponse.md#isspent) -- [milestoneIndexSpent](IOutputMetadataResponse.md#milestoneindexspent) -- [milestoneTimestampSpent](IOutputMetadataResponse.md#milestonetimestampspent) -- [transactionIdSpent](IOutputMetadataResponse.md#transactionidspent) -- [milestoneIndexBooked](IOutputMetadataResponse.md#milestoneindexbooked) -- [milestoneTimestampBooked](IOutputMetadataResponse.md#milestonetimestampbooked) -- [ledgerIndex](IOutputMetadataResponse.md#ledgerindex) - -## Properties - -### blockId - -• **blockId**: `string` - -The block id the output was contained in. - ---- - -### transactionId - -• **transactionId**: `string` - -The transaction id for the output. - ---- - -### outputIndex - -• **outputIndex**: `number` - -The index for the output. - ---- - -### isSpent - -• **isSpent**: `boolean` - -Is the output spent. - ---- - -### milestoneIndexSpent - -• `Optional` **milestoneIndexSpent**: `number` - -The milestone index at which this output was spent. - ---- - -### milestoneTimestampSpent - -• `Optional` **milestoneTimestampSpent**: `number` - -The milestone timestamp this output was spent. - ---- - -### transactionIdSpent - -• `Optional` **transactionIdSpent**: `string` - -The transaction this output was spent with. - ---- - -### milestoneIndexBooked - -• **milestoneIndexBooked**: `number` - -The milestone index at which this output was booked into the ledger. - ---- - -### milestoneTimestampBooked - -• **milestoneTimestampBooked**: `number` - -The milestone timestamp this output was booked in the ledger. - ---- - -### ledgerIndex - -• **ledgerIndex**: `number` - -The ledger index at which these output was available at. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IOutputResponse.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IOutputResponse.md deleted file mode 100644 index 5b40356c904..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IOutputResponse.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IOutputResponse - -Details of an output. - -## Table of contents - -### Properties - -- [metadata](IOutputResponse.md#metadata) -- [output](IOutputResponse.md#output) - -## Properties - -### metadata - -• **metadata**: [`IOutputMetadataResponse`](IOutputMetadataResponse.md) - -The metadata about the output. - ---- - -### output - -• **output**: [`OutputTypes`](../api_ref.md#outputtypes) - -The output. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IOutputsResponse.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IOutputsResponse.md deleted file mode 100644 index 3b0a4c0f232..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IOutputsResponse.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IOutputsResponse - -Details of an outputs response from the indexer plugin. - -## Table of contents - -### Properties - -- [ledgerIndex](IOutputsResponse.md#ledgerindex) -- [pageSize](IOutputsResponse.md#pagesize) -- [cursor](IOutputsResponse.md#cursor) -- [items](IOutputsResponse.md#items) - -## Properties - -### ledgerIndex - -• **ledgerIndex**: `number` - -The ledger index at which these outputs where available at. - ---- - -### pageSize - -• **pageSize**: `string` - -The maximum count of results that are returned by the node. - ---- - -### cursor - -• `Optional` **cursor**: `string` - -The cursor to use for getting the next results. - ---- - -### items - -• **items**: `string`[] - -The output IDs (transaction hash + output index) of the outputs on this address. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IPeer.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IPeer.md deleted file mode 100644 index ff64f68b3e3..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IPeer.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IPeer - -Peer details. - -## Table of contents - -### Properties - -- [id](IPeer.md#id) -- [multiAddresses](IPeer.md#multiaddresses) -- [alias](IPeer.md#alias) -- [relation](IPeer.md#relation) -- [connected](IPeer.md#connected) -- [gossip](IPeer.md#gossip) - -## Properties - -### id - -• **id**: `string` - -The id of the peer. - ---- - -### multiAddresses - -• **multiAddresses**: `string`[] - -The addresses of the peer. - ---- - -### alias - -• `Optional` **alias**: `string` - -The alias of the peer. - ---- - -### relation - -• **relation**: `string` - -The relation of the peer. - ---- - -### connected - -• **connected**: `boolean` - -Is it connected. - ---- - -### gossip - -• `Optional` **gossip**: `Object` - -Gossip metrics for the peer. - -#### Type declaration - -| Name | Type | Description | -| :---------- | :---------------------------------------- | :------------------ | -| `heartbeat` | [`IGossipHeartbeat`](IGossipHeartbeat.md) | The peer heartbeat. | -| `metrics` | [`IGossipMetrics`](IGossipMetrics.md) | The peer metrics. | diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IPowProvider.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IPowProvider.md deleted file mode 100644 index 47aa4655a71..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IPowProvider.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IPowProvider - -Perform the POW on a block. - -## Implemented by - -- [`LocalPowProvider`](../classes/LocalPowProvider.md) - -## Table of contents - -### Methods - -- [pow](IPowProvider.md#pow) - -## Methods - -### pow - -▸ **pow**(`block`, `targetScore`): `Promise`<`string`\> - -Perform pow on the block and return the nonce of at least targetScore. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------- | :-------------------- | -| `block` | `Uint8Array` | The block to process. | -| `targetScore` | `number` | The target score. | - -#### Returns - -`Promise`<`string`\> - -The nonce as a string. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IProtocolParamsMilestoneOption.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IProtocolParamsMilestoneOption.md deleted file mode 100644 index 7c1c17dbbdc..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IProtocolParamsMilestoneOption.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IProtocolParamsMilestoneOption - -Protocol Parameters Milestone Option. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`1`\> - - ↳ **`IProtocolParamsMilestoneOption`** - - ↳↳ [`INodeInfoProtocolParamsMilestoneOpt`](INodeInfoProtocolParamsMilestoneOpt.md) - -## Table of contents - -### Properties - -- [type](IProtocolParamsMilestoneOption.md#type) -- [targetMilestoneIndex](IProtocolParamsMilestoneOption.md#targetmilestoneindex) -- [protocolVersion](IProtocolParamsMilestoneOption.md#protocolversion) -- [params](IProtocolParamsMilestoneOption.md#params) - -## Properties - -### type - -• **type**: `1` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### targetMilestoneIndex - -• **targetMilestoneIndex**: `number` - -The milestone index at which these protocol parameters become active. - ---- - -### protocolVersion - -• **protocolVersion**: `number` - -The to be applied protocol version. - ---- - -### params - -• **params**: `string` - -The protocol parameters in binary form. Hex-encoded with 0x prefix. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IReceiptMilestoneOption.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IReceiptMilestoneOption.md deleted file mode 100644 index d6a09b21807..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IReceiptMilestoneOption.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IReceiptMilestoneOption - -Receipt milestone option. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`0`\> - - ↳ **`IReceiptMilestoneOption`** - -## Table of contents - -### Properties - -- [type](IReceiptMilestoneOption.md#type) -- [migratedAt](IReceiptMilestoneOption.md#migratedat) -- [final](IReceiptMilestoneOption.md#final) -- [funds](IReceiptMilestoneOption.md#funds) -- [transaction](IReceiptMilestoneOption.md#transaction) - -## Properties - -### type - -• **type**: `0` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### migratedAt - -• **migratedAt**: `number` - -The milestone index at which the funds were migrated in the legacy network. - ---- - -### final - -• **final**: `boolean` - -Whether this Receipt is the final one for a given migrated at index. - ---- - -### funds - -• **funds**: [`IMigratedFunds`](IMigratedFunds.md)[] - -The index data. - ---- - -### transaction - -• **transaction**: [`ITreasuryTransactionPayload`](ITreasuryTransactionPayload.md) - -The TreasuryTransaction used to fund the funds. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IReceiptsResponse.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IReceiptsResponse.md deleted file mode 100644 index 0b4f77769d0..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IReceiptsResponse.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IReceiptsResponse - -Receipts response details. - -## Table of contents - -### Properties - -- [receipts](IReceiptsResponse.md#receipts) - -## Properties - -### receipts - -• **receipts**: { `milestoneIndex`: `number` ; `receipt`: [`IReceiptMilestoneOption`](IReceiptMilestoneOption.md) }[] - -The receipts. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IReferenceUnlock.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IReferenceUnlock.md deleted file mode 100644 index 41ce21799ce..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IReferenceUnlock.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IReferenceUnlock - -An unlock which must reference a previous unlock which unlocks -also the input at the same index as this Reference Unlock. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`1`\> - - ↳ **`IReferenceUnlock`** - -## Table of contents - -### Properties - -- [type](IReferenceUnlock.md#type) -- [reference](IReferenceUnlock.md#reference) - -## Properties - -### type - -• **type**: `1` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### reference - -• **reference**: `number` - -The reference. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IRent.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IRent.md deleted file mode 100644 index 409758c59bc..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IRent.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IRent - -Defines the parameters of rent cost calculations on objects which take node resources. - -## Table of contents - -### Properties - -- [vByteCost](IRent.md#vbytecost) -- [vByteFactorData](IRent.md#vbytefactordata) -- [vByteFactorKey](IRent.md#vbytefactorkey) - -## Properties - -### vByteCost - -• **vByteCost**: `number` - -Defines the rent of a single virtual byte denoted in IOTA token. - ---- - -### vByteFactorData - -• **vByteFactorData**: `number` - -The factor to be used for data only fields. - ---- - -### vByteFactorKey - -• **vByteFactorKey**: `number` - -The factor to be used for key/lookup generating fields. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IResponse.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IResponse.md deleted file mode 100644 index 72818e4e169..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IResponse.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IResponse - -Base response data. - -## Type parameters - -| Name | -| :--- | -| `T` | - -## Table of contents - -### Properties - -- [data](IResponse.md#data) -- [error](IResponse.md#error) - -## Properties - -### data - -• **data**: `T` - -The data in the response. - ---- - -### error - -• `Optional` **error**: `Object` - -Optional error in the response. - -#### Type declaration - -| Name | Type | Description | -| :-------- | :------- | :--------------------------------------- | -| `code` | `string` | The code for the error response. | -| `message` | `string` | A more descriptive version of the error. | diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IRoutesResponse.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IRoutesResponse.md deleted file mode 100644 index 08c3df4ba85..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IRoutesResponse.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IRoutesResponse - -Response from the /routes endpoint. - -## Table of contents - -### Properties - -- [routes](IRoutesResponse.md#routes) - -## Properties - -### routes - -• **routes**: `string`[] - -The routes the node exposes. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ISeed.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ISeed.md deleted file mode 100644 index fe4de2f57e2..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ISeed.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: ISeed - -Interface definitions for seed. - -## Implemented by - -- [`Ed25519Seed`](../classes/Ed25519Seed.md) - -## Table of contents - -### Methods - -- [keyPair](ISeed.md#keypair) -- [generateSeedFromPath](ISeed.md#generateseedfrompath) -- [toBytes](ISeed.md#tobytes) -- [toString](ISeed.md#tostring) - -## Methods - -### keyPair - -▸ **keyPair**(): [`IKeyPair`](IKeyPair.md) - -Get the key pair from the seed. - -#### Returns - -[`IKeyPair`](IKeyPair.md) - -The key pair. - ---- - -### generateSeedFromPath - -▸ **generateSeedFromPath**(`path`): [`ISeed`](ISeed.md) - -Generate a new seed from the path. - -#### Parameters - -| Name | Type | Description | -| :----- | :---------- | :--------------------------------- | -| `path` | `Bip32Path` | The path to generate the seed for. | - -#### Returns - -[`ISeed`](ISeed.md) - -The generated seed. - ---- - -### toBytes - -▸ **toBytes**(): `Uint8Array` - -Return the key as bytes. - -#### Returns - -`Uint8Array` - -The key as bytes. - ---- - -### toString - -▸ **toString**(): `string` - -Return the key as string. - -#### Returns - -`string` - -The key as string. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ISenderFeature.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ISenderFeature.md deleted file mode 100644 index b84883abda2..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ISenderFeature.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: ISenderFeature - -Sender feature. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`0`\> - - ↳ **`ISenderFeature`** - -## Table of contents - -### Properties - -- [type](ISenderFeature.md#type) -- [address](ISenderFeature.md#address) - -## Properties - -### type - -• **type**: `0` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### address - -• **address**: [`AddressTypes`](../api_ref.md#addresstypes) - -The address. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ISignatureUnlock.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ISignatureUnlock.md deleted file mode 100644 index ba8bf896d9e..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ISignatureUnlock.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: ISignatureUnlock - -An unlock holding one or more signatures unlocking one or more inputs.. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`0`\> - - ↳ **`ISignatureUnlock`** - -## Table of contents - -### Properties - -- [type](ISignatureUnlock.md#type) -- [signature](ISignatureUnlock.md#signature) - -## Properties - -### type - -• **type**: `0` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### signature - -• **signature**: [`IEd25519Signature`](IEd25519Signature.md) - -The signature. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ISimpleTokenScheme.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ISimpleTokenScheme.md deleted file mode 100644 index 74fc14e16c3..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ISimpleTokenScheme.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: ISimpleTokenScheme - -Simple token scheme. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`0`\> - - ↳ **`ISimpleTokenScheme`** - -## Table of contents - -### Properties - -- [type](ISimpleTokenScheme.md#type) -- [mintedTokens](ISimpleTokenScheme.md#mintedtokens) -- [meltedTokens](ISimpleTokenScheme.md#meltedtokens) -- [maximumSupply](ISimpleTokenScheme.md#maximumsupply) - -## Properties - -### type - -• **type**: `0` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### mintedTokens - -• **mintedTokens**: `string` - -Amount of tokens minted by this foundry. - ---- - -### meltedTokens - -• **meltedTokens**: `string` - -Amount of tokens melted by this foundry. - ---- - -### maximumSupply - -• **maximumSupply**: `string` - -Maximum supply of tokens controlled by this foundry. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IStateControllerAddressUnlockCondition.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IStateControllerAddressUnlockCondition.md deleted file mode 100644 index 48fa7cb2692..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IStateControllerAddressUnlockCondition.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IStateControllerAddressUnlockCondition - -State Controller Address Unlock Condition. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`4`\> - - ↳ **`IStateControllerAddressUnlockCondition`** - -## Table of contents - -### Properties - -- [type](IStateControllerAddressUnlockCondition.md#type) -- [address](IStateControllerAddressUnlockCondition.md#address) - -## Properties - -### type - -• **type**: `4` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### address - -• **address**: [`AddressTypes`](../api_ref.md#addresstypes) - -The address. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IStorageDepositReturnUnlockCondition.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IStorageDepositReturnUnlockCondition.md deleted file mode 100644 index b0717b3e0ce..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IStorageDepositReturnUnlockCondition.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IStorageDepositReturnUnlockCondition - -Storage Desposit Return Unlock Condition. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`1`\> - - ↳ **`IStorageDepositReturnUnlockCondition`** - -## Table of contents - -### Properties - -- [type](IStorageDepositReturnUnlockCondition.md#type) -- [returnAddress](IStorageDepositReturnUnlockCondition.md#returnaddress) -- [amount](IStorageDepositReturnUnlockCondition.md#amount) - -## Properties - -### type - -• **type**: `1` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### returnAddress - -• **returnAddress**: [`AddressTypes`](../api_ref.md#addresstypes) - -The return address. - ---- - -### amount - -• **amount**: `string` - -Amount of IOTA tokens the consuming transaction should deposit to the address defined in return address. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITagFeature.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITagFeature.md deleted file mode 100644 index 2fae42fccee..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITagFeature.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: ITagFeature - -Tag feature. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`3`\> - - ↳ **`ITagFeature`** - -## Table of contents - -### Properties - -- [type](ITagFeature.md#type) -- [tag](ITagFeature.md#tag) - -## Properties - -### type - -• **type**: `3` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### tag - -• **tag**: `string` - -Defines a tag for the data. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITaggedDataPayload.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITaggedDataPayload.md deleted file mode 100644 index 3a333f829f3..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITaggedDataPayload.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: ITaggedDataPayload - -Tagged data payload. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`5`\> - - ↳ **`ITaggedDataPayload`** - -## Table of contents - -### Properties - -- [type](ITaggedDataPayload.md#type) -- [tag](ITaggedDataPayload.md#tag) -- [data](ITaggedDataPayload.md#data) - -## Properties - -### type - -• **type**: `5` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### tag - -• **tag**: `string` - -The tag to use to categorize the data. - ---- - -### data - -• **data**: `string` - -The index data. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITimelockUnlockCondition.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITimelockUnlockCondition.md deleted file mode 100644 index c4a35f1cb9c..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITimelockUnlockCondition.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: ITimelockUnlockCondition - -Timelock Unlock Condition. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`2`\> - - ↳ **`ITimelockUnlockCondition`** - -## Table of contents - -### Properties - -- [type](ITimelockUnlockCondition.md#type) -- [unixTime](ITimelockUnlockCondition.md#unixtime) - -## Properties - -### type - -• **type**: `2` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### unixTime - -• **unixTime**: `number` - -Unix time (seconds since Unix epoch) starting from which the output can be consumed. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITipsResponse.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITipsResponse.md deleted file mode 100644 index afbb2e32714..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITipsResponse.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: ITipsResponse - -Response from the tips endpoint. - -## Table of contents - -### Properties - -- [tips](ITipsResponse.md#tips) - -## Properties - -### tips - -• **tips**: `string`[] - -The block ids of the tip. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITransactionEssence.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITransactionEssence.md deleted file mode 100644 index 7b96b2e4aa1..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITransactionEssence.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: ITransactionEssence - -Transaction payload. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`1`\> - - ↳ **`ITransactionEssence`** - -## Table of contents - -### Properties - -- [networkId](ITransactionEssence.md#networkid) -- [inputs](ITransactionEssence.md#inputs) -- [inputsCommitment](ITransactionEssence.md#inputscommitment) -- [outputs](ITransactionEssence.md#outputs) -- [payload](ITransactionEssence.md#payload) -- [type](ITransactionEssence.md#type) - -## Properties - -### networkId - -• **networkId**: `string` - -The network id of the block. - ---- - -### inputs - -• **inputs**: [`IUTXOInput`](IUTXOInput.md)[] - -The inputs of the transaction. - ---- - -### inputsCommitment - -• **inputsCommitment**: `string` - -The commitment to the referenced inputs. - ---- - -### outputs - -• **outputs**: [`OutputTypes`](../api_ref.md#outputtypes)[] - -The outputs of the transaction. - ---- - -### payload - -• `Optional` **payload**: [`ITaggedDataPayload`](ITaggedDataPayload.md) - -Tagged data payload. - ---- - -### type - -• **type**: `1` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITransactionPayload.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITransactionPayload.md deleted file mode 100644 index 8c66cb1765d..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITransactionPayload.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: ITransactionPayload - -Transaction payload. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`6`\> - - ↳ **`ITransactionPayload`** - -## Table of contents - -### Properties - -- [type](ITransactionPayload.md#type) -- [essence](ITransactionPayload.md#essence) -- [unlocks](ITransactionPayload.md#unlocks) - -## Properties - -### type - -• **type**: `6` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### essence - -• **essence**: [`ITransactionEssence`](ITransactionEssence.md) - -The index name. - ---- - -### unlocks - -• **unlocks**: [`UnlockTypes`](../api_ref.md#unlocktypes)[] - -The unlocks. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITreasury.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITreasury.md deleted file mode 100644 index 2241b0cad69..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITreasury.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: ITreasury - -Treasury. - -## Table of contents - -### Properties - -- [milestoneId](ITreasury.md#milestoneid) -- [amount](ITreasury.md#amount) - -## Properties - -### milestoneId - -• **milestoneId**: `string` - -The milestone hash of the treasury. - ---- - -### amount - -• **amount**: `string` - -The amount for the treasury. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITreasuryInput.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITreasuryInput.md deleted file mode 100644 index a90e014bfa0..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITreasuryInput.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: ITreasuryInput - -Treasury Input. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`1`\> - - ↳ **`ITreasuryInput`** - -## Table of contents - -### Properties - -- [type](ITreasuryInput.md#type) -- [milestoneId](ITreasuryInput.md#milestoneid) - -## Properties - -### type - -• **type**: `1` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### milestoneId - -• **milestoneId**: `string` - -The milestone id of the input. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITreasuryOutput.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITreasuryOutput.md deleted file mode 100644 index c0d648e609e..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITreasuryOutput.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: ITreasuryOutput - -Treasury Output. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`2`\> - - ↳ **`ITreasuryOutput`** - -## Table of contents - -### Properties - -- [type](ITreasuryOutput.md#type) -- [amount](ITreasuryOutput.md#amount) - -## Properties - -### type - -• **type**: `2` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### amount - -• **amount**: `string` - -The amount of the output. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITreasuryTransactionPayload.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITreasuryTransactionPayload.md deleted file mode 100644 index a6dfd6d11ac..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITreasuryTransactionPayload.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: ITreasuryTransactionPayload - -Receipt payload. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`4`\> - - ↳ **`ITreasuryTransactionPayload`** - -## Table of contents - -### Properties - -- [type](ITreasuryTransactionPayload.md#type) -- [input](ITreasuryTransactionPayload.md#input) -- [output](ITreasuryTransactionPayload.md#output) - -## Properties - -### type - -• **type**: `4` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### input - -• **input**: [`ITreasuryInput`](ITreasuryInput.md) - -The input of this transaction. - ---- - -### output - -• **output**: [`ITreasuryOutput`](ITreasuryOutput.md) - -The output of this transaction. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITypeBase.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITypeBase.md deleted file mode 100644 index db08a66691a..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/ITypeBase.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: ITypeBase - -Type of the object. - -## Type parameters - -| Name | -| :--- | -| `T` | - -## Hierarchy - -- **`ITypeBase`** - - ↳ [`IAliasAddress`](IAliasAddress.md) - - ↳ [`IEd25519Address`](IEd25519Address.md) - - ↳ [`INftAddress`](INftAddress.md) - - ↳ [`IIssuerFeature`](IIssuerFeature.md) - - ↳ [`IMetadataFeature`](IMetadataFeature.md) - - ↳ [`ISenderFeature`](ISenderFeature.md) - - ↳ [`ITagFeature`](ITagFeature.md) - - ↳ [`ITreasuryInput`](ITreasuryInput.md) - - ↳ [`IUTXOInput`](IUTXOInput.md) - - ↳ [`ITransactionEssence`](ITransactionEssence.md) - - ↳ [`IAliasOutput`](IAliasOutput.md) - - ↳ [`IBasicOutput`](IBasicOutput.md) - - ↳ [`IFoundryOutput`](IFoundryOutput.md) - - ↳ [`INftOutput`](INftOutput.md) - - ↳ [`ITreasuryOutput`](ITreasuryOutput.md) - - ↳ [`IMilestonePayload`](IMilestonePayload.md) - - ↳ [`IReceiptMilestoneOption`](IReceiptMilestoneOption.md) - - ↳ [`IProtocolParamsMilestoneOption`](IProtocolParamsMilestoneOption.md) - - ↳ [`ITaggedDataPayload`](ITaggedDataPayload.md) - - ↳ [`ITransactionPayload`](ITransactionPayload.md) - - ↳ [`ITreasuryTransactionPayload`](ITreasuryTransactionPayload.md) - - ↳ [`IEd25519Signature`](IEd25519Signature.md) - - ↳ [`ISimpleTokenScheme`](ISimpleTokenScheme.md) - - ↳ [`IAliasUnlock`](IAliasUnlock.md) - - ↳ [`INftUnlock`](INftUnlock.md) - - ↳ [`IReferenceUnlock`](IReferenceUnlock.md) - - ↳ [`ISignatureUnlock`](ISignatureUnlock.md) - - ↳ [`IAddressUnlockCondition`](IAddressUnlockCondition.md) - - ↳ [`IExpirationUnlockCondition`](IExpirationUnlockCondition.md) - - ↳ [`IGovernorAddressUnlockCondition`](IGovernorAddressUnlockCondition.md) - - ↳ [`IImmutableAliasUnlockCondition`](IImmutableAliasUnlockCondition.md) - - ↳ [`IStateControllerAddressUnlockCondition`](IStateControllerAddressUnlockCondition.md) - - ↳ [`IStorageDepositReturnUnlockCondition`](IStorageDepositReturnUnlockCondition.md) - - ↳ [`ITimelockUnlockCondition`](ITimelockUnlockCondition.md) - -## Table of contents - -### Properties - -- [type](ITypeBase.md#type) - -## Properties - -### type - -• **type**: `T` - -The type of the object. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IUTXOInput.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IUTXOInput.md deleted file mode 100644 index 8c758893933..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/IUTXOInput.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IUTXOInput - -UTXO Transaction Input. - -## Hierarchy - -- [`ITypeBase`](ITypeBase.md)<`0`\> - - ↳ **`IUTXOInput`** - -## Table of contents - -### Properties - -- [type](IUTXOInput.md#type) -- [transactionId](IUTXOInput.md#transactionid) -- [transactionOutputIndex](IUTXOInput.md#transactionoutputindex) - -## Properties - -### type - -• **type**: `0` - -The type of the object. - -#### Inherited from - -[ITypeBase](ITypeBase.md).[type](ITypeBase.md#type) - ---- - -### transactionId - -• **transactionId**: `string` - -The transaction Id. - ---- - -### transactionOutputIndex - -• **transactionOutputIndex**: `number` - -The output index. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/SingleNodeClientOptions.md b/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/SingleNodeClientOptions.md deleted file mode 100644 index fc2f5d5c772..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/client/interfaces/SingleNodeClientOptions.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: SingleNodeClientOptions - -Options used when constructing SingleNodeClient. - -## Table of contents - -### Properties - -- [basePath](SingleNodeClientOptions.md#basepath) -- [powProvider](SingleNodeClientOptions.md#powprovider) -- [protocolVersion](SingleNodeClientOptions.md#protocolversion) -- [timeout](SingleNodeClientOptions.md#timeout) -- [userName](SingleNodeClientOptions.md#username) -- [password](SingleNodeClientOptions.md#password) -- [headers](SingleNodeClientOptions.md#headers) - -## Properties - -### basePath - -• `Optional` **basePath**: `string` - -Base path for API location, defaults to /api/. - ---- - -### powProvider - -• `Optional` **powProvider**: [`IPowProvider`](IPowProvider.md) - -Use a custom pow provider instead of the one on the node. - ---- - -### protocolVersion - -• `Optional` **protocolVersion**: `number` - -The protocol version for blocks. - ---- - -### timeout - -• `Optional` **timeout**: `number` - -Timeout for API requests. - ---- - -### userName - -• `Optional` **userName**: `string` - -Username for the endpoint. - ---- - -### password - -• `Optional` **password**: `string` - -Password for the endpoint. - ---- - -### headers - -• `Optional` **headers**: `Object` - -Additional headers to include in the requests. - -#### Index signature - -▪ [id: `string`]: `string` diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/api_ref.md b/docs/build/iota.js/2.0-rc.1/docs/references/crypto/api_ref.md deleted file mode 100644 index 738ae604d6c..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/api_ref.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# @iota/crypto.js - -## Table of contents - -### Classes - -- [Bech32](classes/Bech32.md) -- [ChaCha20](classes/ChaCha20.md) -- [ChaCha20Poly1305](classes/ChaCha20Poly1305.md) -- [Blake2b](classes/Blake2b.md) -- [Curl](classes/Curl.md) -- [Sha1](classes/Sha1.md) -- [Sha256](classes/Sha256.md) -- [Sha512](classes/Sha512.md) -- [Bip32Path](classes/Bip32Path.md) -- [Bip39](classes/Bip39.md) -- [Pbkdf2](classes/Pbkdf2.md) -- [Slip0010](classes/Slip0010.md) -- [HmacSha1](classes/HmacSha1.md) -- [HmacSha256](classes/HmacSha256.md) -- [HmacSha512](classes/HmacSha512.md) -- [Poly1305](classes/Poly1305.md) -- [Ed25519](classes/Ed25519.md) -- [X25519](classes/X25519.md) -- [Zip215](classes/Zip215.md) -- [ArrayHelper](classes/ArrayHelper.md) diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/ArrayHelper.md b/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/ArrayHelper.md deleted file mode 100644 index d246c4740ee..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/ArrayHelper.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: ArrayHelper - -Array helper methods. - -## Table of contents - -### Methods - -- [equal](ArrayHelper.md#equal) - -### Constructors - -- [constructor](ArrayHelper.md#constructor) - -## Methods - -### equal - -▸ `Static` **equal**(`array1`, `array2`): `boolean` - -Are the two array equals. - -#### Parameters - -| Name | Type | Description | -| :------- | :------------------------------------- | :---------------- | -| `array1` | `undefined` \| `ArrayLike`<`unknown`\> | The first array. | -| `array2` | `undefined` \| `ArrayLike`<`unknown`\> | The second array. | - -#### Returns - -`boolean` - -True if the arrays are equal. - -## Constructors - -### constructor - -• **new ArrayHelper**() diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Bech32.md b/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Bech32.md deleted file mode 100644 index b5c7d4cd392..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Bech32.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: Bech32 - -Class to help with Bech32 encoding/decoding. -Based on reference implementation https://github.com/sipa/bech32/blob/master/ref/javascript/bech32.js. - -## Table of contents - -### Methods - -- [encode](Bech32.md#encode) -- [encode5BitArray](Bech32.md#encode5bitarray) -- [decode](Bech32.md#decode) -- [decodeTo5BitArray](Bech32.md#decodeto5bitarray) -- [to5Bit](Bech32.md#to5bit) -- [from5Bit](Bech32.md#from5bit) -- [matches](Bech32.md#matches) - -### Constructors - -- [constructor](Bech32.md#constructor) - -## Methods - -### encode - -▸ `Static` **encode**(`humanReadablePart`, `data`): `string` - -Encode the buffer. - -#### Parameters - -| Name | Type | Description | -| :------------------ | :----------- | :------------------ | -| `humanReadablePart` | `string` | The header. | -| `data` | `Uint8Array` | The data to encode. | - -#### Returns - -`string` - -The encoded data. - ---- - -### encode5BitArray - -▸ `Static` **encode5BitArray**(`humanReadablePart`, `data5Bit`): `string` - -Encode the 5 bit data buffer. - -#### Parameters - -| Name | Type | Description | -| :------------------ | :----------- | :------------------ | -| `humanReadablePart` | `string` | The header. | -| `data5Bit` | `Uint8Array` | The data to encode. | - -#### Returns - -`string` - -The encoded data. - ---- - -### decode - -▸ `Static` **decode**(`bech`): `undefined` \| {} - -Decode a bech32 string. - -#### Parameters - -| Name | Type | Description | -| :----- | :------- | :------------------ | -| `bech` | `string` | The text to decode. | - -#### Returns - -`undefined` \| {} - -The decoded data or undefined if it could not be decoded. - ---- - -### decodeTo5BitArray - -▸ `Static` **decodeTo5BitArray**(`bech`): `undefined` \| {} - -Decode a bech32 string to 5 bit array. - -#### Parameters - -| Name | Type | Description | -| :----- | :------- | :------------------ | -| `bech` | `string` | The text to decode. | - -#### Returns - -`undefined` \| {} - -The decoded data or undefined if it could not be decoded. - ---- - -### to5Bit - -▸ `Static` **to5Bit**(`bytes`): `Uint8Array` - -Convert the input bytes into 5 bit data. - -#### Parameters - -| Name | Type | Description | -| :------ | :----------- | :-------------------- | -| `bytes` | `Uint8Array` | The bytes to convert. | - -#### Returns - -`Uint8Array` - -The data in 5 bit form. - ---- - -### from5Bit - -▸ `Static` **from5Bit**(`fiveBit`): `Uint8Array` - -Convert the 5 bit data to 8 bit. - -#### Parameters - -| Name | Type | Description | -| :-------- | :----------- | :------------------------- | -| `fiveBit` | `Uint8Array` | The 5 bit data to convert. | - -#### Returns - -`Uint8Array` - -The 5 bit data converted to 8 bit. - ---- - -### matches - -▸ `Static` **matches**(`humanReadablePart`, `bech32Text?`): `boolean` - -Does the given string match the bech32 pattern. - -#### Parameters - -| Name | Type | Description | -| :------------------ | :------- | :----------------------- | -| `humanReadablePart` | `string` | The human readable part. | -| `bech32Text?` | `string` | The text to test. | - -#### Returns - -`boolean` - -True if this is potentially a match. - -## Constructors - -### constructor - -• **new Bech32**() diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Bip32Path.md b/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Bip32Path.md deleted file mode 100644 index 8ff3079b26f..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Bip32Path.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: Bip32Path - -Class to help with bip32 paths. - -## Table of contents - -### Constructors - -- [constructor](Bip32Path.md#constructor) - -### Methods - -- [fromPath](Bip32Path.md#frompath) -- [toString](Bip32Path.md#tostring) -- [push](Bip32Path.md#push) -- [pushHardened](Bip32Path.md#pushhardened) -- [pop](Bip32Path.md#pop) -- [numberSegments](Bip32Path.md#numbersegments) - -## Constructors - -### constructor - -• **new Bip32Path**(`initialPath?`) - -Create a new instance of Bip32Path. - -#### Parameters - -| Name | Type | Description | -| :------------- | :------- | :---------------------- | -| `initialPath?` | `string` | Initial path to create. | - -## Methods - -### fromPath - -▸ `Static` **fromPath**(`bip32Path`): [`Bip32Path`](Bip32Path.md) - -Construct a new path by cloning an existing one. - -#### Parameters - -| Name | Type | Description | -| :---------- | :-------------------------- | :----------------- | -| `bip32Path` | [`Bip32Path`](Bip32Path.md) | The path to clone. | - -#### Returns - -[`Bip32Path`](Bip32Path.md) - -A new instance of Bip32Path. - ---- - -### toString - -▸ **toString**(): `string` - -Converts the path to a string. - -#### Returns - -`string` - -The path as a string. - ---- - -### push - -▸ **push**(`index`): `void` - -Push a new index on to the path. - -#### Parameters - -| Name | Type | Description | -| :------ | :------- | :---------------------------- | -| `index` | `number` | The index to add to the path. | - -#### Returns - -`void` - ---- - -### pushHardened - -▸ **pushHardened**(`index`): `void` - -Push a new hardened index on to the path. - -#### Parameters - -| Name | Type | Description | -| :------ | :------- | :---------------------------- | -| `index` | `number` | The index to add to the path. | - -#### Returns - -`void` - ---- - -### pop - -▸ **pop**(): `void` - -Pop an index from the path. - -#### Returns - -`void` - ---- - -### numberSegments - -▸ **numberSegments**(): `number`[] - -Get the segments. - -#### Returns - -`number`[] - -The segments as numbers. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Bip39.md b/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Bip39.md deleted file mode 100644 index bdd80fad7b5..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Bip39.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: Bip39 - -Implementation of Bip39 for mnemonic generation. - -## Table of contents - -### Methods - -- [setWordList](Bip39.md#setwordlist) -- [randomMnemonic](Bip39.md#randommnemonic) -- [entropyToMnemonic](Bip39.md#entropytomnemonic) -- [mnemonicToSeed](Bip39.md#mnemonictoseed) -- [mnemonicToEntropy](Bip39.md#mnemonictoentropy) -- [entropyChecksumBits](Bip39.md#entropychecksumbits) - -### Constructors - -- [constructor](Bip39.md#constructor) - -## Methods - -### setWordList - -▸ `Static` **setWordList**(`wordlistData`, `joiningChar?`): `void` - -Set the wordlist and joining character. - -#### Parameters - -| Name | Type | Default value | Description | -| :------------- | :--------- | :------------ | :------------------------------------ | -| `wordlistData` | `string`[] | `undefined` | Array of words. | -| `joiningChar` | `string` | `" "` | The character to join the words with. | - -#### Returns - -`void` - ---- - -### randomMnemonic - -▸ `Static` **randomMnemonic**(`length?`): `string` - -Generate a random mnemonic. - -#### Parameters - -| Name | Type | Default value | Description | -| :------- | :------- | :------------ | :------------------------------------------------------- | -| `length` | `number` | `256` | The length of the mnemonic to generate, defaults to 256. | - -#### Returns - -`string` - -The random mnemonic. - ---- - -### entropyToMnemonic - -▸ `Static` **entropyToMnemonic**(`entropy`): `string` - -Generate a mnemonic from the entropy. - -#### Parameters - -| Name | Type | Description | -| :-------- | :----------- | :----------------------- | -| `entropy` | `Uint8Array` | The entropy to generate. | - -#### Returns - -`string` - -The mnemonic. - ---- - -### mnemonicToSeed - -▸ `Static` **mnemonicToSeed**(`mnemonic`, `password?`, `iterations?`, `keyLength?`): `Uint8Array` - -Convert a mnemonic to a seed. - -#### Parameters - -| Name | Type | Default value | Description | -| :----------- | :------- | :------------ | :------------------------------------------------------------------------------ | -| `mnemonic` | `string` | `undefined` | The mnemonic to convert. | -| `password?` | `string` | `undefined` | The password to apply to the seed generation. | -| `iterations` | `number` | `2048` | The number of iterations to perform on the password function, defaults to 2048. | -| `keyLength` | `number` | `64` | The size of the key length to generate, defaults to 64. | - -#### Returns - -`Uint8Array` - -The seed. - ---- - -### mnemonicToEntropy - -▸ `Static` **mnemonicToEntropy**(`mnemonic`): `Uint8Array` - -Convert the mnemonic back to entropy. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :----------------------- | -| `mnemonic` | `string` | The mnemonic to convert. | - -#### Returns - -`Uint8Array` - -The entropy. - ---- - -### entropyChecksumBits - -▸ `Static` **entropyChecksumBits**(`entropy`): `string` - -Calculate the entropy checksum. - -#### Parameters - -| Name | Type | Description | -| :-------- | :----------- | :----------------------------------------- | -| `entropy` | `Uint8Array` | The entropy to calculate the checksum for. | - -#### Returns - -`string` - -The checksum. - -## Constructors - -### constructor - -• **new Bip39**() diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Blake2b.md b/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Blake2b.md deleted file mode 100644 index 343d8f81e8f..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Blake2b.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: Blake2b - -Class to help with Blake2B Signature scheme. -TypeScript conversion from https://github.com/dcposch/blakejs. - -## Table of contents - -### Properties - -- [SIZE_160](Blake2b.md#size_160) -- [SIZE_256](Blake2b.md#size_256) -- [SIZE_512](Blake2b.md#size_512) - -### Constructors - -- [constructor](Blake2b.md#constructor) - -### Methods - -- [sum160](Blake2b.md#sum160) -- [sum256](Blake2b.md#sum256) -- [sum512](Blake2b.md#sum512) -- [update](Blake2b.md#update) -- [final](Blake2b.md#final) - -## Properties - -### SIZE_160 - -▪ `Static` **SIZE_160**: `number` = `20` - -Blake2b 160. - ---- - -### SIZE_256 - -▪ `Static` **SIZE_256**: `number` = `32` - -Blake2b 256. - ---- - -### SIZE_512 - -▪ `Static` **SIZE_512**: `number` = `64` - -Blake2b 512. - -## Constructors - -### constructor - -• **new Blake2b**(`outlen`, `key?`) - -Create a new instance of Blake2b. - -#### Parameters - -| Name | Type | Description | -| :------- | :----------- | :------------------------------------ | -| `outlen` | `number` | Output length between 1 and 64 bytes. | -| `key?` | `Uint8Array` | Optional key. | - -## Methods - -### sum160 - -▸ `Static` **sum160**(`data`, `key?`): `Uint8Array` - -Perform Sum 160 on the data. - -#### Parameters - -| Name | Type | Description | -| :----- | :----------- | :------------------------- | -| `data` | `Uint8Array` | The data to operate on. | -| `key?` | `Uint8Array` | Optional key for the hash. | - -#### Returns - -`Uint8Array` - -The sum 160 of the data. - ---- - -### sum256 - -▸ `Static` **sum256**(`data`, `key?`): `Uint8Array` - -Perform Sum 256 on the data. - -#### Parameters - -| Name | Type | Description | -| :----- | :----------- | :------------------------- | -| `data` | `Uint8Array` | The data to operate on. | -| `key?` | `Uint8Array` | Optional key for the hash. | - -#### Returns - -`Uint8Array` - -The sum 256 of the data. - ---- - -### sum512 - -▸ `Static` **sum512**(`data`, `key?`): `Uint8Array` - -Perform Sum 512 on the data. - -#### Parameters - -| Name | Type | Description | -| :----- | :----------- | :------------------------- | -| `data` | `Uint8Array` | The data to operate on. | -| `key?` | `Uint8Array` | Optional key for the hash. | - -#### Returns - -`Uint8Array` - -The sum 512 of the data. - ---- - -### update - -▸ **update**(`input`): `void` - -Updates a BLAKE2b streaming hash. - -#### Parameters - -| Name | Type | Description | -| :------ | :----------- | :---------------- | -| `input` | `Uint8Array` | The data to hash. | - -#### Returns - -`void` - ---- - -### final - -▸ **final**(): `Uint8Array` - -Completes a BLAKE2b streaming hash. - -#### Returns - -`Uint8Array` - -The final data. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/ChaCha20.md b/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/ChaCha20.md deleted file mode 100644 index f4b20889756..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/ChaCha20.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: ChaCha20 - -Implementation of the ChaCha20 cipher. - -## Table of contents - -### Constructors - -- [constructor](ChaCha20.md#constructor) - -### Methods - -- [encrypt](ChaCha20.md#encrypt) -- [decrypt](ChaCha20.md#decrypt) -- [keyStream](ChaCha20.md#keystream) - -## Constructors - -### constructor - -• **new ChaCha20**(`key`, `nonce`, `counter?`) - -Create a new instance of ChaCha20. - -#### Parameters - -| Name | Type | Default value | Description | -| :-------- | :----------- | :------------ | :---------- | -| `key` | `Uint8Array` | `undefined` | The key. | -| `nonce` | `Uint8Array` | `undefined` | The nonce. | -| `counter` | `number` | `0` | Counter. | - -## Methods - -### encrypt - -▸ **encrypt**(`data`): `Uint8Array` - -Encrypt the data. - -#### Parameters - -| Name | Type | Description | -| :----- | :----------- | :-------------------------- | -| `data` | `Uint8Array` | The source data to encrypt. | - -#### Returns - -`Uint8Array` - -The encrypted data. - ---- - -### decrypt - -▸ **decrypt**(`data`): `Uint8Array` - -Decrypt the data. - -#### Parameters - -| Name | Type | Description | -| :----- | :----------- | :-------------------------- | -| `data` | `Uint8Array` | The source data to decrypt. | - -#### Returns - -`Uint8Array` - -The decrypted data. - ---- - -### keyStream - -▸ **keyStream**(`length`): `Uint8Array` - -Create a keystream of the given length. - -#### Parameters - -| Name | Type | Description | -| :------- | :------- | :---------------------------------- | -| `length` | `number` | The length to create the keystream. | - -#### Returns - -`Uint8Array` - -The keystream. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/ChaCha20Poly1305.md b/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/ChaCha20Poly1305.md deleted file mode 100644 index cba749f2144..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/ChaCha20Poly1305.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: ChaCha20Poly1305 - -Implementation of the ChaCha20Poly1305 cipher. - -## Table of contents - -### Methods - -- [encryptor](ChaCha20Poly1305.md#encryptor) -- [decryptor](ChaCha20Poly1305.md#decryptor) -- [setAAD](ChaCha20Poly1305.md#setaad) -- [update](ChaCha20Poly1305.md#update) -- [final](ChaCha20Poly1305.md#final) -- [getAuthTag](ChaCha20Poly1305.md#getauthtag) -- [setAuthTag](ChaCha20Poly1305.md#setauthtag) - -## Methods - -### encryptor - -▸ `Static` **encryptor**(`key`, `nonce`): [`ChaCha20Poly1305`](ChaCha20Poly1305.md) - -Create a ChaCha20Poly1305 encryptor. - -#### Parameters - -| Name | Type | Description | -| :------ | :----------- | :---------- | -| `key` | `Uint8Array` | The key. | -| `nonce` | `Uint8Array` | The nonce. | - -#### Returns - -[`ChaCha20Poly1305`](ChaCha20Poly1305.md) - -Encryptor instance of ChaCha20Poly1305. - ---- - -### decryptor - -▸ `Static` **decryptor**(`key`, `nonce`): [`ChaCha20Poly1305`](ChaCha20Poly1305.md) - -Create a ChaCha20Poly1305 decryptor. - -#### Parameters - -| Name | Type | Description | -| :------ | :----------- | :---------- | -| `key` | `Uint8Array` | The key. | -| `nonce` | `Uint8Array` | The nonce. | - -#### Returns - -[`ChaCha20Poly1305`](ChaCha20Poly1305.md) - -Decryptor instance of ChaCha20Poly1305. - ---- - -### setAAD - -▸ **setAAD**(`aad`): `void` - -Set the AAD. - -#### Parameters - -| Name | Type | Description | -| :---- | :----------- | :-------------- | -| `aad` | `Uint8Array` | The aad to set. | - -#### Returns - -`void` - ---- - -### update - -▸ **update**(`input`): `Uint8Array` - -Update the cipher with more data. - -#### Parameters - -| Name | Type | Description | -| :------ | :----------- | :------------------------- | -| `input` | `Uint8Array` | The input data to include. | - -#### Returns - -`Uint8Array` - -The updated data. - ---- - -### final - -▸ **final**(): `void` - -Finalise the data. - -#### Returns - -`void` - ---- - -### getAuthTag - -▸ **getAuthTag**(): `Uint8Array` - -Get the auth tag. - -#### Returns - -`Uint8Array` - -The auth tag. - ---- - -### setAuthTag - -▸ **setAuthTag**(`authTag`): `void` - -Set the auth tag. - -#### Parameters - -| Name | Type | Description | -| :-------- | :----------- | :---------------- | -| `authTag` | `Uint8Array` | Set the auth tag. | - -#### Returns - -`void` diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Curl.md b/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Curl.md deleted file mode 100644 index 8713d506f2c..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Curl.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: Curl - -Class to implement Curl sponge. - -## Table of contents - -### Properties - -- [HASH_LENGTH](Curl.md#hash_length) -- [STATE_LENGTH](Curl.md#state_length) - -### Constructors - -- [constructor](Curl.md#constructor) - -### Methods - -- [transform](Curl.md#transform) -- [reset](Curl.md#reset) -- [rate](Curl.md#rate) -- [absorb](Curl.md#absorb) -- [squeeze](Curl.md#squeeze) - -## Properties - -### HASH_LENGTH - -▪ `Static` `Readonly` **HASH_LENGTH**: `number` = `243` - -The Hash Length. - ---- - -### STATE_LENGTH - -▪ `Static` `Readonly` **STATE_LENGTH**: `number` - -The State Length. - -## Constructors - -### constructor - -• **new Curl**(`rounds?`) - -Create a new instance of Curl. - -#### Parameters - -| Name | Type | Default value | Description | -| :------- | :------- | :---------------------- | :------------------------------- | -| `rounds` | `number` | `Curl.NUMBER_OF_ROUNDS` | The number of rounds to perform. | - -## Methods - -### transform - -▸ `Static` **transform**(`curlState`, `rounds`): `void` - -Sponge transform function. - -#### Parameters - -| Name | Type | Description | -| :---------- | :---------- | :--------------------------- | -| `curlState` | `Int8Array` | The curl state to transform. | -| `rounds` | `number` | The number of rounds to use. | - -#### Returns - -`void` - ---- - -### reset - -▸ **reset**(): `void` - -Resets the state. - -#### Returns - -`void` - ---- - -### rate - -▸ **rate**(`len?`): `Int8Array` - -Get the state of the sponge. - -#### Parameters - -| Name | Type | Default value | Description | -| :---- | :------- | :----------------- | :------------------------------ | -| `len` | `number` | `Curl.HASH_LENGTH` | The length of the state to get. | - -#### Returns - -`Int8Array` - -The state. - ---- - -### absorb - -▸ **absorb**(`trits`, `offset`, `length`): `void` - -Absorbs trits given an offset and length. - -#### Parameters - -| Name | Type | Description | -| :------- | :---------- | :--------------------------------------------- | -| `trits` | `Int8Array` | The trits to absorb. | -| `offset` | `number` | The offset to start abororbing from the array. | -| `length` | `number` | The length of trits to absorb. | - -#### Returns - -`void` - ---- - -### squeeze - -▸ **squeeze**(`trits`, `offset`, `length`): `void` - -Squeezes trits given an offset and length. - -#### Parameters - -| Name | Type | Description | -| :------- | :---------- | :-------------------------------------------- | -| `trits` | `Int8Array` | The trits to squeeze. | -| `offset` | `number` | The offset to start squeezing from the array. | -| `length` | `number` | The length of trits to squeeze. | - -#### Returns - -`void` diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Ed25519.md b/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Ed25519.md deleted file mode 100644 index 408b31bae99..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Ed25519.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: Ed25519 - -Implementation of Ed25519. - -## Table of contents - -### Properties - -- [PUBLIC_KEY_SIZE](Ed25519.md#public_key_size) -- [PRIVATE_KEY_SIZE](Ed25519.md#private_key_size) -- [SIGNATURE_SIZE](Ed25519.md#signature_size) -- [SEED_SIZE](Ed25519.md#seed_size) - -### Methods - -- [publicKeyFromPrivateKey](Ed25519.md#publickeyfromprivatekey) -- [keyPairFromSeed](Ed25519.md#keypairfromseed) -- [privateKeyFromSeed](Ed25519.md#privatekeyfromseed) -- [sign](Ed25519.md#sign) -- [verify](Ed25519.md#verify) - -### Constructors - -- [constructor](Ed25519.md#constructor) - -## Properties - -### PUBLIC_KEY_SIZE - -▪ `Static` **PUBLIC_KEY_SIZE**: `number` = `32` - -PublicKeySize is the size, in bytes, of public keys as used in this package. - ---- - -### PRIVATE_KEY_SIZE - -▪ `Static` **PRIVATE_KEY_SIZE**: `number` = `64` - -PrivateKeySize is the size, in bytes, of private keys as used in this package. - ---- - -### SIGNATURE_SIZE - -▪ `Static` **SIGNATURE_SIZE**: `number` = `64` - -SignatureSize is the size, in bytes, of signatures generated and verified by this package. - ---- - -### SEED_SIZE - -▪ `Static` **SEED_SIZE**: `number` = `32` - -SeedSize is the size, in bytes, of private key seeds. These are the private key representations used by RFC 8032. - -## Methods - -### publicKeyFromPrivateKey - -▸ `Static` **publicKeyFromPrivateKey**(`privateKey`): `Uint8Array` - -Public returns the PublicKey corresponding to priv. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :--------------------------------------------------- | -| `privateKey` | `Uint8Array` | The private key to get the corresponding public key. | - -#### Returns - -`Uint8Array` - -The public key. - ---- - -### keyPairFromSeed - -▸ `Static` **keyPairFromSeed**(`seed`): `Object` - -Generate the key pair from the seed. - -#### Parameters - -| Name | Type | Description | -| :----- | :----------- | :------------------------------------- | -| `seed` | `Uint8Array` | The seed to generate the key pair for. | - -#### Returns - -`Object` - -The key pair. - -| Name | Type | Description | -| :----------- | :----------- | :--------------------------------------- | -| `publicKey` | `Uint8Array` | The private key generated from the seed. | -| `privateKey` | `Uint8Array` | The public key generated from the seed. | - ---- - -### privateKeyFromSeed - -▸ `Static` **privateKeyFromSeed**(`seed`): `Uint8Array` - -Calculates a private key from a seed. - -#### Parameters - -| Name | Type | Description | -| :----- | :----------- | :----------------------------------------- | -| `seed` | `Uint8Array` | The seed to generate the private key from. | - -#### Returns - -`Uint8Array` - -The private key. - ---- - -### sign - -▸ `Static` **sign**(`privateKey`, `block`): `Uint8Array` - -Sign the block with privateKey and returns a signature. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :----------------- | -| `privateKey` | `Uint8Array` | The private key. | -| `block` | `Uint8Array` | The block to sign. | - -#### Returns - -`Uint8Array` - -The signature. - ---- - -### verify - -▸ `Static` **verify**(`publicKey`, `block`, `sig`): `boolean` - -Verify reports whether sig is a valid signature of block by publicKey. - -#### Parameters - -| Name | Type | Description | -| :---------- | :----------- | :-------------------------------------- | -| `publicKey` | `Uint8Array` | The public key to verify the signature. | -| `block` | `Uint8Array` | The block for the signature. | -| `sig` | `Uint8Array` | The signature. | - -#### Returns - -`boolean` - -True if the signature matches. - -## Constructors - -### constructor - -• **new Ed25519**() diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/HmacSha1.md b/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/HmacSha1.md deleted file mode 100644 index 6ffb53325ed..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/HmacSha1.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: HmacSha1 - -Class to help with HmacSha1 scheme. -TypeScript conversion from https://github.com/emn178/js-sha1. - -## Table of contents - -### Constructors - -- [constructor](HmacSha1.md#constructor) - -### Methods - -- [sum](HmacSha1.md#sum) -- [update](HmacSha1.md#update) -- [digest](HmacSha1.md#digest) - -## Constructors - -### constructor - -• **new HmacSha1**(`key`) - -Create a new instance of HmacSha1. - -#### Parameters - -| Name | Type | Description | -| :---- | :----------- | :-------------------- | -| `key` | `Uint8Array` | The key for the hmac. | - -## Methods - -### sum - -▸ `Static` **sum**(`key`, `data`): `Uint8Array` - -Perform Sum on the data. - -#### Parameters - -| Name | Type | Description | -| :----- | :----------- | :---------------------- | -| `key` | `Uint8Array` | The key for the hmac. | -| `data` | `Uint8Array` | The data to operate on. | - -#### Returns - -`Uint8Array` - -The sum of the data. - ---- - -### update - -▸ **update**(`message`): [`HmacSha1`](HmacSha1.md) - -Update the hash with the data. - -#### Parameters - -| Name | Type | Description | -| :-------- | :----------- | :-------------------------------- | -| `message` | `Uint8Array` | The data to update the hash with. | - -#### Returns - -[`HmacSha1`](HmacSha1.md) - -The instance for chaining. - ---- - -### digest - -▸ **digest**(): `Uint8Array` - -Get the digest. - -#### Returns - -`Uint8Array` - -The digest. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/HmacSha256.md b/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/HmacSha256.md deleted file mode 100644 index eb34eef9681..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/HmacSha256.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: HmacSha256 - -Class to help with HmacSha256 scheme. -TypeScript conversion from https://github.com/emn178/js-sha256. - -## Table of contents - -### Constructors - -- [constructor](HmacSha256.md#constructor) - -### Methods - -- [sum256](HmacSha256.md#sum256) -- [update](HmacSha256.md#update) -- [digest](HmacSha256.md#digest) - -## Constructors - -### constructor - -• **new HmacSha256**(`key`, `bits?`) - -Create a new instance of HmacSha256. - -#### Parameters - -| Name | Type | Default value | Description | -| :----- | :----------- | :------------ | :-------------------- | -| `key` | `Uint8Array` | `undefined` | The key for the hmac. | -| `bits` | `number` | `256` | The number of bits. | - -## Methods - -### sum256 - -▸ `Static` **sum256**(`key`, `data`): `Uint8Array` - -Perform Sum 256 on the data. - -#### Parameters - -| Name | Type | Description | -| :----- | :----------- | :---------------------- | -| `key` | `Uint8Array` | The key for the hmac. | -| `data` | `Uint8Array` | The data to operate on. | - -#### Returns - -`Uint8Array` - -The sum 256 of the data. - ---- - -### update - -▸ **update**(`message`): [`HmacSha256`](HmacSha256.md) - -Update the hash with the data. - -#### Parameters - -| Name | Type | Description | -| :-------- | :----------- | :-------------------------------- | -| `message` | `Uint8Array` | The data to update the hash with. | - -#### Returns - -[`HmacSha256`](HmacSha256.md) - -The instance for chaining. - ---- - -### digest - -▸ **digest**(): `Uint8Array` - -Get the digest. - -#### Returns - -`Uint8Array` - -The digest. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/HmacSha512.md b/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/HmacSha512.md deleted file mode 100644 index b0c2bd36761..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/HmacSha512.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: HmacSha512 - -Class to help with HmacSha512 scheme. -TypeScript conversion from https://github.com/emn178/js-sha512. - -## Table of contents - -### Constructors - -- [constructor](HmacSha512.md#constructor) - -### Methods - -- [sum512](HmacSha512.md#sum512) -- [update](HmacSha512.md#update) -- [digest](HmacSha512.md#digest) - -## Constructors - -### constructor - -• **new HmacSha512**(`key`, `bits?`) - -Create a new instance of HmacSha512. - -#### Parameters - -| Name | Type | Default value | Description | -| :----- | :----------- | :------------ | :-------------------- | -| `key` | `Uint8Array` | `undefined` | The key for the hmac. | -| `bits` | `number` | `512` | The number of bits. | - -## Methods - -### sum512 - -▸ `Static` **sum512**(`key`, `data`): `Uint8Array` - -Perform Sum 512 on the data. - -#### Parameters - -| Name | Type | Description | -| :----- | :----------- | :---------------------- | -| `key` | `Uint8Array` | The key for the hmac. | -| `data` | `Uint8Array` | The data to operate on. | - -#### Returns - -`Uint8Array` - -The sum 512 of the data. - ---- - -### update - -▸ **update**(`message`): [`HmacSha512`](HmacSha512.md) - -Update the hash with the data. - -#### Parameters - -| Name | Type | Description | -| :-------- | :----------- | :-------------------------------- | -| `message` | `Uint8Array` | The data to update the hash with. | - -#### Returns - -[`HmacSha512`](HmacSha512.md) - -The instance for chaining. - ---- - -### digest - -▸ **digest**(): `Uint8Array` - -Get the digest. - -#### Returns - -`Uint8Array` - -The digest. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Pbkdf2.md b/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Pbkdf2.md deleted file mode 100644 index 48f8c207a6f..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Pbkdf2.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: Pbkdf2 - -Implementation of the password based key derivation function 2. - -## Table of contents - -### Methods - -- [sha256](Pbkdf2.md#sha256) -- [sha512](Pbkdf2.md#sha512) - -### Constructors - -- [constructor](Pbkdf2.md#constructor) - -## Methods - -### sha256 - -▸ `Static` **sha256**(`password`, `salt`, `iterations`, `keyLength`): `Uint8Array` - -Derive a key from the parameters using Sha256. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :----------------------------------- | -| `password` | `Uint8Array` | The password to derive the key from. | -| `salt` | `Uint8Array` | The _salt_ for the derivation. | -| `iterations` | `number` | Numer of iterations to perform. | -| `keyLength` | `number` | The length of the key to derive. | - -#### Returns - -`Uint8Array` - -The derived key. - ---- - -### sha512 - -▸ `Static` **sha512**(`password`, `salt`, `iterations`, `keyLength`): `Uint8Array` - -Derive a key from the parameters using Sha512. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :----------------------------------- | -| `password` | `Uint8Array` | The password to derive the key from. | -| `salt` | `Uint8Array` | The salt for the derivation. | -| `iterations` | `number` | Numer of iterations to perform. | -| `keyLength` | `number` | The length of the key to derive. | - -#### Returns - -`Uint8Array` - -The derived key. - -## Constructors - -### constructor - -• **new Pbkdf2**() diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Poly1305.md b/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Poly1305.md deleted file mode 100644 index 6e8a1fe18d3..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Poly1305.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: Poly1305 - -Implementation of Poly1305. - -## Table of contents - -### Constructors - -- [constructor](Poly1305.md#constructor) - -### Methods - -- [finish](Poly1305.md#finish) -- [update](Poly1305.md#update) -- [digest](Poly1305.md#digest) - -## Constructors - -### constructor - -• **new Poly1305**(`key`) - -Create a new instance of Poly1305. - -#### Parameters - -| Name | Type | Description | -| :---- | :----------- | :---------- | -| `key` | `Uint8Array` | The key. | - -## Methods - -### finish - -▸ **finish**(): `void` - -Finished the mac. - -#### Returns - -`void` - ---- - -### update - -▸ **update**(`input`): [`Poly1305`](Poly1305.md) - -Update the hash. - -#### Parameters - -| Name | Type | Description | -| :------ | :----------- | :----------------------- | -| `input` | `Uint8Array` | The data to update with. | - -#### Returns - -[`Poly1305`](Poly1305.md) - -Hasher instance. - ---- - -### digest - -▸ **digest**(): `Uint8Array` - -Get the digest for the hash. - -#### Returns - -`Uint8Array` - -The mac. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Sha1.md b/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Sha1.md deleted file mode 100644 index 65418abc400..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Sha1.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: Sha1 - -Class to help with Sha1 scheme. -TypeScript conversion from https://github.com/emn178/js-sha1. -Although this algorithm should not be use in most cases, it is the -default and most widely support for generating TOTP/HOTP codes. - -## Table of contents - -### Constructors - -- [constructor](Sha1.md#constructor) - -### Methods - -- [sum](Sha1.md#sum) -- [update](Sha1.md#update) -- [digest](Sha1.md#digest) - -## Constructors - -### constructor - -• **new Sha1**() - -Create a new instance of Sha1. - -## Methods - -### sum - -▸ `Static` **sum**(`data`): `Uint8Array` - -Perform Sum on the data. - -#### Parameters - -| Name | Type | Description | -| :----- | :----------- | :---------------------- | -| `data` | `Uint8Array` | The data to operate on. | - -#### Returns - -`Uint8Array` - -The sum of the data. - ---- - -### update - -▸ **update**(`message`): [`Sha1`](Sha1.md) - -Update the hash with the data. - -**`throws`** Error if the hash has already been finalized. - -#### Parameters - -| Name | Type | Description | -| :-------- | :----------- | :-------------------------------- | -| `message` | `Uint8Array` | The data to update the hash with. | - -#### Returns - -[`Sha1`](Sha1.md) - -The instance for chaining. - ---- - -### digest - -▸ **digest**(): `Uint8Array` - -Get the digest. - -#### Returns - -`Uint8Array` - -The digest. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Sha256.md b/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Sha256.md deleted file mode 100644 index d148baddc1d..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Sha256.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: Sha256 - -Class to help with Sha256 scheme. -TypeScript conversion from https://github.com/emn178/js-sha256. - -## Table of contents - -### Properties - -- [SIZE_256](Sha256.md#size_256) -- [SIZE_224](Sha256.md#size_224) - -### Constructors - -- [constructor](Sha256.md#constructor) - -### Methods - -- [sum256](Sha256.md#sum256) -- [sum224](Sha256.md#sum224) -- [update](Sha256.md#update) -- [digest](Sha256.md#digest) - -## Properties - -### SIZE_256 - -▪ `Static` `Readonly` **SIZE_256**: `number` = `256` - -Sha256 256. - ---- - -### SIZE_224 - -▪ `Static` `Readonly` **SIZE_224**: `number` = `224` - -Sha256 224. - -## Constructors - -### constructor - -• **new Sha256**(`bits?`) - -Create a new instance of Sha256. - -#### Parameters - -| Name | Type | Default value | Description | -| :----- | :------- | :---------------- | :------------------ | -| `bits` | `number` | `Sha256.SIZE_256` | The number of bits. | - -## Methods - -### sum256 - -▸ `Static` **sum256**(`data`): `Uint8Array` - -Perform Sum 256 on the data. - -#### Parameters - -| Name | Type | Description | -| :----- | :----------- | :---------------------- | -| `data` | `Uint8Array` | The data to operate on. | - -#### Returns - -`Uint8Array` - -The sum 256 of the data. - ---- - -### sum224 - -▸ `Static` **sum224**(`data`): `Uint8Array` - -Perform Sum 224 on the data. - -#### Parameters - -| Name | Type | Description | -| :----- | :----------- | :---------------------- | -| `data` | `Uint8Array` | The data to operate on. | - -#### Returns - -`Uint8Array` - -The sum 224 of the data. - ---- - -### update - -▸ **update**(`message`): [`Sha256`](Sha256.md) - -Update the hash with the data. - -#### Parameters - -| Name | Type | Description | -| :-------- | :----------- | :-------------------------------- | -| `message` | `Uint8Array` | The data to update the hash with. | - -#### Returns - -[`Sha256`](Sha256.md) - -The instance for chaining. - ---- - -### digest - -▸ **digest**(): `Uint8Array` - -Get the digest. - -#### Returns - -`Uint8Array` - -The digest. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Sha512.md b/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Sha512.md deleted file mode 100644 index 3bd5f9ae44f..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Sha512.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: Sha512 - -Class to help with Sha512 scheme -TypeScript conversion from https://github.com/emn178/js-sha512. - -## Table of contents - -### Properties - -- [SIZE_224](Sha512.md#size_224) -- [SIZE_256](Sha512.md#size_256) -- [SIZE_384](Sha512.md#size_384) -- [SIZE_512](Sha512.md#size_512) - -### Constructors - -- [constructor](Sha512.md#constructor) - -### Methods - -- [sum512](Sha512.md#sum512) -- [update](Sha512.md#update) -- [digest](Sha512.md#digest) - -## Properties - -### SIZE_224 - -▪ `Static` **SIZE_224**: `number` = `224` - -Sha512 224. - ---- - -### SIZE_256 - -▪ `Static` **SIZE_256**: `number` = `256` - -Sha512 256. - ---- - -### SIZE_384 - -▪ `Static` **SIZE_384**: `number` = `384` - -Sha512 384. - ---- - -### SIZE_512 - -▪ `Static` **SIZE_512**: `number` = `512` - -Sha512 512. - -## Constructors - -### constructor - -• **new Sha512**(`bits?`) - -Create a new instance of Sha512. - -#### Parameters - -| Name | Type | Default value | Description | -| :----- | :------- | :---------------- | :------------------ | -| `bits` | `number` | `Sha512.SIZE_512` | The number of bits. | - -## Methods - -### sum512 - -▸ `Static` **sum512**(`data`): `Uint8Array` - -Perform Sum 512 on the data. - -#### Parameters - -| Name | Type | Description | -| :----- | :----------- | :---------------------- | -| `data` | `Uint8Array` | The data to operate on. | - -#### Returns - -`Uint8Array` - -The sum 512 of the data. - ---- - -### update - -▸ **update**(`message`): [`Sha512`](Sha512.md) - -Update the hash with the data. - -#### Parameters - -| Name | Type | Description | -| :-------- | :----------- | :-------------------------------- | -| `message` | `Uint8Array` | The data to update the hash with. | - -#### Returns - -[`Sha512`](Sha512.md) - -The instance for chaining. - ---- - -### digest - -▸ **digest**(): `Uint8Array` - -Get the digest. - -#### Returns - -`Uint8Array` - -The digest. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Slip0010.md b/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Slip0010.md deleted file mode 100644 index b1baeb25792..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Slip0010.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: Slip0010 - -Class to help with slip0010 key derivation -https://github.com/satoshilabs/slips/blob/master/slip-0010.md. - -## Table of contents - -### Methods - -- [getMasterKeyFromSeed](Slip0010.md#getmasterkeyfromseed) -- [derivePath](Slip0010.md#derivepath) -- [getPublicKey](Slip0010.md#getpublickey) - -### Constructors - -- [constructor](Slip0010.md#constructor) - -## Methods - -### getMasterKeyFromSeed - -▸ `Static` **getMasterKeyFromSeed**(`seed`): `Object` - -Get the master key from the seed. - -#### Parameters - -| Name | Type | Description | -| :----- | :----------- | :---------------------------------------- | -| `seed` | `Uint8Array` | The seed to generate the master key from. | - -#### Returns - -`Object` - -The key and chain code. - ---- - -### derivePath - -▸ `Static` **derivePath**(`seed`, `path`): `Object` - -Derive a key from the path. - -#### Parameters - -| Name | Type | Description | -| :----- | :-------------------------- | :---------- | -| `seed` | `Uint8Array` | The seed. | -| `path` | [`Bip32Path`](Bip32Path.md) | The path. | - -#### Returns - -`Object` - -The key and chain code. - ---- - -### getPublicKey - -▸ `Static` **getPublicKey**(`privateKey`, `withZeroByte?`): `Uint8Array` - -Get the public key from the private key. - -#### Parameters - -| Name | Type | Default value | Description | -| :------------- | :----------- | :------------ | :-------------------------- | -| `privateKey` | `Uint8Array` | `undefined` | The private key. | -| `withZeroByte` | `boolean` | `true` | Include a zero bute prefix. | - -#### Returns - -`Uint8Array` - -The public key. - -## Constructors - -### constructor - -• **new Slip0010**() diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/X25519.md b/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/X25519.md deleted file mode 100644 index 41c6e08e961..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/X25519.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: X25519 - -Implementation of X25519. - -## Table of contents - -### Methods - -- [convertPrivateKeyToX25519](X25519.md#convertprivatekeytox25519) -- [convertPublicKeyToX25519](X25519.md#convertpublickeytox25519) - -### Constructors - -- [constructor](X25519.md#constructor) - -## Methods - -### convertPrivateKeyToX25519 - -▸ `Static` **convertPrivateKeyToX25519**(`ed25519PrivateKey`): `Uint8Array` - -Convert Ed25519 private key to X25519 private key. - -#### Parameters - -| Name | Type | Description | -| :------------------ | :----------- | :---------------------------------- | -| `ed25519PrivateKey` | `Uint8Array` | The ed25519 private key to convert. | - -#### Returns - -`Uint8Array` - -The x25519 private key. - ---- - -### convertPublicKeyToX25519 - -▸ `Static` **convertPublicKeyToX25519**(`ed25519PublicKey`): `Uint8Array` - -Convert Ed25519 public key to X25519 public key. - -#### Parameters - -| Name | Type | Description | -| :----------------- | :----------- | :--------------------------------- | -| `ed25519PublicKey` | `Uint8Array` | The ed25519 public key to convert. | - -#### Returns - -`Uint8Array` - -The x25519 public key. - -## Constructors - -### constructor - -• **new X25519**() diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Zip215.md b/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Zip215.md deleted file mode 100644 index fd0f2da6ea4..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/crypto/classes/Zip215.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: Zip215 - -Implementation of Zip215. - -## Table of contents - -### Methods - -- [verify](Zip215.md#verify) - -### Constructors - -- [constructor](Zip215.md#constructor) - -## Methods - -### verify - -▸ `Static` **verify**(`publicKey`, `block`, `sig`): `boolean` - -Verify reports whether sig is a valid signature of block by -publicKey, using precisely-specified validation criteria (ZIP 215) suitable -for use in consensus-critical contexts. - -#### Parameters - -| Name | Type | Description | -| :---------- | :----------- | :----------------------------- | -| `publicKey` | `Uint8Array` | The public key for the block. | -| `block` | `Uint8Array` | The block content to validate. | -| `sig` | `Uint8Array` | The signature to verify. | - -#### Returns - -`boolean` - -True if the signature is valid. - -## Constructors - -### constructor - -• **new Zip215**() diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/mqtt/api_ref.md b/docs/build/iota.js/2.0-rc.1/docs/references/mqtt/api_ref.md deleted file mode 100644 index 2f4ca5b1464..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/mqtt/api_ref.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# @iota/mqtt.js - -## Table of contents - -### Classes - -- [MqttClient](classes/MqttClient.md) - -### Interfaces - -- [IMqttClient](interfaces/IMqttClient.md) -- [IMqttStatus](interfaces/IMqttStatus.md) -- [IMqttMilestoneResponse](interfaces/IMqttMilestoneResponse.md) diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/mqtt/classes/MqttClient.md b/docs/build/iota.js/2.0-rc.1/docs/references/mqtt/classes/MqttClient.md deleted file mode 100644 index 2dbab35fc82..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/mqtt/classes/MqttClient.md +++ /dev/null @@ -1,736 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: MqttClient - -MQTT Client implementation for pub/sub communication. - -## Implements - -- [`IMqttClient`](../interfaces/IMqttClient.md) - -## Table of contents - -### Constructors - -- [constructor](MqttClient.md#constructor) - -### Methods - -- [milestonesLatest](MqttClient.md#milestoneslatest) -- [milestonesConfirmed](MqttClient.md#milestonesconfirmed) -- [blocksRaw](MqttClient.md#blocksraw) -- [blocks](MqttClient.md#blocks) -- [blocksReferenced](MqttClient.md#blocksreferenced) -- [blocksTransactionRaw](MqttClient.md#blockstransactionraw) -- [blocksTransaction](MqttClient.md#blockstransaction) -- [blocksTransactionTaggedDataRaw](MqttClient.md#blockstransactiontaggeddataraw) -- [blocksTransactionTaggedData](MqttClient.md#blockstransactiontaggeddata) -- [milestoneRaw](MqttClient.md#milestoneraw) -- [milestone](MqttClient.md#milestone) -- [blocksTaggedRaw](MqttClient.md#blockstaggedraw) -- [blocksTagged](MqttClient.md#blockstagged) -- [blocksMetadata](MqttClient.md#blocksmetadata) -- [transactionIncludedBlockRaw](MqttClient.md#transactionincludedblockraw) -- [transactionIncludedBlock](MqttClient.md#transactionincludedblock) -- [output](MqttClient.md#output) -- [nft](MqttClient.md#nft) -- [alias](MqttClient.md#alias) -- [foundry](MqttClient.md#foundry) -- [outputByConditionAndAddress](MqttClient.md#outputbyconditionandaddress) -- [outputSpentByConditionAndAddress](MqttClient.md#outputspentbyconditionandaddress) -- [receipts](MqttClient.md#receipts) -- [subscribeRaw](MqttClient.md#subscriberaw) -- [subscribeJson](MqttClient.md#subscribejson) -- [unsubscribe](MqttClient.md#unsubscribe) -- [statusChanged](MqttClient.md#statuschanged) - -## Constructors - -### constructor - -• **new MqttClient**(`endpoints`, `keepAliveTimeoutSeconds?`) - -Create a new instace of MqttClient. - -#### Parameters - -| Name | Type | Default value | Description | -| :------------------------ | :--------------------- | :------------ | :-------------------------------------------- | -| `endpoints` | `string` \| `string`[] | `undefined` | The endpoint or endpoints list to connect to. | -| `keepAliveTimeoutSeconds` | `number` | `30` | Timeout to reconnect if no messages received. | - -## Methods - -### milestonesLatest - -▸ **milestonesLatest**(`callback`): `string` - -Subscribe to the latest milestone updates. - -#### Parameters - -| Name | Type | Description | -| :--------- | :--------------------------------------------------------------------------------------------------------- | :-------------------------------------------------- | -| `callback` | (`topic`: `string`, `data`: [`IMqttMilestoneResponse`](../interfaces/IMqttMilestoneResponse.md)) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[milestonesLatest](../interfaces/IMqttClient.md#milestoneslatest) - ---- - -### milestonesConfirmed - -▸ **milestonesConfirmed**(`callback`): `string` - -Subscribe to the latest confirmed milestone updates. - -#### Parameters - -| Name | Type | Description | -| :--------- | :--------------------------------------------------------------------------------------------------------- | :-------------------------------------------------- | -| `callback` | (`topic`: `string`, `data`: [`IMqttMilestoneResponse`](../interfaces/IMqttMilestoneResponse.md)) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[milestonesConfirmed](../interfaces/IMqttClient.md#milestonesconfirmed) - ---- - -### blocksRaw - -▸ **blocksRaw**(`callback`): `string` - -Subscribe to get all blocks in binary form. - -#### Parameters - -| Name | Type | Description | -| :--------- | :-------------------------------------------------- | :-------------------------------------------------- | -| `callback` | (`topic`: `string`, `data`: `Uint8Array`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[blocksRaw](../interfaces/IMqttClient.md#blocksraw) - ---- - -### blocks - -▸ **blocks**(`callback`): `string` - -Subscribe to get all blocks in object form. - -#### Parameters - -| Name | Type | Description | -| :--------- | :---------------------------------------------- | :-------------------------------------------------- | -| `callback` | (`topic`: `string`, `data`: `IBlock`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[blocks](../interfaces/IMqttClient.md#blocks) - ---- - -### blocksReferenced - -▸ **blocksReferenced**(`callback`): `string` - -Subscribe to get the metadata for all the blocks. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------ | :-------------------------------------------------- | -| `callback` | (`topic`: `string`, `data`: `IBlockMetadata`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[blocksReferenced](../interfaces/IMqttClient.md#blocksreferenced) - ---- - -### blocksTransactionRaw - -▸ **blocksTransactionRaw**(`callback`): `string` - -Subscribe to all transaction blocks in their raw form. - -#### Parameters - -| Name | Type | Description | -| :--------- | :-------------------------------------------------- | :-------------------------------------------------- | -| `callback` | (`topic`: `string`, `data`: `Uint8Array`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[blocksTransactionRaw](../interfaces/IMqttClient.md#blockstransactionraw) - ---- - -### blocksTransaction - -▸ **blocksTransaction**(`callback`): `string` - -Subscribe to all transaction blocks. - -#### Parameters - -| Name | Type | Description | -| :--------- | :---------------------------------------------- | :-------------------------------------------------- | -| `callback` | (`topic`: `string`, `data`: `IBlock`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[blocksTransaction](../interfaces/IMqttClient.md#blockstransaction) - ---- - -### blocksTransactionTaggedDataRaw - -▸ **blocksTransactionTaggedDataRaw**(`tag`, `callback`): `string` - -Subscribe to transaction blocks with tagged data in their raw form. - -#### Parameters - -| Name | Type | Description | -| :--------- | :-------------------------------------------------- | :--------------------------------------------------------------- | -| `tag` | `undefined` \| `string` \| `Uint8Array` | The tag to monitor as bytes or in hex, undefined for all blocks. | -| `callback` | (`topic`: `string`, `data`: `Uint8Array`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[blocksTransactionTaggedDataRaw](../interfaces/IMqttClient.md#blockstransactiontaggeddataraw) - ---- - -### blocksTransactionTaggedData - -▸ **blocksTransactionTaggedData**(`tag`, `callback`): `string` - -Subscribe to all transaction blocks with tagged data. - -#### Parameters - -| Name | Type | Description | -| :--------- | :---------------------------------------------- | :--------------------------------------------------------------- | -| `tag` | `undefined` \| `string` \| `Uint8Array` | The tag to monitor as bytes or in hex, undefined for all blocks. | -| `callback` | (`topic`: `string`, `data`: `IBlock`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[blocksTransactionTaggedData](../interfaces/IMqttClient.md#blockstransactiontaggeddata) - ---- - -### milestoneRaw - -▸ **milestoneRaw**(`callback`): `string` - -Subscribe to all milestone payloads in their raw form. - -#### Parameters - -| Name | Type | Description | -| :--------- | :-------------------------------------------------- | :-------------------------------------------------- | -| `callback` | (`topic`: `string`, `data`: `Uint8Array`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[milestoneRaw](../interfaces/IMqttClient.md#milestoneraw) - ---- - -### milestone - -▸ **milestone**(`callback`): `string` - -Subscribe to all milestone payloads. - -#### Parameters - -| Name | Type | Description | -| :--------- | :--------------------------------------------------------- | :-------------------------------------------------- | -| `callback` | (`topic`: `string`, `data`: `IMilestonePayload`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[milestone](../interfaces/IMqttClient.md#milestone) - ---- - -### blocksTaggedRaw - -▸ **blocksTaggedRaw**(`tag`, `callback`): `string` - -Subscribe to get all blocks for the specified tag in binary form. - -#### Parameters - -| Name | Type | Description | -| :--------- | :-------------------------------------------------- | :--------------------------------------------------------------- | -| `tag` | `undefined` \| `string` \| `Uint8Array` | The tag to monitor as bytes or in hex, undefined for all blocks. | -| `callback` | (`topic`: `string`, `data`: `Uint8Array`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[blocksTaggedRaw](../interfaces/IMqttClient.md#blockstaggedraw) - ---- - -### blocksTagged - -▸ **blocksTagged**(`tag`, `callback`): `string` - -Subscribe to get all blocks for the specified tag in object form. - -#### Parameters - -| Name | Type | Description | -| :--------- | :---------------------------------------------- | :--------------------------------------------------------------- | -| `tag` | `undefined` \| `string` \| `Uint8Array` | The tag to monitor as bytes or in hex, undefined for all blocks. | -| `callback` | (`topic`: `string`, `data`: `IBlock`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[blocksTagged](../interfaces/IMqttClient.md#blockstagged) - ---- - -### blocksMetadata - -▸ **blocksMetadata**(`blockId`, `callback`): `string` - -Subscribe to metadata updates for a specific block. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------ | :-------------------------------------------------- | -| `blockId` | `string` | The block to monitor. | -| `callback` | (`topic`: `string`, `data`: `IBlockMetadata`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[blocksMetadata](../interfaces/IMqttClient.md#blocksmetadata) - ---- - -### transactionIncludedBlockRaw - -▸ **transactionIncludedBlockRaw**(`transactionId`, `callback`): `string` - -Subscribe to block updates for a specific transactionId. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :-------------------------------------------------- | :-------------------------------------------------- | -| `transactionId` | `string` | The block to monitor. | -| `callback` | (`topic`: `string`, `data`: `Uint8Array`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[transactionIncludedBlockRaw](../interfaces/IMqttClient.md#transactionincludedblockraw) - ---- - -### transactionIncludedBlock - -▸ **transactionIncludedBlock**(`transactionId`, `callback`): `string` - -Subscribe to block updates for a specific transactionId. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :---------------------------------------------- | :-------------------------------------------------- | -| `transactionId` | `string` | The block to monitor. | -| `callback` | (`topic`: `string`, `data`: `IBlock`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[transactionIncludedBlock](../interfaces/IMqttClient.md#transactionincludedblock) - ---- - -### output - -▸ **output**(`outputId`, `callback`): `string` - -Subscribe to updates for a specific output. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------- | :-------------------------------------------------- | -| `outputId` | `string` | The output to monitor. | -| `callback` | (`topic`: `string`, `data`: `IOutputResponse`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[output](../interfaces/IMqttClient.md#output) - ---- - -### nft - -▸ **nft**(`nftId`, `callback`): `string` - -Subscribe to updates for an nft output. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------- | :-------------------------------------------------- | -| `nftId` | `string` | The Nft output to monitor. | -| `callback` | (`topic`: `string`, `data`: `IOutputResponse`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[nft](../interfaces/IMqttClient.md#nft) - ---- - -### alias - -▸ **alias**(`aliasId`, `callback`): `string` - -Subscribe to updates for an alias output. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------- | :-------------------------------------------------- | -| `aliasId` | `string` | The alias output to monitor. | -| `callback` | (`topic`: `string`, `data`: `IOutputResponse`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[alias](../interfaces/IMqttClient.md#alias) - ---- - -### foundry - -▸ **foundry**(`foundryId`, `callback`): `string` - -Subscribe to updates for a foundry output. - -#### Parameters - -| Name | Type | Description | -| :---------- | :------------------------------------------------------- | :-------------------------------------------------- | -| `foundryId` | `string` | The foundry output to monitor. | -| `callback` | (`topic`: `string`, `data`: `IOutputResponse`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[foundry](../interfaces/IMqttClient.md#foundry) - ---- - -### outputByConditionAndAddress - -▸ **outputByConditionAndAddress**(`condition`, `addressBech32`, `callback`): `string` - -Subscribe to the output with specific unlock condition and address. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :------------------------------------------------------- | :-------------------------------------------------- | -| `condition` | `string` | The condition to monitor. | -| `addressBech32` | `string` | The address to monitor. | -| `callback` | (`topic`: `string`, `data`: `IOutputResponse`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[outputByConditionAndAddress](../interfaces/IMqttClient.md#outputbyconditionandaddress) - ---- - -### outputSpentByConditionAndAddress - -▸ **outputSpentByConditionAndAddress**(`condition`, `addressBech32`, `callback`): `string` - -Subscribe to the spent outputs with specific unlock condition and address. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :------------------------------------------------------- | :-------------------------------------------------- | -| `condition` | `string` | The condition to monitor. | -| `addressBech32` | `string` | The address to monitor. | -| `callback` | (`topic`: `string`, `data`: `IOutputResponse`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[outputSpentByConditionAndAddress](../interfaces/IMqttClient.md#outputspentbyconditionandaddress) - ---- - -### receipts - -▸ **receipts**(`callback`): `string` - -Subscribe to the receive all receipts. - -#### Parameters - -| Name | Type | Description | -| :--------- | :--------------------------------------------------------- | :-------------------------------------------------- | -| `callback` | (`topic`: `string`, `data`: `IReceiptsResponse`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[receipts](../interfaces/IMqttClient.md#receipts) - ---- - -### subscribeRaw - -▸ **subscribeRaw**(`customTopic`, `callback`): `string` - -Subscribe to another type of message as raw data. - -#### Parameters - -| Name | Type | Description | -| :------------ | :-------------------------------------------------- | :-------------------------------------------------- | -| `customTopic` | `string` | The topic to subscribe to. | -| `callback` | (`topic`: `string`, `data`: `Uint8Array`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[subscribeRaw](../interfaces/IMqttClient.md#subscriberaw) - ---- - -### subscribeJson - -▸ **subscribeJson**<`T`\>(`customTopic`, `callback`): `string` - -Subscribe to another type of message as json. - -#### Type parameters - -| Name | -| :--- | -| `T` | - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------------------------------------- | :-------------------------------------------------- | -| `customTopic` | `string` | The topic to subscribe to. | -| `callback` | (`topic`: `string`, `data`: `T`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[subscribeJson](../interfaces/IMqttClient.md#subscribejson) - ---- - -### unsubscribe - -▸ **unsubscribe**(`subscriptionId`): `void` - -Remove a subscription. - -#### Parameters - -| Name | Type | Description | -| :--------------- | :------- | :-------------------------- | -| `subscriptionId` | `string` | The subscription to remove. | - -#### Returns - -`void` - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[unsubscribe](../interfaces/IMqttClient.md#unsubscribe) - ---- - -### statusChanged - -▸ **statusChanged**(`callback`): `string` - -Subscribe to changes in the client state. - -#### Parameters - -| Name | Type | Description | -| :--------- | :---------------------------------------------------------------- | :------------------------------------------ | -| `callback` | (`data`: [`IMqttStatus`](../interfaces/IMqttStatus.md)) => `void` | Callback called when the state has changed. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - -#### Implementation of - -[IMqttClient](../interfaces/IMqttClient.md).[statusChanged](../interfaces/IMqttClient.md#statuschanged) diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/mqtt/interfaces/IMqttClient.md b/docs/build/iota.js/2.0-rc.1/docs/references/mqtt/interfaces/IMqttClient.md deleted file mode 100644 index 52e5fdba5f6..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/mqtt/interfaces/IMqttClient.md +++ /dev/null @@ -1,609 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IMqttClient - -Client interface definition for API communication. - -## Implemented by - -- [`MqttClient`](../classes/MqttClient.md) - -## Table of contents - -### Methods - -- [milestonesLatest](IMqttClient.md#milestoneslatest) -- [milestonesConfirmed](IMqttClient.md#milestonesconfirmed) -- [blocksRaw](IMqttClient.md#blocksraw) -- [blocks](IMqttClient.md#blocks) -- [blocksReferenced](IMqttClient.md#blocksreferenced) -- [blocksTransactionRaw](IMqttClient.md#blockstransactionraw) -- [blocksTransaction](IMqttClient.md#blockstransaction) -- [blocksTransactionTaggedDataRaw](IMqttClient.md#blockstransactiontaggeddataraw) -- [blocksTransactionTaggedData](IMqttClient.md#blockstransactiontaggeddata) -- [milestoneRaw](IMqttClient.md#milestoneraw) -- [milestone](IMqttClient.md#milestone) -- [blocksTaggedRaw](IMqttClient.md#blockstaggedraw) -- [blocksTagged](IMqttClient.md#blockstagged) -- [blocksMetadata](IMqttClient.md#blocksmetadata) -- [transactionIncludedBlockRaw](IMqttClient.md#transactionincludedblockraw) -- [transactionIncludedBlock](IMqttClient.md#transactionincludedblock) -- [output](IMqttClient.md#output) -- [nft](IMqttClient.md#nft) -- [alias](IMqttClient.md#alias) -- [foundry](IMqttClient.md#foundry) -- [outputByConditionAndAddress](IMqttClient.md#outputbyconditionandaddress) -- [outputSpentByConditionAndAddress](IMqttClient.md#outputspentbyconditionandaddress) -- [receipts](IMqttClient.md#receipts) -- [subscribeRaw](IMqttClient.md#subscriberaw) -- [subscribeJson](IMqttClient.md#subscribejson) -- [unsubscribe](IMqttClient.md#unsubscribe) -- [statusChanged](IMqttClient.md#statuschanged) - -## Methods - -### milestonesLatest - -▸ **milestonesLatest**(`callback`): `string` - -Subscribe to the latest milestone updates. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------------------------------------------- | :-------------------------------------------------- | -| `callback` | (`topic`: `string`, `data`: [`IMqttMilestoneResponse`](IMqttMilestoneResponse.md)) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### milestonesConfirmed - -▸ **milestonesConfirmed**(`callback`): `string` - -Subscribe to the latest confirmed milestone updates. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------------------------------------------- | :-------------------------------------------------- | -| `callback` | (`topic`: `string`, `data`: [`IMqttMilestoneResponse`](IMqttMilestoneResponse.md)) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### blocksRaw - -▸ **blocksRaw**(`callback`): `string` - -Subscribe to get all blocks in binary form. - -#### Parameters - -| Name | Type | Description | -| :--------- | :-------------------------------------------------- | :-------------------------------------------------- | -| `callback` | (`topic`: `string`, `data`: `Uint8Array`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### blocks - -▸ **blocks**(`callback`): `string` - -Subscribe to get all blocks in object form. - -#### Parameters - -| Name | Type | Description | -| :--------- | :---------------------------------------------- | :-------------------------------------------------- | -| `callback` | (`topic`: `string`, `data`: `IBlock`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### blocksReferenced - -▸ **blocksReferenced**(`callback`): `string` - -Subscribe to get the metadata for all the blocks. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------ | :-------------------------------------------------- | -| `callback` | (`topic`: `string`, `data`: `IBlockMetadata`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### blocksTransactionRaw - -▸ **blocksTransactionRaw**(`callback`): `string` - -Subscribe to all transaction blocks in their raw form. - -#### Parameters - -| Name | Type | Description | -| :--------- | :-------------------------------------------------- | :-------------------------------------------------- | -| `callback` | (`topic`: `string`, `data`: `Uint8Array`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### blocksTransaction - -▸ **blocksTransaction**(`callback`): `string` - -Subscribe to all transaction blocks. - -#### Parameters - -| Name | Type | Description | -| :--------- | :---------------------------------------------- | :-------------------------------------------------- | -| `callback` | (`topic`: `string`, `data`: `IBlock`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### blocksTransactionTaggedDataRaw - -▸ **blocksTransactionTaggedDataRaw**(`tag`, `callback`): `string` - -Subscribe to transaction blocks with tagged data in their raw form. - -#### Parameters - -| Name | Type | Description | -| :--------- | :-------------------------------------------------- | :------------------------------------------------------------ | -| `tag` | `undefined` \| `string` \| `Uint8Array` | The tag to look for, or all tagged transactions if undefined. | -| `callback` | (`topic`: `string`, `data`: `Uint8Array`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### blocksTransactionTaggedData - -▸ **blocksTransactionTaggedData**(`tag`, `callback`): `string` - -Subscribe to all transaction blocks with tagged data. - -#### Parameters - -| Name | Type | Description | -| :--------- | :---------------------------------------------- | :------------------------------------------------------------ | -| `tag` | `undefined` \| `string` \| `Uint8Array` | The tag to look for, or all tagged transactions if undefined. | -| `callback` | (`topic`: `string`, `data`: `IBlock`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### milestoneRaw - -▸ **milestoneRaw**(`callback`): `string` - -Subscribe to all milestone payloads in their raw form. - -#### Parameters - -| Name | Type | Description | -| :--------- | :-------------------------------------------------- | :-------------------------------------------------- | -| `callback` | (`topic`: `string`, `data`: `Uint8Array`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### milestone - -▸ **milestone**(`callback`): `string` - -Subscribe to all milestone payloads. - -#### Parameters - -| Name | Type | Description | -| :--------- | :--------------------------------------------------------- | :-------------------------------------------------- | -| `callback` | (`topic`: `string`, `data`: `IMilestonePayload`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### blocksTaggedRaw - -▸ **blocksTaggedRaw**(`tag`, `callback`): `string` - -Subscribe to get all blocks for the specified tag in binary form. - -#### Parameters - -| Name | Type | Description | -| :--------- | :-------------------------------------------------- | :--------------------------------------------------------------- | -| `tag` | `undefined` \| `string` \| `Uint8Array` | The tag to monitor as bytes or in hex, undefined for all blocks. | -| `callback` | (`topic`: `string`, `data`: `Uint8Array`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### blocksTagged - -▸ **blocksTagged**(`tag`, `callback`): `string` - -Subscribe to get all blocks for the specified tag in object form. - -#### Parameters - -| Name | Type | Description | -| :--------- | :---------------------------------------------- | :--------------------------------------------------------------- | -| `tag` | `undefined` \| `string` \| `Uint8Array` | The tag to monitor as bytes or in hex, undefined for all blocks. | -| `callback` | (`topic`: `string`, `data`: `IBlock`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### blocksMetadata - -▸ **blocksMetadata**(`blockId`, `callback`): `string` - -Subscribe to metadata updates for a specific block. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------ | :-------------------------------------------------- | -| `blockId` | `string` | The block to monitor. | -| `callback` | (`topic`: `string`, `data`: `IBlockMetadata`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### transactionIncludedBlockRaw - -▸ **transactionIncludedBlockRaw**(`transactionId`, `callback`): `string` - -Subscribe to block updates for a specific transactionId. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :-------------------------------------------------- | :-------------------------------------------------- | -| `transactionId` | `string` | The block to monitor. | -| `callback` | (`topic`: `string`, `data`: `Uint8Array`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### transactionIncludedBlock - -▸ **transactionIncludedBlock**(`transactionId`, `callback`): `string` - -Subscribe to block updates for a specific transactionId. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :---------------------------------------------- | :-------------------------------------------------- | -| `transactionId` | `string` | The block to monitor. | -| `callback` | (`topic`: `string`, `data`: `IBlock`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### output - -▸ **output**(`outputId`, `callback`): `string` - -Subscribe to updates for a specific output. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------- | :-------------------------------------------------- | -| `outputId` | `string` | The output to monitor. | -| `callback` | (`topic`: `string`, `data`: `IOutputResponse`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### nft - -▸ **nft**(`nftId`, `callback`): `string` - -Subscribe to updates for an nft output. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------- | :-------------------------------------------------- | -| `nftId` | `string` | The Nft output to monitor. | -| `callback` | (`topic`: `string`, `data`: `IOutputResponse`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### alias - -▸ **alias**(`aliasId`, `callback`): `string` - -Subscribe to updates for an alias output. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------- | :-------------------------------------------------- | -| `aliasId` | `string` | The alias output to monitor. | -| `callback` | (`topic`: `string`, `data`: `IOutputResponse`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### foundry - -▸ **foundry**(`foundryId`, `callback`): `string` - -Subscribe to updates for a foundry output. - -#### Parameters - -| Name | Type | Description | -| :---------- | :------------------------------------------------------- | :-------------------------------------------------- | -| `foundryId` | `string` | The foundry output to monitor. | -| `callback` | (`topic`: `string`, `data`: `IOutputResponse`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### outputByConditionAndAddress - -▸ **outputByConditionAndAddress**(`condition`, `addressBech32`, `callback`): `string` - -Subscribe to the output with specific unlock condition and address. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :------------------------------------------------------- | :-------------------------------------------------- | -| `condition` | `string` | The condition to monitor. | -| `addressBech32` | `string` | The address to monitor. | -| `callback` | (`topic`: `string`, `data`: `IOutputResponse`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### outputSpentByConditionAndAddress - -▸ **outputSpentByConditionAndAddress**(`condition`, `addressBech32`, `callback`): `string` - -Subscribe to the spent outputs with specific unlock condition and address. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :------------------------------------------------------- | :-------------------------------------------------- | -| `condition` | `string` | The condition to monitor. | -| `addressBech32` | `string` | The address to monitor. | -| `callback` | (`topic`: `string`, `data`: `IOutputResponse`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### receipts - -▸ **receipts**(`callback`): `string` - -Subscribe to the receive all receipts. - -#### Parameters - -| Name | Type | Description | -| :--------- | :--------------------------------------------------------- | :-------------------------------------------------- | -| `callback` | (`topic`: `string`, `data`: `IReceiptsResponse`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### subscribeRaw - -▸ **subscribeRaw**(`customTopic`, `callback`): `string` - -Subscribe to another type of block as raw data. - -#### Parameters - -| Name | Type | Description | -| :------------ | :-------------------------------------------------- | :-------------------------------------------------- | -| `customTopic` | `string` | The topic to subscribe to. | -| `callback` | (`topic`: `string`, `data`: `Uint8Array`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### subscribeJson - -▸ **subscribeJson**<`T`\>(`customTopic`, `callback`): `string` - -Subscribe to another type of block as json. - -#### Type parameters - -| Name | -| :--- | -| `T` | - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------------------------------------- | :-------------------------------------------------- | -| `customTopic` | `string` | The topic to subscribe to. | -| `callback` | (`topic`: `string`, `data`: `T`) => `void` | The callback which is called when new data arrives. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. - ---- - -### unsubscribe - -▸ **unsubscribe**(`subscriptionId`): `void` - -Remove a subscription. - -#### Parameters - -| Name | Type | Description | -| :--------------- | :------- | :-------------------------- | -| `subscriptionId` | `string` | The subscription to remove. | - -#### Returns - -`void` - ---- - -### statusChanged - -▸ **statusChanged**(`callback`): `string` - -Subscribe to changes in the client state. - -#### Parameters - -| Name | Type | Description | -| :--------- | :---------------------------------------------------- | :------------------------------------------ | -| `callback` | (`status`: [`IMqttStatus`](IMqttStatus.md)) => `void` | Callback called when the state has changed. | - -#### Returns - -`string` - -A subscription Id which can be used to unsubscribe. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/mqtt/interfaces/IMqttMilestoneResponse.md b/docs/build/iota.js/2.0-rc.1/docs/references/mqtt/interfaces/IMqttMilestoneResponse.md deleted file mode 100644 index c0f8bb9d9b1..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/mqtt/interfaces/IMqttMilestoneResponse.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IMqttMilestoneResponse - -Milestone. - -## Table of contents - -### Properties - -- [milestoneId](IMqttMilestoneResponse.md#milestoneid) -- [index](IMqttMilestoneResponse.md#index) -- [timestamp](IMqttMilestoneResponse.md#timestamp) - -## Properties - -### milestoneId - -• **milestoneId**: `string` - -The milestone id. - ---- - -### index - -• **index**: `number` - -The milestone index. - ---- - -### timestamp - -• **timestamp**: `number` - -The timestamp of the milestone. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/mqtt/interfaces/IMqttStatus.md b/docs/build/iota.js/2.0-rc.1/docs/references/mqtt/interfaces/IMqttStatus.md deleted file mode 100644 index 22c66b05e43..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/mqtt/interfaces/IMqttStatus.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Interface: IMqttStatus - -Status message for MQTT Clients. - -## Table of contents - -### Properties - -- [type](IMqttStatus.md#type) -- [message](IMqttStatus.md#message) -- [state](IMqttStatus.md#state) -- [error](IMqttStatus.md#error) - -## Properties - -### type - -• **type**: `"connect"` \| `"disconnect"` \| `"error"` \| `"subscription-add"` \| `"subscription-remove"` - -The type of message. - ---- - -### message - -• **message**: `string` - -Additional information about the status. - ---- - -### state - -• **state**: `"disconnected"` \| `"connected"` \| `"disconnecting"` \| `"connecting"` - -The connection status. - ---- - -### error - -• `Optional` **error**: `unknown` - -Any errors. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/pow-browser/api_ref.md b/docs/build/iota.js/2.0-rc.1/docs/references/pow-browser/api_ref.md deleted file mode 100644 index fc6566122ca..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/pow-browser/api_ref.md +++ /dev/null @@ -1,7 +0,0 @@ -# @iota/pow-browser.js - -## Table of contents - -### Classes - -- [BrowserPowProvider](classes/BrowserPowProvider.md) diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/pow-browser/classes/BrowserPowProvider.md b/docs/build/iota.js/2.0-rc.1/docs/references/pow-browser/classes/BrowserPowProvider.md deleted file mode 100644 index fa0dd3c3ef4..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/pow-browser/classes/BrowserPowProvider.md +++ /dev/null @@ -1,72 +0,0 @@ -# Class: BrowserPowProvider - -Browser POW Provider. - -## Implements - -- `IPowProvider` - -## Table of contents - -### Constructors - -- [constructor](BrowserPowProvider.md#constructor) - -### Methods - -- [pow](BrowserPowProvider.md#pow) -- [createWorker](BrowserPowProvider.md#createworker) - -## Constructors - -### constructor - -• **new BrowserPowProvider**(`numCpus?`) - -Create a new instance of BrowserPowProvider. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :---------------------------------------- | -| `numCpus?` | `number` | The number of cpus, defaults to max CPUs. | - -## Methods - -### pow - -▸ **pow**(`block`, `targetScore`, `powInterval?`): `Promise`<`string`\> - -Perform pow on the block and return the nonce of at least targetScore. - -#### Parameters - -| Name | Type | Description | -| :------------- | :----------- | :-------------------------------------------------------- | -| `block` | `Uint8Array` | The block to process. | -| `targetScore` | `number` | The target score. | -| `powInterval?` | `number` | The time in seconds that pow should work before aborting. | - -#### Returns - -`Promise`<`string`\> - -The nonce. - -#### Implementation of - -IPowProvider.pow - ---- - -### createWorker - -▸ **createWorker**(): `Worker` - -Create new instance of the Worker. - -#### Returns - -`Worker` - -The Worker. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/pow-neon/api_ref.md b/docs/build/iota.js/2.0-rc.1/docs/references/pow-neon/api_ref.md deleted file mode 100644 index 0e267613434..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/pow-neon/api_ref.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# @iota/pow-neon.js - -## Table of contents - -### Classes - -- [NeonPowProvider](classes/NeonPowProvider.md) diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/pow-neon/classes/NeonPowProvider.md b/docs/build/iota.js/2.0-rc.1/docs/references/pow-neon/classes/NeonPowProvider.md deleted file mode 100644 index a8e92492058..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/pow-neon/classes/NeonPowProvider.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: NeonPowProvider - -Neon POW Provider. - -## Implements - -- `IPowProvider` - -## Table of contents - -### Constructors - -- [constructor](NeonPowProvider.md#constructor) - -### Methods - -- [pow](NeonPowProvider.md#pow) - -## Constructors - -### constructor - -• **new NeonPowProvider**(`numCpus?`) - -Create a new instance of NeonPowProvider. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :---------------------------------------- | -| `numCpus?` | `number` | The number of cpus, defaults to max CPUs. | - -## Methods - -### pow - -▸ **pow**(`message`, `targetScore`): `Promise`<`string`\> - -Perform pow on the message and return the nonce of at least targetScore. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------- | :---------------------- | -| `message` | `Uint8Array` | The message to process. | -| `targetScore` | `number` | The target score. | - -#### Returns - -`Promise`<`string`\> - -The nonce. - -#### Implementation of - -IPowProvider.pow diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/pow-node/api_ref.md b/docs/build/iota.js/2.0-rc.1/docs/references/pow-node/api_ref.md deleted file mode 100644 index de26ab7db54..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/pow-node/api_ref.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# @iota/pow-node.js - -## Table of contents - -### Classes - -- [NodePowProvider](classes/NodePowProvider.md) - -### Functions - -- [doPow](api_ref.md#dopow) - -## Functions - -### doPow - -▸ **doPow**(`powDigest`, `targetZeros`, `startIndex`): `string` - -Perform the hash on the data until we reach target number of zeros. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------- | :------------------------------- | -| `powDigest` | `Uint8Array` | The pow digest. | -| `targetZeros` | `number` | The target number of zeros. | -| `startIndex` | `string` | The index to start looking from. | - -#### Returns - -`string` - -The nonce. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/pow-node/classes/NodePowProvider.md b/docs/build/iota.js/2.0-rc.1/docs/references/pow-node/classes/NodePowProvider.md deleted file mode 100644 index 4c4d52ae27d..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/pow-node/classes/NodePowProvider.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: NodePowProvider - -Node POW Provider. - -## Implements - -- `IPowProvider` - -## Table of contents - -### Constructors - -- [constructor](NodePowProvider.md#constructor) - -### Methods - -- [pow](NodePowProvider.md#pow) - -## Constructors - -### constructor - -• **new NodePowProvider**(`numCpus?`) - -Create a new instance of NodePowProvider. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :---------------------------------------- | -| `numCpus?` | `number` | The number of cpus, defaults to max CPUs. | - -## Methods - -### pow - -▸ **pow**(`message`, `targetScore`): `Promise`<`string`\> - -Perform pow on the message and return the nonce of at least targetScore. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------- | :---------------------- | -| `message` | `Uint8Array` | The message to process. | -| `targetScore` | `number` | The target score. | - -#### Returns - -`Promise`<`string`\> - -The nonce. - -#### Implementation of - -IPowProvider.pow diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/pow-wasm/api_ref.md b/docs/build/iota.js/2.0-rc.1/docs/references/pow-wasm/api_ref.md deleted file mode 100644 index 40f19f78f47..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/pow-wasm/api_ref.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# @iota/pow-wasm.js - -## Table of contents - -### Classes - -- [WasmPowProvider](classes/WasmPowProvider.md) - -### Functions - -- [doPow](api_ref.md#dopow) - -## Functions - -### doPow - -▸ **doPow**(`powDigest`, `targetZeros`, `startIndex`): `Promise`<`string`\> - -Perform the hash on the data until we reach target number of zeros. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------- | :------------------------------- | -| `powDigest` | `Uint8Array` | The pow digest. | -| `targetZeros` | `number` | The target number of zeros. | -| `startIndex` | `string` | The index to start looking from. | - -#### Returns - -`Promise`<`string`\> - -The nonce. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/pow-wasm/classes/WasmPowProvider.md b/docs/build/iota.js/2.0-rc.1/docs/references/pow-wasm/classes/WasmPowProvider.md deleted file mode 100644 index 3b489837853..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/pow-wasm/classes/WasmPowProvider.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: WasmPowProvider - -Wasm POW Provider. - -## Implements - -- `IPowProvider` - -## Table of contents - -### Constructors - -- [constructor](WasmPowProvider.md#constructor) - -### Methods - -- [pow](WasmPowProvider.md#pow) - -## Constructors - -### constructor - -• **new WasmPowProvider**(`numCpus?`) - -Create a new instance of NodePowProvider. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :---------------------------------------- | -| `numCpus?` | `number` | The number of cpus, defaults to max CPUs. | - -## Methods - -### pow - -▸ **pow**(`message`, `targetScore`): `Promise`<`string`\> - -Perform pow on the message and return the nonce of at least targetScore. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------- | :---------------------- | -| `message` | `Uint8Array` | The message to process. | -| `targetScore` | `number` | The target score. | - -#### Returns - -`Promise`<`string`\> - -The nonce. - -#### Implementation of - -IPowProvider.pow diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/util/api_ref.md b/docs/build/iota.js/2.0-rc.1/docs/references/util/api_ref.md deleted file mode 100644 index 928946cd714..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/util/api_ref.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# @iota/util.js - -## Table of contents - -### Classes - -- [Base32](classes/Base32.md) -- [Base58](classes/Base58.md) -- [Base64](classes/Base64.md) -- [BigIntHelper](classes/BigIntHelper.md) -- [Converter](classes/Converter.md) -- [HexHelper](classes/HexHelper.md) -- [RandomHelper](classes/RandomHelper.md) -- [ReadStream](classes/ReadStream.md) -- [WriteStream](classes/WriteStream.md) diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/Base32.md b/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/Base32.md deleted file mode 100644 index 5b32b4f3826..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/Base32.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: Base32 - -Class to help with base32 Encoding/Decoding using RFC4648. - -## Table of contents - -### Methods - -- [decode](Base32.md#decode) -- [encode](Base32.md#encode) - -### Constructors - -- [constructor](Base32.md#constructor) - -## Methods - -### decode - -▸ `Static` **decode**(`base32`): `Uint8Array` - -Convert the base 32 string to a byte array. - -**`throws`** If the input string contains a character not in the Base32 alphabet. - -#### Parameters - -| Name | Type | Description | -| :------- | :------- | :---------------------------- | -| `base32` | `string` | The base32 string to convert. | - -#### Returns - -`Uint8Array` - -The byte array. - ---- - -### encode - -▸ `Static` **encode**(`bytes`): `string` - -Convert a byte array to base 32. - -#### Parameters - -| Name | Type | Description | -| :------ | :----------- | :------------------------- | -| `bytes` | `Uint8Array` | The byte array to convert. | - -#### Returns - -`string` - -The data as base32 string. - -## Constructors - -### constructor - -• **new Base32**() diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/Base58.md b/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/Base58.md deleted file mode 100644 index b9833528e29..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/Base58.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: Base58 - -Class to help with base58 Encoding/Decoding. - -## Table of contents - -### Methods - -- [decode](Base58.md#decode) -- [encode](Base58.md#encode) - -### Constructors - -- [constructor](Base58.md#constructor) - -## Methods - -### decode - -▸ `Static` **decode**(`base58`): `Uint8Array` - -Convert the base 58 string to a byte array. - -**`throws`** If the input string contains a character not in the Base58 alphabet. - -#### Parameters - -| Name | Type | Description | -| :------- | :------- | :---------------------------- | -| `base58` | `string` | The base58 string to convert. | - -#### Returns - -`Uint8Array` - -The byte array. - ---- - -### encode - -▸ `Static` **encode**(`bytes`): `string` - -Convert a byte array to base 58. - -#### Parameters - -| Name | Type | Description | -| :------ | :----------- | :------------------------ | -| `bytes` | `Uint8Array` | The byte array to encode. | - -#### Returns - -`string` - -The data as base58 string. - -## Constructors - -### constructor - -• **new Base58**() diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/Base64.md b/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/Base64.md deleted file mode 100644 index f2c268e00cf..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/Base64.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: Base64 - -Class to help with base64 Encoding/Decoding. -Sourced from https://github.com/beatgammit/base64-js. - -## Table of contents - -### Methods - -- [byteLength](Base64.md#bytelength) -- [decode](Base64.md#decode) -- [encode](Base64.md#encode) - -### Constructors - -- [constructor](Base64.md#constructor) - -## Methods - -### byteLength - -▸ `Static` **byteLength**(`base64`): `number` - -Get the byte length of the data. - -#### Parameters - -| Name | Type | Description | -| :------- | :------- | :----------------- | -| `base64` | `string` | The base64 string. | - -#### Returns - -`number` - -The byte length of the data. - ---- - -### decode - -▸ `Static` **decode**(`base64`): `Uint8Array` - -Convert the base 64 string to a byte array. - -#### Parameters - -| Name | Type | Description | -| :------- | :------- | :---------------------------- | -| `base64` | `string` | The base64 string to convert. | - -#### Returns - -`Uint8Array` - -The byte array. - ---- - -### encode - -▸ `Static` **encode**(`bytes`): `string` - -Convert a byte array to base 64. - -#### Parameters - -| Name | Type | Description | -| :------ | :----------- | :------------------------- | -| `bytes` | `Uint8Array` | The byte array to convert. | - -#### Returns - -`string` - -The data as bas64 string. - -## Constructors - -### constructor - -• **new Base64**() diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/BigIntHelper.md b/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/BigIntHelper.md deleted file mode 100644 index 6c2b5ee8033..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/BigIntHelper.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: BigIntHelper - -Helper methods for bigints. - -## Table of contents - -### Methods - -- [read3](BigIntHelper.md#read3) -- [read4](BigIntHelper.md#read4) -- [read8](BigIntHelper.md#read8) -- [read32](BigIntHelper.md#read32) -- [write8](BigIntHelper.md#write8) -- [write32](BigIntHelper.md#write32) -- [random](BigIntHelper.md#random) - -### Constructors - -- [constructor](BigIntHelper.md#constructor) - -## Methods - -### read3 - -▸ `Static` **read3**(`data`, `byteOffset`): `BigInteger` - -Load 3 bytes from array as bigint. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :---------------------------- | -| `data` | `Uint8Array` | The input array. | -| `byteOffset` | `number` | The start index to read from. | - -#### Returns - -`BigInteger` - -The bigint. - ---- - -### read4 - -▸ `Static` **read4**(`data`, `byteOffset`): `BigInteger` - -Load 4 bytes from array as bigint. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :---------------------------- | -| `data` | `Uint8Array` | The input array. | -| `byteOffset` | `number` | The start index to read from. | - -#### Returns - -`BigInteger` - -The bigint. - ---- - -### read8 - -▸ `Static` **read8**(`data`, `byteOffset`): `BigInteger` - -Load 8 bytes from array as bigint. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :---------------------------- | -| `data` | `Uint8Array` | The data to read from. | -| `byteOffset` | `number` | The start index to read from. | - -#### Returns - -`BigInteger` - -The bigint. - ---- - -### read32 - -▸ `Static` **read32**(`data`, `byteOffset`): `BigInteger` - -Load 32 bytes (256 bits) from array as bigint. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :---------------------------- | -| `data` | `Uint8Array` | The data to read from. | -| `byteOffset` | `number` | The start index to read from. | - -#### Returns - -`BigInteger` - -The bigint. - ---- - -### write8 - -▸ `Static` **write8**(`value`, `data`, `byteOffset`): `void` - -Convert a big int to bytes. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :----------------------------- | -| `value` | `BigInteger` | The bigint. | -| `data` | `Uint8Array` | The buffer to write into. | -| `byteOffset` | `number` | The start index to write from. | - -#### Returns - -`void` - ---- - -### write32 - -▸ `Static` **write32**(`value`, `data`, `byteOffset`): `void` - -Convert a big int 32 bytes (256 bits) to bytes. - -#### Parameters - -| Name | Type | Description | -| :----------- | :----------- | :----------------------------- | -| `value` | `BigInteger` | The bigint. | -| `data` | `Uint8Array` | The buffer to write into. | -| `byteOffset` | `number` | The start index to write from. | - -#### Returns - -`void` - ---- - -### random - -▸ `Static` **random**(`length?`): `BigInteger` - -Generate a random bigint. - -#### Parameters - -| Name | Type | Default value | Description | -| :------- | :------- | :------------ | :------------------------------------ | -| `length` | `number` | `8` | The length of the bigint to generate. | - -#### Returns - -`BigInteger` - -The bigint. - -## Constructors - -### constructor - -• **new BigIntHelper**() diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/Converter.md b/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/Converter.md deleted file mode 100644 index c36c8abf8c2..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/Converter.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: Converter - -Convert arrays to and from different formats. - -## Table of contents - -### Methods - -- [bytesToUtf8](Converter.md#bytestoutf8) -- [utf8ToBytes](Converter.md#utf8tobytes) -- [bytesToHex](Converter.md#bytestohex) -- [hexToBytes](Converter.md#hextobytes) -- [utf8ToHex](Converter.md#utf8tohex) -- [hexToUtf8](Converter.md#hextoutf8) -- [isHex](Converter.md#ishex) -- [bytesToBinary](Converter.md#bytestobinary) -- [binaryToBytes](Converter.md#binarytobytes) -- [bytesToBase64](Converter.md#bytestobase64) -- [base64ToBytes](Converter.md#base64tobytes) - -### Constructors - -- [constructor](Converter.md#constructor) - -## Methods - -### bytesToUtf8 - -▸ `Static` **bytesToUtf8**(`array`, `startIndex?`, `length?`): `string` - -Encode a raw array to UTF8 string. - -#### Parameters - -| Name | Type | Description | -| :------------ | :--------------------- | :------------------------------- | -| `array` | `ArrayLike`<`number`\> | The bytes to encode. | -| `startIndex?` | `number` | The index to start in the bytes. | -| `length?` | `number` | The length of bytes to read. | - -#### Returns - -`string` - -The array formated as UTF8. - ---- - -### utf8ToBytes - -▸ `Static` **utf8ToBytes**(`utf8`): `Uint8Array` - -Convert a UTF8 string to raw array. - -#### Parameters - -| Name | Type | Description | -| :----- | :------- | :------------------ | -| `utf8` | `string` | The text to decode. | - -#### Returns - -`Uint8Array` - -The array. - ---- - -### bytesToHex - -▸ `Static` **bytesToHex**(`array`, `includePrefix?`, `startIndex?`, `length?`, `reverse?`): `string` - -Encode a raw array to hex string. - -#### Parameters - -| Name | Type | Default value | Description | -| :-------------- | :--------------------- | :------------ | :----------------------------------------- | -| `array` | `ArrayLike`<`number`\> | `undefined` | The bytes to encode. | -| `includePrefix` | `boolean` | `false` | Include the 0x prefix on the returned hex. | -| `startIndex?` | `number` | `undefined` | The index to start in the bytes. | -| `length?` | `number` | `undefined` | The length of bytes to read. | -| `reverse?` | `boolean` | `undefined` | Reverse the combine direction. | - -#### Returns - -`string` - -The array formated as hex. - ---- - -### hexToBytes - -▸ `Static` **hexToBytes**(`hex`, `reverse?`): `Uint8Array` - -Decode a hex string to raw array. - -#### Parameters - -| Name | Type | Description | -| :--------- | :-------- | :------------------------------- | -| `hex` | `string` | The hex to decode. | -| `reverse?` | `boolean` | Store the characters in reverse. | - -#### Returns - -`Uint8Array` - -The array. - ---- - -### utf8ToHex - -▸ `Static` **utf8ToHex**(`utf8`, `includePrefix?`): `string` - -Convert the UTF8 to hex. - -#### Parameters - -| Name | Type | Default value | Description | -| :-------------- | :-------- | :------------ | :----------------------------------------- | -| `utf8` | `string` | `undefined` | The text to convert. | -| `includePrefix` | `boolean` | `false` | Include the 0x prefix on the returned hex. | - -#### Returns - -`string` - -The hex version of the bytes. - ---- - -### hexToUtf8 - -▸ `Static` **hexToUtf8**(`hex`): `string` - -Convert the hex text to text. - -#### Parameters - -| Name | Type | Description | -| :---- | :------- | :------------------ | -| `hex` | `string` | The hex to convert. | - -#### Returns - -`string` - -The UTF8 version of the bytes. - ---- - -### isHex - -▸ `Static` **isHex**(`value`, `allowPrefix?`): `boolean` - -Is the data hex format. - -#### Parameters - -| Name | Type | Default value | Description | -| :------------ | :-------- | :------------ | :----------------------------------- | -| `value` | `string` | `undefined` | The value to test. | -| `allowPrefix` | `boolean` | `false` | Allow the hex to have the 0x prefix. | - -#### Returns - -`boolean` - -True if the string is hex. - ---- - -### bytesToBinary - -▸ `Static` **bytesToBinary**(`bytes`): `string` - -Convert bytes to binary string. - -#### Parameters - -| Name | Type | Description | -| :------ | :----------- | :-------------------- | -| `bytes` | `Uint8Array` | The bytes to convert. | - -#### Returns - -`string` - -A binary string of the bytes. - ---- - -### binaryToBytes - -▸ `Static` **binaryToBytes**(`binary`): `Uint8Array` - -Convert a binary string to bytes. - -#### Parameters - -| Name | Type | Description | -| :------- | :------- | :----------------- | -| `binary` | `string` | The binary string. | - -#### Returns - -`Uint8Array` - -The bytes. - ---- - -### bytesToBase64 - -▸ `Static` **bytesToBase64**(`bytes`): `string` - -Convert bytes to base64 string. - -#### Parameters - -| Name | Type | Description | -| :------ | :----------- | :-------------------- | -| `bytes` | `Uint8Array` | The bytes to convert. | - -#### Returns - -`string` - -A base64 string of the bytes. - ---- - -### base64ToBytes - -▸ `Static` **base64ToBytes**(`base64`): `Uint8Array` - -Convert a base64 string to bytes. - -#### Parameters - -| Name | Type | Description | -| :------- | :------- | :----------------- | -| `base64` | `string` | The base64 string. | - -#### Returns - -`Uint8Array` - -The bytes. - -## Constructors - -### constructor - -• **new Converter**() diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/HexHelper.md b/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/HexHelper.md deleted file mode 100644 index 6ff614acb8f..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/HexHelper.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: HexHelper - -Helper methods for hex conversions. - -## Table of contents - -### Properties - -- [BIG_INT_MAX_256_BIT](HexHelper.md#big_int_max_256_bit) - -### Methods - -- [fromBigInt256](HexHelper.md#frombigint256) -- [toBigInt256](HexHelper.md#tobigint256) -- [stripPrefix](HexHelper.md#stripprefix) -- [addPrefix](HexHelper.md#addprefix) -- [hasPrefix](HexHelper.md#hasprefix) - -### Constructors - -- [constructor](HexHelper.md#constructor) - -## Properties - -### BIG_INT_MAX_256_BIT - -▪ `Static` `Readonly` **BIG_INT_MAX_256_BIT**: `BigInteger` - -Const defining the maximum value for a 256 bit int. - -## Methods - -### fromBigInt256 - -▸ `Static` **fromBigInt256**(`value`): `string` - -Convert the big int 256 bit to hex string. - -#### Parameters - -| Name | Type | Description | -| :------ | :----------- | :---------------------------- | -| `value` | `BigInteger` | The big int value to convert. | - -#### Returns - -`string` - -The hex encoded big int. - ---- - -### toBigInt256 - -▸ `Static` **toBigInt256**(`hex`): `BigInteger` - -Convert the hex string to a big int. - -#### Parameters - -| Name | Type | Description | -| :---- | :------- | :------------------------ | -| `hex` | `string` | The hex value to convert. | - -#### Returns - -`BigInteger` - -The big int. - ---- - -### stripPrefix - -▸ `Static` **stripPrefix**(`hex`): `string` - -Strip the 0x prefix if it exists. - -#### Parameters - -| Name | Type | Description | -| :---- | :------- | :---------------------- | -| `hex` | `string` | The hex value to strip. | - -#### Returns - -`string` - -The stripped hex without the prefix. - ---- - -### addPrefix - -▸ `Static` **addPrefix**(`hex`): `string` - -Add the 0x prefix if it does not exist. - -#### Parameters - -| Name | Type | Description | -| :---- | :------- | :---------------------------------- | -| `hex` | `string` | The hex value to add the prefix to. | - -#### Returns - -`string` - -The hex with the prefix. - ---- - -### hasPrefix - -▸ `Static` **hasPrefix**(`hex`): `boolean` - -Does the hex string have the prefix. - -#### Parameters - -| Name | Type | Description | -| :---- | :------- | :------------------------------------- | -| `hex` | `string` | The hex value to check for the prefix. | - -#### Returns - -`boolean` - -True if the hex string has the prefix. - -## Constructors - -### constructor - -• **new HexHelper**() diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/RandomHelper.md b/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/RandomHelper.md deleted file mode 100644 index 5ee553bc120..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/RandomHelper.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: RandomHelper - -Class to help with random generation. - -## Table of contents - -### Methods - -- [generate](RandomHelper.md#generate) - -### Constructors - -- [constructor](RandomHelper.md#constructor) - -## Methods - -### generate - -▸ `Static` **generate**(`length`): `Uint8Array` - -Generate a new random array. - -#### Parameters - -| Name | Type | Description | -| :------- | :------- | :------------------------------ | -| `length` | `number` | The length of buffer to create. | - -#### Returns - -`Uint8Array` - -The random array. - -## Constructors - -### constructor - -• **new RandomHelper**() diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/ReadStream.md b/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/ReadStream.md deleted file mode 100644 index 4ceb9b8d942..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/ReadStream.md +++ /dev/null @@ -1,299 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: ReadStream - -Keep track of the read index within a stream. - -## Table of contents - -### Constructors - -- [constructor](ReadStream.md#constructor) - -### Methods - -- [length](ReadStream.md#length) -- [hasRemaining](ReadStream.md#hasremaining) -- [unused](ReadStream.md#unused) -- [getReadIndex](ReadStream.md#getreadindex) -- [setReadIndex](ReadStream.md#setreadindex) -- [readFixedHex](ReadStream.md#readfixedhex) -- [readBytes](ReadStream.md#readbytes) -- [readUInt8](ReadStream.md#readuint8) -- [readUInt16](ReadStream.md#readuint16) -- [readUInt32](ReadStream.md#readuint32) -- [readUInt64](ReadStream.md#readuint64) -- [readUInt256](ReadStream.md#readuint256) -- [readBoolean](ReadStream.md#readboolean) - -## Constructors - -### constructor - -• **new ReadStream**(`storage`, `readStartIndex?`) - -Create a new instance of ReadStream. - -#### Parameters - -| Name | Type | Default value | Description | -| :--------------- | :----------- | :------------ | :----------------------------------- | -| `storage` | `Uint8Array` | `undefined` | The data to access. | -| `readStartIndex` | `number` | `0` | The index to start the reading from. | - -## Methods - -### length - -▸ **length**(): `number` - -Get the length of the storage. - -#### Returns - -`number` - -The storage length. - ---- - -### hasRemaining - -▸ **hasRemaining**(`remaining`): `boolean` - -Does the storage have enough data remaining. - -#### Parameters - -| Name | Type | Description | -| :---------- | :------- | :-------------------------- | -| `remaining` | `number` | The amount of space needed. | - -#### Returns - -`boolean` - -True if it has enough data. - ---- - -### unused - -▸ **unused**(): `number` - -How much unused data is there. - -#### Returns - -`number` - -The amount of unused data. - ---- - -### getReadIndex - -▸ **getReadIndex**(): `number` - -Get the current read index. - -#### Returns - -`number` - -The current read index. - ---- - -### setReadIndex - -▸ **setReadIndex**(`readIndex`): `void` - -Set the current read index. - -#### Parameters - -| Name | Type | Description | -| :---------- | :------- | :---------------------- | -| `readIndex` | `number` | The current read index. | - -#### Returns - -`void` - ---- - -### readFixedHex - -▸ **readFixedHex**(`name`, `length`, `moveIndex?`): `string` - -Read fixed length as hex. - -#### Parameters - -| Name | Type | Default value | Description | -| :---------- | :-------- | :------------ | :------------------------------------------ | -| `name` | `string` | `undefined` | The name of the data we are trying to read. | -| `length` | `number` | `undefined` | The length of the data to read. | -| `moveIndex` | `boolean` | `true` | Move the index pointer on. | - -#### Returns - -`string` - -The hex formatted data. - ---- - -### readBytes - -▸ **readBytes**(`name`, `length`, `moveIndex?`): `Uint8Array` - -Read an array of byte from the stream. - -#### Parameters - -| Name | Type | Default value | Description | -| :---------- | :-------- | :------------ | :------------------------------------------ | -| `name` | `string` | `undefined` | The name of the data we are trying to read. | -| `length` | `number` | `undefined` | The length of the array to read. | -| `moveIndex` | `boolean` | `true` | Move the index pointer on. | - -#### Returns - -`Uint8Array` - -The value. - ---- - -### readUInt8 - -▸ **readUInt8**(`name`, `moveIndex?`): `number` - -Read a byte from the stream. - -#### Parameters - -| Name | Type | Default value | Description | -| :---------- | :-------- | :------------ | :------------------------------------------ | -| `name` | `string` | `undefined` | The name of the data we are trying to read. | -| `moveIndex` | `boolean` | `true` | Move the index pointer on. | - -#### Returns - -`number` - -The value. - ---- - -### readUInt16 - -▸ **readUInt16**(`name`, `moveIndex?`): `number` - -Read a UInt16 from the stream. - -#### Parameters - -| Name | Type | Default value | Description | -| :---------- | :-------- | :------------ | :------------------------------------------ | -| `name` | `string` | `undefined` | The name of the data we are trying to read. | -| `moveIndex` | `boolean` | `true` | Move the index pointer on. | - -#### Returns - -`number` - -The value. - ---- - -### readUInt32 - -▸ **readUInt32**(`name`, `moveIndex?`): `number` - -Read a UInt32 from the stream. - -#### Parameters - -| Name | Type | Default value | Description | -| :---------- | :-------- | :------------ | :------------------------------------------ | -| `name` | `string` | `undefined` | The name of the data we are trying to read. | -| `moveIndex` | `boolean` | `true` | Move the index pointer on. | - -#### Returns - -`number` - -The value. - ---- - -### readUInt64 - -▸ **readUInt64**(`name`, `moveIndex?`): `BigInteger` - -Read a UInt64 from the stream. - -#### Parameters - -| Name | Type | Default value | Description | -| :---------- | :-------- | :------------ | :------------------------------------------ | -| `name` | `string` | `undefined` | The name of the data we are trying to read. | -| `moveIndex` | `boolean` | `true` | Move the index pointer on. | - -#### Returns - -`BigInteger` - -The value. - ---- - -### readUInt256 - -▸ **readUInt256**(`name`, `moveIndex?`): `BigInteger` - -Read a UInt256 from the stream. - -#### Parameters - -| Name | Type | Default value | Description | -| :---------- | :-------- | :------------ | :------------------------------------------ | -| `name` | `string` | `undefined` | The name of the data we are trying to read. | -| `moveIndex` | `boolean` | `true` | Move the index pointer on. | - -#### Returns - -`BigInteger` - -The value. - ---- - -### readBoolean - -▸ **readBoolean**(`name`, `moveIndex?`): `boolean` - -Read a boolean from the stream. - -#### Parameters - -| Name | Type | Default value | Description | -| :---------- | :-------- | :------------ | :------------------------------------------ | -| `name` | `string` | `undefined` | The name of the data we are trying to read. | -| `moveIndex` | `boolean` | `true` | Move the index pointer on. | - -#### Returns - -`boolean` - -The value. diff --git a/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/WriteStream.md b/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/WriteStream.md deleted file mode 100644 index 4d5cea96e4a..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/references/util/classes/WriteStream.md +++ /dev/null @@ -1,285 +0,0 @@ ---- -description: iota.js API reference -keywords: - - references - - api references - - typescript -image: /img/client_banner.png ---- - -# Class: WriteStream - -Keep track of the write index within a stream. - -## Table of contents - -### Constructors - -- [constructor](WriteStream.md#constructor) - -### Methods - -- [length](WriteStream.md#length) -- [unused](WriteStream.md#unused) -- [finalBytes](WriteStream.md#finalbytes) -- [finalHex](WriteStream.md#finalhex) -- [getWriteIndex](WriteStream.md#getwriteindex) -- [setWriteIndex](WriteStream.md#setwriteindex) -- [writeFixedHex](WriteStream.md#writefixedhex) -- [writeBytes](WriteStream.md#writebytes) -- [writeUInt8](WriteStream.md#writeuint8) -- [writeUInt16](WriteStream.md#writeuint16) -- [writeUInt32](WriteStream.md#writeuint32) -- [writeUInt64](WriteStream.md#writeuint64) -- [writeUInt256](WriteStream.md#writeuint256) -- [writeBoolean](WriteStream.md#writeboolean) - -## Constructors - -### constructor - -• **new WriteStream**() - -Create a new instance of ReadStream. - -## Methods - -### length - -▸ **length**(): `number` - -Get the length of the stream. - -#### Returns - -`number` - -The stream length. - ---- - -### unused - -▸ **unused**(): `number` - -How much unused data is there. - -#### Returns - -`number` - -The amount of unused data. - ---- - -### finalBytes - -▸ **finalBytes**(): `Uint8Array` - -Get the final stream as bytes. - -#### Returns - -`Uint8Array` - -The final stream. - ---- - -### finalHex - -▸ **finalHex**(): `string` - -Get the final stream as hex. - -#### Returns - -`string` - -The final stream as hex. - ---- - -### getWriteIndex - -▸ **getWriteIndex**(): `number` - -Get the current write index. - -#### Returns - -`number` - -The current write index. - ---- - -### setWriteIndex - -▸ **setWriteIndex**(`writeIndex`): `void` - -Set the current write index. - -#### Parameters - -| Name | Type | Description | -| :----------- | :------- | :----------------------- | -| `writeIndex` | `number` | The current write index. | - -#### Returns - -`void` - ---- - -### writeFixedHex - -▸ **writeFixedHex**(`name`, `length`, `val`): `void` - -Write fixed length stream. - -#### Parameters - -| Name | Type | Description | -| :------- | :------- | :------------------------------------------- | -| `name` | `string` | The name of the data we are trying to write. | -| `length` | `number` | The length of the data to write. | -| `val` | `string` | The data to write. | - -#### Returns - -`void` - ---- - -### writeBytes - -▸ **writeBytes**(`name`, `length`, `val`): `void` - -Write fixed length stream. - -#### Parameters - -| Name | Type | Description | -| :------- | :----------- | :------------------------------------------- | -| `name` | `string` | The name of the data we are trying to write. | -| `length` | `number` | The length of the data to write. | -| `val` | `Uint8Array` | The data to write. | - -#### Returns - -`void` - ---- - -### writeUInt8 - -▸ **writeUInt8**(`name`, `val`): `void` - -Write a byte to the stream. - -#### Parameters - -| Name | Type | Description | -| :----- | :------- | :------------------------------------------- | -| `name` | `string` | The name of the data we are trying to write. | -| `val` | `number` | The data to write. | - -#### Returns - -`void` - ---- - -### writeUInt16 - -▸ **writeUInt16**(`name`, `val`): `void` - -Write a UInt16 to the stream. - -#### Parameters - -| Name | Type | Description | -| :----- | :------- | :------------------------------------------- | -| `name` | `string` | The name of the data we are trying to write. | -| `val` | `number` | The data to write. | - -#### Returns - -`void` - ---- - -### writeUInt32 - -▸ **writeUInt32**(`name`, `val`): `void` - -Write a UInt32 to the stream. - -#### Parameters - -| Name | Type | Description | -| :----- | :------- | :------------------------------------------- | -| `name` | `string` | The name of the data we are trying to write. | -| `val` | `number` | The data to write. | - -#### Returns - -`void` - ---- - -### writeUInt64 - -▸ **writeUInt64**(`name`, `val`): `void` - -Write a UInt64 to the stream. - -#### Parameters - -| Name | Type | Description | -| :----- | :----------- | :------------------------------------------- | -| `name` | `string` | The name of the data we are trying to write. | -| `val` | `BigInteger` | The data to write. | - -#### Returns - -`void` - ---- - -### writeUInt256 - -▸ **writeUInt256**(`name`, `val`): `void` - -Write a UInt256 to the stream. - -#### Parameters - -| Name | Type | Description | -| :----- | :----------- | :------------------------------------------- | -| `name` | `string` | The name of the data we are trying to write. | -| `val` | `BigInteger` | The data to write. | - -#### Returns - -`void` - ---- - -### writeBoolean - -▸ **writeBoolean**(`name`, `val`): `void` - -Write a boolean to the stream. - -#### Parameters - -| Name | Type | Description | -| :----- | :-------- | :------------------------------------------- | -| `name` | `string` | The name of the data we are trying to write. | -| `val` | `boolean` | The data to write. | - -#### Returns - -`void` diff --git a/docs/build/iota.js/2.0-rc.1/docs/troubleshooting.md b/docs/build/iota.js/2.0-rc.1/docs/troubleshooting.md deleted file mode 100644 index 405342b5548..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/troubleshooting.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -description: "If you are having any trouble with the iota.js client library you can check -out https://iota.stackexchange.com/ or https://discord.iota.org." -image: /img/client_banner.png -keywords: -- discussion -- channel -- problem -- solution -- discord -- stack exchange -- reference ---- - -# Troubleshooting - -## Stack Exchange - -The [IOTA Stack Exchange](https://iota.stackexchange.com/) -is an excellent tool for developers to find answers to their problems. Just search for your problem and find your -answer! If there is no answer yet, submit your question and share it in the discussion channel below. - -## Join the Discussion - -If you want to get involved in discussions about this library, or you are looking for support, take a look at what -discussions are going on in the [#client-libraries](https://discord.com/channels/397872799483428865/800637917189636136) -and [#javascript](https://discord.com/channels/397872799483428865/400435174518685696) channels on our -[Discord](https://discord.iota.org). diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/.keep b/docs/build/iota.js/2.0-rc.1/docs/tutorials/.keep deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/alias-transactions/01-introduction.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/alias-transactions/01-introduction.md deleted file mode 100644 index 35263618a8c..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/alias-transactions/01-introduction.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -description: "Get acquainted with the structure and functionality of transactions in IOTA's Stardust protocol in the -Shimmer network using iota.js primitives to issue transactions involving Alias Outputs." -image: /img/client_banner.png -keywords: - -- tutorial -- UTXO -- alias -- shimmer -- ledger -- outputs -- inputs - ---- - -# Stardust for iota.js: Alias Transactions - -This tutorial will get you acquainted with the structure and functionality of [Alias Transactions](/introduction/stardust/explanations/ledger/alias) in -IOTA's [Stardust protocol](/introduction/stardust/welcome) in -the [Shimmer network](https://shimmer.network) using [iota.js](https://github.com/iotaledger/iota.js) primitives to -issue transactions that involve Alias Output. - -## Introduction - -Starting from [Chrysalis](/learn/protocols/chrysalis/introduction), IOTA is -a [UTXO-based (Unspent Transaction Output)](/learn/protocols/chrysalis/core-concepts/switch-to-UTXO) -Ledger. Each UTXO, also known as **output**, has an associated number of tokens that determines its value. -Thus, the permanent data on the ledger is composed of a set of records (_outputs_) that can be unlocked by the owner of -its associated address, i.e., the one who knows the address' private key. - -There are different [output types](/tips/tips/TIP-0018#output-design). This tutorial series will only focus on -**Alias Outputs** known as [`IAliasOutput`](./../../references/client/interfaces/IAliasOutput.md). Alias Outputs are -generated by transactions that unlock and consume already existing outputs. When a transaction consumes them, these -outputs turn into inputs and generate new outputs, typically another Alias Output with the same Alias ID but in a different state. At pruning time, _consumed outputs_ will be removed by Nodes. - -## Storage Costs and Deposits - -You need to take into account that Alias Output as any other UTXOs need to be stored by [Hornet Nodes](/hornet/welcome), so there is a [storage cost](/iota.js/tutorials/value-transactions/introduction#storage-costs-and-deposits). diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/alias-transactions/02-prepare-the-dev-env.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/alias-transactions/02-prepare-the-dev-env.md deleted file mode 100644 index a7c4ef66ab3..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/alias-transactions/02-prepare-the-dev-env.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -description: 'Prepare a development environment to run the alias transactions in iota.js tutorial.' -image: /img/client_banner.png -keywords: - - tutorial - - Node.js 16 - - auxiliary library - - proof of work - - pow - - shimmer - - testnet node ---- - -# Prepare Your Development Environment - -To run the code in this tutorial, you will need the following: - -- [Node.js 16](https://nodejs.org/en/blog/release/v16.16.0/). -- The [`@iota/iota.js`](https://www.npmjs.com/package/@iota/iota.js) library -- The `iota.js` auxiliary libraries: - - - [`@iota/crypto.js`](https://www.npmjs.com/package/@iota/crypto.js) - - [`@iota/util.js`](https://www.npmjs.com/package/@iota/util.js). - - [`@iota/pow-neon.js`](https://www.npmjs.com/package/@iota/pow-neon.js) to run Proof of Work (PoW). Alternatively, - you can spin up your own node to run the PoW remotely. - -- Access to a Stardust Node (Hornet 2.0.0). You can use the Shimmer testnet Nodes - at [https://api.testnet.shimmer.network](https://api.testnet.shimmer.network). -- (Optional) A TypeScript compiler and related packages - -## (optional) Download the Code - -You -can [download the tutorials codebase](https://github.com/iotaledger/iota.js/tree/feat/stardust/packages/iota/examples/shimmer-alias-transaction-tutorial) -to follow while you read the next sections. - -:::info Running Code Examples - -If you plan on using the provided code example, please read the article [How To Run Code Examples](../../how_tos/run_how_tos.mdx). - -::: - -:::note Shimmer Addresses and Outputs - -The tutorial's codebase uses several predefined Shimmer addresses and outputs. If you are going to use other addresses, you will need to update the code accordingly. Likewise, the tutorial codebase assumes a particular state of the addresses and outputs. Before executing the code, please ensure your addresses and outputs are in the expected state. - -::: - -### Available Commands - -#### Mint Alias Output - -You can run the `mint-new-alias` script by running the following command from the example's directory: - -```bash -npm run mint -``` - -**Where** `outputID` is the ID of an Output that has enough funds to cover the storage deposit of your newly minted Alias. - -#### Transition Alias Output - -You can run the `alias-transaction` script by running the following command from the example's directory: - -```bash -npm run alias-transaction -``` - -**Where** `AliasID` is the Alias ID you want to transact with so that it transitions to a new state. - -## Create Your package.json File - -You can create your `package.json` file from the example below and place it in your projects base directory: - -```json -{ - "name": "tutorial-alias", - "version": "1.0.0", - "scripts": { - "dist": "tsc", - "mint": "node dist/mint-new-alias", - "alias-transaction": "node dist/alias-transaction" - }, - "dependencies": { - "@iota/crypto.js": "2.0.0-rc.1", - "@iota/iota.js": "2.0.0-rc.2", - "@iota/util.js": "2.0.0-rc.1", - "@iota/pow-neon.js": "2.0.0-rc.2" - }, - "devDependencies": { - "typescript": "^4.4.3", - "@types/node": "18.7.23" - } -} -``` - -After you have created the `package.json` file, you can install all the necessary dependencies by running the following -command from the same directory: - -```bash -npm install -``` - -## Troubleshooting - -If you are getting any errors during the installation process please make sure your system is -using [Node.js 16](https://nodejs.org/en/blog/release/v16.16.0/). You can check your node version by running the -following command: - -```bash -node -v -``` diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/alias-transactions/03-mint-new-alias.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/alias-transactions/03-mint-new-alias.md deleted file mode 100644 index 71d91385af1..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/alias-transactions/03-mint-new-alias.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -description: 'Mint a new Alias with iota.js.' -image: /img/client_banner.png -keywords: - - tutorial - - alias - - address - - output - - mint ---- - -# Mint a New Alias Address - -You can use an [Alias Output](/introduction/stardust/explanations/ledger/alias) to store proof of the world state included in the ledger and never pruned. An Alias Output is associated with an Alias ID (also known as an [Alias Address](#calculate-the-alias-id)). An Alias ID remains immutable during its lifetime. - -For instance, an Alias Output can contain a hash or digital signature as a commitment to the state of a particular dynamic data set, as it happens with Smart Contracts. A data validator can use such proof to ensure that the concerned data has not been tampered with. When there is a change in the data, a transition to a new state is recorded on the ledger by a new transaction that generates a new Alias Output with the original Alias ID. The Alias ID remains constant, whereas a new Alias Output is generated to hold the new state. - -Provided the proof size in bytes does not change between state changes, a new Alias Output does not need to increase its storage deposit. - -To mint a new Alias and generate its genesis, you will need the following: - -- An unspent Output that holds enough funds for the minimal storage deposit needed for the genesis Alias Output. In the Testnet, you can [request funds through the Faucet](../value-transactions/06-request-funds-from-the-faucet.md). - -- The key pair that corresponds to the Shimmer address that owns the output, as you need to unlock a certain amount of funds to cover the storage deposit of the new minted Alias. - -- A State Controller Address. You will use the State Controller address private key to unlock the Alias Output of your new Alias so that it can transition to a new state when needed. If you haven’t generated any addresses before, you can find detailed instructions in the [Send Value Transactions tutorial](../value-transactions/04-generate-addresses.md). - -- A Governor Address. With the private key of the Governor, you will be able to change the State Controller Address or even destroy the Alias. - -- The data you want to store on the Alias Output (represented as a hexadecimal string). Remember, the longer the data, the higher the storage deposit you will need. - -```typescript -const consumedOutputId = '0x45678...'; - -// Ed25519 Addresses (PubKeyHash) -const sourceAddress = '0x377a...'; - -// Ed25519 Key pairs -const sourceAddressPublicKey = '0x1be6ea...'; -const sourceAddressPrivateKey = '0xb2a5c46a...'; - -// Ed25519 Addresses (PubKeyHash) -const stateControllerAddress = - '0x647f7a9fd831c6e6034e7e5496a50aed17ef7d2add200bb4cfde7649ce2b0aaf'; -const governorAddress = - '0x22847390aad479d34d52e4fb58a01d752887ae0247708f7e66b488c5b5ba2751'; - -const client = new SingleNodeClient(API_ENDPOINT, { - powProvider: new NeonPowProvider(), -}); -const protocolInfo = await client.protocolInfo(); -``` - -## Define the Genesis Alias Output - -You can define the genesis (initial) Alias Output to mint your Alias with the following snippet: - -```typescript -const initialAliasId = new Uint8Array(new ArrayBuffer(32)); - -const aliasOutput: IAliasOutput = { - type: ALIAS_OUTPUT_TYPE, - amount: amountToSend.toString(), - aliasId: Converter.bytesToHex(initialAliasId, true), - stateMetadata: '0x12345678', - stateIndex: 0, - foundryCounter: 0, - unlockConditions: [ - { - type: STATE_CONTROLLER_ADDRESS_UNLOCK_CONDITION_TYPE, - address: { - type: ED25519_ADDRESS_TYPE, - pubKeyHash: stateControllerAddress, - }, - }, - { - type: GOVERNOR_ADDRESS_UNLOCK_CONDITION_TYPE, - address: { - type: ED25519_ADDRESS_TYPE, - pubKeyHash: governorAddress, - }, - }, - ], -}; -``` - -The `aliasId` is initialized as a hexadecimal string that represents `32` bytes set to `0`. That is the way to ask for a new Alias to be minted. The `stateIndex` is initialized as `0`, as this is the initial state. In the unlock conditions, the State Controller and Governor addresses are specified in their Ed25519 hashed representation. - -## Define the Transaction Essence - -The transaction you are defining involves an input (the output that holds enough funds to cover the storage deposit of the new Alias) and two outputs: -The new Alias Output -A Basic Output that holds the remaining funds from the original Input. You can only unlock this Output with the original address that controls the funds. - -In this case, you manually assign an amount to send to the Alias Output (`60000 Glow`) so that it covers its storage deposit. In a real-world scenario, you may need to automatically calculate the storage deposit as per the byte rent costs published by your node. - -You can calculate the remaining funds by sending a query to the node to obtain the details of the consumed output. You can use the following snippet to do so: - -```typescript -const inputs: IUTXOInput[] = []; -const outputs: (IAliasOutput | IBasicOutput)[] = []; - -// The number of funds to be sent to an alias output so that it covers its byte costs -const amountToSend = bigInt('60000'); - -inputs.push(TransactionHelper.inputFromOutputId(consumedOutputId)); - -// Details the of consumed Output -const consumedOutputDetails = await client.output(consumedOutputId); -const totalFunds = bigInt(consumedOutputDetails.output.amount); - -// The remaining output remains in the origin address -const remainderBasicOutput: IBasicOutput = { - type: BASIC_OUTPUT_TYPE, - amount: totalFunds.minus(amountToSend).toString(), - nativeTokens: [], - unlockConditions: [ - { - type: ADDRESS_UNLOCK_CONDITION_TYPE, - address: { - type: ED25519_ADDRESS_TYPE, - pubKeyHash: sourceAddress, - }, - }, - ], - features: [], -}; - -outputs.push(aliasOutput); -outputs.push(remainderBasicOutput); - -// Get inputs commitment -const inputsCommitment = TransactionHelper.getInputsCommitment([ - consumedOutputDetails.output, -]); - -// Create transaction essence -const transactionEssence: ITransactionEssence = { - type: TRANSACTION_ESSENCE_TYPE, - networkId: TransactionHelper.networkIdFromNetworkName( - protocolInfo.networkName, - ), - inputs, - inputsCommitment, - outputs, -}; -``` - -## Issue the Transaction - -Once you have defined the transaction essence, you can [issue the transaction](../value-transactions/08-transfer-funds.md#create-a-transaction-payload). You will need to sign the essence with the keys of the address that controls the initial output that will provide funds for the Alias output (the storage deposit as a minimum). - -After submitting the block with the Block ID, you can check the [Tangle Explorer](https://explorer.shimmer.network/testnet) for the resulting outputs. - -```typescript -const wsTsxEssence = new WriteStream(); -serializeTransactionEssence(wsTsxEssence, transactionEssence); -const essenceFinal = wsTsxEssence.finalBytes(); - -const essenceHash = Blake2b.sum256(essenceFinal); - -const unlockCondition: ISignatureUnlock = { - type: SIGNATURE_UNLOCK_TYPE, - signature: { - type: ED25519_SIGNATURE_TYPE, - publicKey: sourceAddressPublicKey, - signature: Converter.bytesToHex( - Ed25519.sign(Converter.hexToBytes(sourceAddressPrivateKey), essenceHash), - true, - ), - }, -}; - -const transactionPayload: ITransactionPayload = { - type: TRANSACTION_PAYLOAD_TYPE, - essence: transactionEssence, - unlocks: [unlockCondition], -}; - -const block: IBlock = { - protocolVersion: DEFAULT_PROTOCOL_VERSION, - parents: [], - payload: transactionPayload, - nonce: '0', -}; - -const blockId = await client.blockSubmit(block); -console.log('Block Id:', blockId); -``` - -## Calculate the Alias ID - -It is important to understand that the new Alias ID is derived from the ID of the Alias Output, and the ID of the Alias Output is derived from the ID of the transaction. The transaction ID is a hash of the transaction payload, which can be calculated using the function `computeTransactionIdFromTransactionPayload` as shown below. The output ID is calculated using the function [`TransactionHelper.outputIdFromTransactionData`](../../references/client/classes/TransactionHelper.md#outputidfromtransactiondata), and the Alias Id is the Blake256 hash of an Output Id. You can calculate the Bech32 address corresponding to the Alias Id using the [`Bech32Helper`](../../references/client/classes/Bech32Helper.md) and specifying that it is an `ALIAS_ADDRESS_TYPE`. - -```typescript -const blockData: IBlock = await client.block(blockId); -const blockTransactionPayload = blockData.payload as ITransactionPayload; - -const transactionId = computeTransactionIdFromTransactionPayload( - blockTransactionPayload, -); -const outputId = TransactionHelper.outputIdFromTransactionData( - transactionId, - 0, -); -console.log('Output Id:', outputId); - -const addrHash = Blake2b.sum256(Converter.hexToBytes(outputId)); -console.log('Alias ID:', Converter.bytesToHex(addrHash, true)); -console.log( - 'Alias Address:', - Bech32Helper.toBech32(ALIAS_ADDRESS_TYPE, addrHash, protocolInfo.bech32Hrp), -); - -function computeTransactionIdFromTransactionPayload( - payload: ITransactionPayload, -) { - const tpWriteStream = new WriteStream(); - serializeTransactionPayload(tpWriteStream, payload); - return Converter.bytesToHex(Blake2b.sum256(tpWriteStream.finalBytes()), true); -} -``` - -The code above will result in something similar to the following: - -```text -Block Id: 0x2817e61f5a559a7521e2e20dfc69f0e184a6fa00109a05fa040a9d6cb6d292e1 -Output Id: 0x6e23b48b4f4e5683832c4b53d598b00d769ba2a7305c9c0cdeefb0246b894f330000 -Alias ID: 0x6dd4b53990a862f7afaa19b58c5566970d7c40482547abd50a3a6de9f9ad4b14 -Alias Address: rms1ppkafdfejz5x9aa04gvmtrz4v6ts6lzqfqj50274pgaxm60e4493gdry4ys -``` - -Remember that the Alias ID remains constant and known by every node software regardless of the transactions (Alias Outputs generated) issued. That means you can query through the Tangle Explorer, for instance, the current Alias Output of an Alias Id by just supplying the Alias Id or its representation as a Bech32 address. - -## Putting It All Together - -The complete source code of this part of the tutorial is available in the [official iota.js GitHub repository](https://github.com/iotaledger/iota.js/blob/feat/stardust/packages/iota/examples/shimmer-alias-transaction-tutorial/src/mint-new-alias.ts). diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/alias-transactions/04-alias-transaction.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/alias-transactions/04-alias-transaction.md deleted file mode 100644 index 23ed2d6e89e..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/alias-transactions/04-alias-transaction.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -description: 'Perform an Alias Transaction with iota.js.' -image: /img/client_banner.png -keywords: - - tutorial - - alias - - output - - transaction ---- - -# Create an Alias Transaction - -The State Controller of an Alias can perform transactions that change the Alias to a new state. The transaction generates a new Alias Output with the Alias ID of the original Alias. Remember that the Alias ID remains constant regardless of the Alias Output that holds the funds and the state metadata. The **Alias Output Id** changes, and once it is "spent", it is pruned from the ledger. - -## Preparation - -To create this transaction, you will need the following: - -- A Shimmer Node. You can use the [Shimmer Testnet nodes](https://api.testnet.shimmer.network). - -- The Alias ID of your Alias, in hexadecimal format `0x6dd4...`. - -- The keys of the state controller of your Alias. - -```typescript -const client = new SingleNodeClient(API_ENDPOINT, { - powProvider: new NeonPowProvider(), -}); -const protocolInfo = await client.protocolInfo(); - -const stateControllerPubKey = '0x55419...'; -const stateControllerPrivateKey = '0xa060ff...'; -``` - -## Query Alias Output - -You will first need to find the Alias Output of your Alias. The easiest way to do so is through a query to the [indexation plugin](/hornet/2.0/inx-plugins/indexer/api_reference) by Alias ID. Observe that you need to obtain the full output details as we need to use them as input for the transaction. - -```typescript -const indexerPlugin = new IndexerPluginClient(client); -const outputList = await indexerPlugin.alias(aliasId); -const consumedOutputId = outputList.items[0]; -console.log('Consumed Output Id', consumedOutputId); - -const initialAliasOutputDetails = await client.output(consumedOutputId); -const initialAliasOutput: IAliasOutput = - initialAliasOutputDetails.output as IAliasOutput; -``` - -## Assign the New State - -To continue, you can create the new Alias Output by cloning the one received in the [previous step](#query-alias-output), and then increment the `stateIndex` and set the new `stateMetadata`. Now, you are ready to define the transaction. You should ensure that you assign the correct `aliasId` to your new Alias Output. - -As the proof size does not change between state changes, your new Alias Output does not need to increase its storage deposit. - -```typescript -const nextAliasOutput: IAliasOutput = JSON.parse( - JSON.stringify(initialAliasOutput), -); -nextAliasOutput.stateIndex++; -nextAliasOutput.stateMetadata = '0x98765'; -console.log('New state index: ', nextAliasOutput.stateIndex); -nextAliasOutput.aliasId = aliasId; -``` - -## Define the Transaction - -The transaction takes the original Alias Output as Input and generates a new Alias Output with the new state but keeps the original Alias ID. - -```typescript -const inputs: IUTXOInput[] = []; -const outputs: IAliasOutput[] = []; - -inputs.push(TransactionHelper.inputFromOutputId(consumedOutputId)); -outputs.push(nextAliasOutput); - -const inputsCommitment = TransactionHelper.getInputsCommitment([ - initialAliasOutput, -]); - -const transactionEssence: ITransactionEssence = { - type: TRANSACTION_ESSENCE_TYPE, - networkId: TransactionHelper.networkIdFromNetworkName( - protocolInfo.networkName, - ), - inputs, - inputsCommitment, - outputs, -}; -``` - -## Unlock your Input - -To unlock your Input you need to provide the signature of the State Controller calculated against the transaction essence. - -```typescript -const wsTsxEssence = new WriteStream(); -serializeTransactionEssence(wsTsxEssence, transactionEssence); -const essenceFinal = wsTsxEssence.finalBytes(); - -const essenceHash = Blake2b.sum256(essenceFinal); - -const unlockCondition: ISignatureUnlock = { - type: SIGNATURE_UNLOCK_TYPE, - signature: { - type: ED25519_SIGNATURE_TYPE, - publicKey: stateControllerPubKey, - signature: Converter.bytesToHex( - Ed25519.sign( - Converter.hexToBytes(stateControllerPrivateKey), - essenceHash, - ), - true, - ), - }, -}; - -const transactionPayload: ITransactionPayload = { - type: TRANSACTION_PAYLOAD_TYPE, - essence: transactionEssence, - unlocks: [unlockCondition], -}; -``` - -## Submit the Block - -Finally, you should submit the block. After the block is confirmed, if you query your Alias Address through [the Shimmer Explorer](https://explorer.shimmer.network/shimmer), you will find the new Alias Output with the updated state. - -```typescript -const block: IBlock = { - protocolVersion: DEFAULT_PROTOCOL_VERSION, - parents: [], - payload: transactionPayload, - nonce: '0', -}; - -const blockId = await client.blockSubmit(block); -console.log('Block Id:', blockId); -``` - -## Putting It All Together - -The complete source code of this part of the tutorial is available in the [official iota.js GitHub repository](https://github.com/iotaledger/iota.js/blob/feat/stardust/packages/iota/examples/shimmer-alias-transaction-tutorial/src/alias-transaction.ts). diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/native-token-transactions/01-introduction.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/native-token-transactions/01-introduction.md deleted file mode 100644 index 35e88ef6f30..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/native-token-transactions/01-introduction.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -description: "Learn how to create user-defined native tokens, also known as Digital Assets, with IOTA's Stardust protocol in the Shimmer network using iota.js." -image: /img/client_banner.png -keywords: - - tutorial - - UTXO - - native token - - token - - foundry - - digital - - asset - - mint - - melt - - shimmer - - ledger - - outputs - - inputs ---- - -# Stardust for iota.js: Digital Assets - -This tutorial will show you how to user-defined native tokens, also known as **Digital Assets**, with IOTA's Stardust protocol in the Shimmer network using iota.js - -## Introduction - -Starting from [Chrysalis](/learn/protocols/chrysalis/introduction), IOTA is -a [UTXO-based (Unspent Transaction Output)](/learn/protocols/chrysalis/core-concepts/switch-to-UTXO) -Ledger. Each UTXO, also known as **output**, has an associated number of tokens, protocol-defined Tokens (SMR) and, optionally, user-defined native tokens) that determines its value. -Thus, the permanent data on the ledger is composed of a set of records (_Outputs_) that can be unlocked by the owner of -its associated address, i.e., the one who knows the address' private key. - -There are different [Output types](/tips/tips/TIP-0018#output-design) in the [Stardust Protocol](/introduction/stardust/welcome). This tutorial will focus on -outputs that involve user-defined [native tokens](/introduction/stardust/explanations/ledger/foundry), a.k.a digital assets. The tutorial will also use [Alias](/introduction/stardust/explanations/ledger/alias) and [Foundry](/tips/tips/TIP-0018#output-design#foundry-output) Outputs. - -:::info Foundries -A _Foundry Output_ is an Output that controls the supply of user-defined, custom tokens, also known as _native tokens_. -::: - -Last but not least, you will learn how to define [UTXOs](/introduction/stardust/explanations/what_is_stardust/rethink_utxo) to transfer native tokens among addresses. - -:::tip NFTs -If you want to mint Non-Fungible Tokens (NFTs), you can check out this [how-to guide](../../how_tos/mint_nft.mdx). -::: - -## Storage Costs and Deposits - -You need to take into account that both Alias and Foundry outputs need to be stored by [Hornet Nodes](/hornet/welcome), so there is a [storage cost](/learn/protocols/stardust/core-concepts/storage-deposit) as with any UTXO. diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/native-token-transactions/02-prepare-the-dev-env.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/native-token-transactions/02-prepare-the-dev-env.md deleted file mode 100644 index fa40f907a71..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/native-token-transactions/02-prepare-the-dev-env.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -description: 'Prepare a development environment to run the digital assets in iota.js tutorial.' -image: /img/client_banner.png -keywords: - - tutorial - - Node.js 16 - - auxiliary library - - proof of work - - pow - - shimmer - - testnet node ---- - -# Prepare Your Development Environment - -To run the code in this tutorial, you will need the following: - -- [Node.js 16](https://nodejs.org/en/blog/release/v16.16.0/). -- The [`@iota/iota.js`](https://www.npmjs.com/package/@iota/iota.js) library -- The `iota.js` auxiliary libraries: - - - [`@iota/crypto.js`](https://www.npmjs.com/package/@iota/crypto.js) - - [`@iota/util.js`](https://www.npmjs.com/package/@iota/util.js). - - [`@iota/pow-neon.js`](https://www.npmjs.com/package/@iota/pow-neon.js) to run Proof of Work (PoW). Alternatively, - you can spin up your own node to run the PoW remotely. - -- Access to a Stardust Node (Hornet 2.0.0). You can use the Shimmer testnet Nodes - at [https://api.testnet.shimmer.network](https://api.testnet.shimmer.network). -- (Optional) A TypeScript compiler and related packages - -## (optional) Download the Code - -You -can [download the tutorials codebase](https://github.com/iotaledger/iota.js/tree/feat/stardust/packages/iota/examples/shimmer-digital-assets-tutorial) -to follow while you read the next sections. - -:::warning Running Code Examples - -If you plan on using the provided code example, please read the article [How To Run Code Examples](../../how_tos/run_how_tos.mdx). - -::: - -:::warning Shimmer Addresses and Outputs - -The tutorial's codebase uses several predefined Shimmer addresses and outputs. If you are going to use other addresses, you will need to update the code accordingly. Likewise, the tutorial codebase assumes a particular state of the addresses and Outputs. Before executing the code, please ensure your addresses and Outputs are in the expected state. - -::: - -### Available Commands - -#### Mint Native Tokens - -You can run the `mint-native-tokens` script by running the following command from the example's directory: - -```bash -npm run mint-native-tokens -``` - -#### Transfer Native Tokens - -You can run the `native-tokens-transaction` script by running the following command from the example's directory: - -```bash -npm run native-tokens-transaction -``` - -#### Melt Native Tokens - -You can run the `melt-native-tokens` script by running the following command from the example's directory: - -```bash -npm run melt-native-tokens -``` - -## Create Your package.json File - -You can create your `package.json` file from the example below and place it in your projects base directory: - -```json -{ - "name": "tutorial", - "type": "module", - "version": "1.0.0", - "scripts": { - "dist": "tsc", - "mint-tokens": "node dist/mint-tokens", - "native-tokens-transaction": "node dist/native-tokens-transaction", - "melt-tokens": "node dist/melt-tokens" - }, - "dependencies": { - "@iota/crypto.js": "2.0.0-rc.1", - "@iota/iota.js": "2.0.0-rc.2", - "@iota/util.js": "2.0.0-rc.1", - "@iota/pow-neon.js": "2.0.0-rc.2" - }, - "devDependencies": { - "typescript": "^4.4.3", - "@types/node": "18.7.23" - } -} -``` - -After you have created the `package.json` file, you can install all the necessary dependencies by running the following -command from the same directory: - -```bash -npm install -``` - -## Troubleshooting - -If you are getting any errors during the installation process please make sure your system is -using [Node.js 16](https://nodejs.org/en/blog/release/v16.16.0/). You can check your node version by running the -following command: - -```bash -node -v -``` diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/native-token-transactions/03-mint-native-tokens.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/native-token-transactions/03-mint-native-tokens.md deleted file mode 100644 index c126523312d..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/native-token-transactions/03-mint-native-tokens.md +++ /dev/null @@ -1,305 +0,0 @@ ---- -description: 'Mint native tokens with iota.js.' -image: /img/client_banner.png -keywords: - - tutorial - - alias - - address - - output - - mint - - foundry - - native token - - token - - digital - - asset ---- - -# Mint Native Tokens - -To mint a new native token you will need the following: - -- An initial _unspent Output_ with enough funds to cover the [storage costs](/introduction/stardust/explanations/what_is_stardust/storage_deposit) of the different Outputs involved. In the Testnet, you can [request funds through the Faucet](../value-transactions/06-request-funds-from-the-faucet.md). - -:::info Storage Deposits - -[Storage deposits](/learn/protocols/stardust/core-concepts/storage-deposit) can only be covered by **protocol-defined tokens** (`SMR`). - -::: - -- An _Alias Address_ that you will use to control the Foundry Output associated with your new native tokens. Any change made to the Foundry state will require the keys of the [State Controller](/tips/tips/TIP-0018#state-controller-address-unlock-condition) of this Alias Address and the corresponding state transition that will generate an unspent Alias Output. - -- A _Token Scheme_ that defines a class of tokens with _initial supply_ (how many native tokens of that class you will mint initially) and _maximum supply_. - -- A _Foundry Output_ that captures all the parameters and the state related to your new native tokens, including the [Token Scheme](/tips/tips/TIP-0018#simple-token-scheme-validation-rules). - -- An _Address_ to which you will transfer the initial supply of native tokens through a Basic Output. You can find a guide to generating your [seed](../value-transactions/03-generate-a-seed.md) and [address](../value-transactions/04-generate-addresses.md) in the [send value transactions tutorial](../value-transactions/01-introduction.md). - -## Transfer Funds to Cover Storage Deposits - -The first step is to ensure that you have enough funds in your initial address to cover storage deposits. In the Testnet, you can simply [request funds from the Faucet](../value-transactions/06-request-funds-from-the-faucet.md) to your address. - -## Mint a New Alias ID - -You can find information on [minting a new Alias address](../alias-transactions/03-mint-new-alias.md) in the [Alias transactions tutorial](../alias-transactions/01-introduction.md). Please ensure that you transfer enough funds to this Alias so that it can cover later costs related to minting native tokens. - -This tutorial uses the following Alias: - -- Alias Address: `rms1pzxgrrzzug2rhaug8d0tgcq33p2g65s4x4h8c9ym6nxkmaj3r5zeg5fxxa7` -- Alias ID: `0x8c818c42e2143bf7883b5eb4601188548d5215356e7c149bd4cd6df6511d0594` -- State Controller Address: `rms1qpj8775lmqcudesrfel9f949ptk30mma9twjqza5el08vjww9v927ywt70u` - -:::tip Storage Deposits - -This tutorial assumes that the newly minted Alias ID holds enough funds (protocol-defined tokens, or `SMR`) to cover the new Outputs that you will generate. - -::: - -## Prepare the Alias Address - -### Obtain the Current Alias Output - -Once you have your Alias ID, you will need to get its current unspent Alias Output through the [Indexer Plugin](/hornet/2.0/inx-plugins/indexer/api_reference). The Alias Output will participate in a transaction that will create a new Foundry Output and mint native tokens. - -```typescript -const aliasId = '0x8c81...'; -const client = new SingleNodeClient(API_ENDPOINT, { - powProvider: new NeonPowProvider(), -}); - -const indexerPlugin = new IndexerPluginClient(client); -const outputList = await indexerPlugin.alias(aliasId); -const consumedOutputId = outputList.items[0]; - -const initialAliasOutputDetails = await client.output(consumedOutputId); -const initialAliasOutput: IAliasOutput = - initialAliasOutputDetails.output as IAliasOutput; -``` - -### Define the Next Alias Output (transition) - -To define the next Alias Output, you need to trigger a transition of the UTXO machine associated to your Alias ID. To do so, you will need to define a new Alias Output. The new Alias Output will increment the `stateIndex`. Since you associate your Alias ID with a new Foundry that will control your new native token class, you must set the `foundryCounter` field to `1`. - -In the code below you can observe that the amount associated to the new Alias Output is set to `0`. That's because, initially, you don’t know how many funds will remain on the next Alias Output. What it is sure is that the amount of funds remaining will be less than in the initial Output, as you will be using some of those funds to cover the storage deposit of the new Outputs that will be generated during this process. Alternatively, you could have involved other Outputs in this transaction to cover those storage costs.. - -```typescript -const nextAliasOutput: IAliasOutput = JSON.parse( - JSON.stringify(initialAliasOutput), -); -nextAliasOutput.stateIndex++; -nextAliasOutput.aliasId = aliasId; -nextAliasOutput.amount = '0'; -nextAliasOutput.foundryCounter = 1; -``` - -## Define your Token Scheme - -You can define your Token Scheme as follows: - -```typescript -const mintedAmount = 128; -const totalAmount = 512; -const tokenScheme: ISimpleTokenScheme = { - type: SIMPLE_TOKEN_SCHEME_TYPE, - mintedTokens: HexHelper.fromBigInt256(bigInt(mintedAmount)), - meltedTokens: HexHelper.fromBigInt256(bigInt(0)), - maximumSupply: HexHelper.fromBigInt256(bigInt(totalAmount)), -}; -``` - -You can observe that you need to define the total amount and the maximum supply of minted tokens. - -## Define the Foundry Output - -Your next step is to define the Foundry Output (`IFoundryOutput`) that will control your new Token Scheme. You will need to set the serial number of the Foundry (`1` in this case), the formerly defined token scheme and the [unlock conditions](/introduction/stardust/explanations/what_is_stardust/unlock_conditions). The Foundry Output can only be unlocked by the state controller of the Alias Address that controls it. - -As with the Alias Output, you need to deliberately set the amount to `0`, as at this point in time you don't know the amount of protocol-defined tokens you will need to cover the storage deposit for this Output. - -```typescript -const foundryOutput: IFoundryOutput = { - type: FOUNDRY_OUTPUT_TYPE, - amount: '0', // Not known yet - serialNumber: 1, - tokenScheme, - unlockConditions: [ - { - // Foundry supports only this unlock condition! - // It will be controlled through its lifetime by our alias - type: IMMUTABLE_ALIAS_UNLOCK_CONDITION_TYPE, - address: { - type: ALIAS_ADDRESS_TYPE, - aliasId, - }, - }, - ], -}; -``` - -### Create the Token Class ID - -To issue native token transactions, you will need a way to refer to each class of native tokens controlled by each foundry uniquely. You can do it using the class ID, which you can obtain by calculating a hash of the Alias ID, foundry serial output, and the type of token scheme as shown in the following snippet: - -```typescript -const tokenClassId: string = TransactionHelper.constructTokenId( - nextAliasOutput.aliasId, - foundryOutput.serialNumber, - foundryOutput.tokenScheme.type, -); -``` - -If you use this tutorial’s Alias ID, you should obtain the following token class ID: - -`0x080e6284ef54774f66942ef48f0c98c6da6e5b4e3ed044e83bd8da43f5b01790cb0100000000`. - -That token class ID is simply the Foundry ID that will remain immutable regardless of the state changes of your Foundry. - -## Define the Basic Output That Will Hold the Initial Batch of Minted Tokens - -As the Foundry has an initial set of minted tokens, you will need a [Basic Output](/introduction/stardust/explanations/ledger/simple_transfers) to hold those native tokens. This new Basic Output will hold the initial amount of minted native tokens identified through their token class ID. As with other Outputs, you need to set the amount of protocol-defined tokens to `0` as you don't know yet the storage deposit cost. - -```typescript -const nativeTokenOwnerAddress = '0x647f....'; - -const tokenFundsOutput: IBasicOutput = { - type: BASIC_OUTPUT_TYPE, - amount: '0', // Not known yet - nativeTokens: [ - // We put all minted tokens in this output - { - id: tokenClassId, - amount: HexHelper.fromBigInt256(bigInt(mintedAmount)), - }, - ], - unlockConditions: [ - { - type: ADDRESS_UNLOCK_CONDITION_TYPE, - address: { - type: ED25519_ADDRESS_TYPE, - pubKeyHash: nativeTokenOwnerAddress, - }, - }, - ], -}; -``` - -## Calculate and Set the Storage Deposits - -Next, you should calculate the storage deposit that will be needed for each Output. A helper function provided by `iota.js` will allow you to determine the exact number of protocol-defined tokens needed for each Output. This helper function needs the protocol parameters to be exposed by the Node, using the [`client.info()` function](../../references/client/interfaces/IClient.md#info). - -The next Alias Output of the Alias Address will hold fewer funds than the original, as those funds will be used to cover the storage deposits of the Foundry Output and the Basic Output that will hold the minted native token funds. - -```typescript -const nodeInfo = await client.info(); - -const foundryStorageDeposit = TransactionHelper.getStorageDeposit( - foundryOutput, - nodeInfo.protocol.rentStructure, -); -const tokenFundsStorageDeposit = TransactionHelper.getStorageDeposit( - tokenFundsOutput, - nodeInfo.protocol.rentStructure, -); - -const totalStorageFunds = bigInt(foundryStorageDeposit).plus( - bigInt(tokenFundsStorageDeposit), -); - -const initialFunds = bigInt(initialAliasOutput.amount); -if (initialFunds.lesser(totalStorageFunds)) { - throw new Error('Initial funds not enough to cover for storage deposits'); -} - -nextAliasOutput.amount = initialFunds.minus(totalStorageFunds).toString(); -foundryOutput.amount = foundryStorageDeposit.toString(); -tokenFundsOutput.amount = tokenFundsStorageDeposit.toString(); -``` - -## Submit the Transaction - -### Create the Transaction Essence - -This is a complex transaction that involves one input and three different outputs. The input is the Alias Output you obtained through your initial query to the indexer plugin. The Outputs are: - -- The next Alias Output of your Alias Address (`nextAliasOutput`). -- The initial Foundry Output (`foundryOutput`). -- The Basic Output that holds the native token funds initially minted (`tokenFundsOutput`). - -```typescript -const inputs: IUTXOInput[] = []; -const outputs: (IAliasOutput | IFoundryOutput | IBasicOutput)[] = []; - -inputs.push(TransactionHelper.inputFromOutputId(consumedOutputId)); -outputs.push(nextAliasOutput); -outputs.push(foundryOutput); -outputs.push(tokenFundsOutput); - -const inputsCommitment = TransactionHelper.getInputsCommitment([ - initialAliasOutput, -]); -const transactionEssence: ITransactionEssence = { - type: TRANSACTION_ESSENCE_TYPE, - networkId: TransactionHelper.networkIdFromNetworkName( - nodeInfo.protocol.networkName, - ), - inputs, - inputsCommitment, - outputs, -}; - -const wsTsxEssence = new WriteStream(); -serializeTransactionEssence(wsTsxEssence, transactionEssence); -const essenceFinal = wsTsxEssence.finalBytes(); -const essenceHash = Blake2b.sum256(essenceFinal); -``` - -### Provide the Transaction Signature - -Once you have the [created the transaction essence](#create-the-transaction-essence), you need to provide the signature that unlocks your [initial Alias Output](#obtain-the-current-alias-output), the Input of the transaction. Remember that unlocking an Alias Output requires the Private Key of the State Controller Address. - -```typescript -const stateControllerPubKey = '0x55419...'; -const stateControllerPrivateKey = '0xa060f....'; - -const unlockSignature: ISignatureUnlock = { - type: SIGNATURE_UNLOCK_TYPE, - signature: { - type: ED25519_SIGNATURE_TYPE, - publicKey: stateControllerPubKey, - signature: Converter.bytesToHex( - Ed25519.sign( - Converter.hexToBytes(stateControllerPrivateKey), - essenceHash, - ), - true, - ), - }, -}; - -const transactionPayload: ITransactionPayload = { - type: TRANSACTION_PAYLOAD_TYPE, - essence: transactionEssence, - unlocks: [unlockCondition], -}; -``` - -### Submit the Block - -Now that you have the transaction payload, you can submit the [Block](../../references/client/interfaces/IBlock.md): - -```typescript -const block: IBlock = { - protocolVersion: DEFAULT_PROTOCOL_VERSION, - parents: [], - payload: transactionPayload, - nonce: '0', -}; - -const blockId = await client.blockSubmit(block); -console.log('Block ID:', blockId); -console.log('Native Token Class ID', tokenClassId); -``` - -Once you know the Block ID and the Native Token Class ID, you can query them through the [Shimmer Explorer](https://explorer.shimmer.network/) to verify that your transaction went well and the Foundry Output has been added to the Ledger. - -## Putting It All Together - -You can download the code to mint a native token from the [iota.js repository](https://github.com/iotaledger/iota.js/tree/feat/stardust/packages/iota/examples/shimmer-native-token-transaction-tutorial/src/mint-tokens.ts). diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/native-token-transactions/04-native-tokens-transaction.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/native-token-transactions/04-native-tokens-transaction.md deleted file mode 100644 index d5c494e8b70..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/native-token-transactions/04-native-tokens-transaction.md +++ /dev/null @@ -1,336 +0,0 @@ ---- -description: 'Send native tokens with iota.js.' -image: /img/client_banner.png -keywords: - - tutorial - - native tokens - - token - - digital - - asset - - output - - transaction ---- - -# Send Native Tokens - -Outputs that hold native tokens can be spent within transactions to transfer some of their native tokens to a new Output. As usual, if there are remaining native tokens, you need to put them into a new Output controlled by your source address. In principle, there is no need to involve protocol-defined tokens (`SMR`) in this kind of transaction. However, you need to take into account that there are additional storage costs corresponding to the new Outputs you generate. For instance, if you use the [Output you created in the previous step of this tutorial](03-mint-native-tokens.md#define the-basic-output-that-will-hold-the-initial-batch-of-minted-tokens -) as Input, that Output only has funds to cover its own storage costs. In this case, you will need to find a second unspent Output that will fund the storage costs of the new Outputs. To cover storage costs in this particular case, you can define a transaction with two Inputs and three Outputs as follows: - -- **Input #1**: Corresponds to the UTXO holding the native tokens minted in step 1 of this tutorial. Remember that it also holds some `SMR` tokens that cover its own storage costs. -- **Input #2**: A UTXO that holds enough funds to cover the storage costs of **Output #1** and **Output #3** (see below). - -- **Output #1**: The Output holding some of the native tokens transferred from **Input #1**. This Output also holds enough `SMR` tokens to cover its own storage costs. -- **Output #2**: The Output holding the remaining native tokens from **Input #1** that were not transferred to **Output #1**. This Output will also keep the `SMR` tokens from **Input #1** to cover its storage costs. -- **Output #3**: The Output holding the remaining `SMR` from **Input #2**. It must at least cover its own storage costs. - -## Preparation - -To perform this transaction, you will need: - -- A Shimmer Node. You can use the [Shimmer testnet nodes](https://api.testnet.shimmer.network). - -- The address that controls **Output #1**, `0x647f7...`, the source address. - -- The keys of said address that allow unlocking its Outputs. - -- The source address must also control at least another UTXO with enough funds to cover the storage costs of the new Outputs created by this transaction. - -```typescript -const client = new SingleNodeClient(API_ENDPOINT, { - powProvider: new NeonPowProvider(), -}); -const nodeInfo = await client.info(); - -// The source address that controls an output with native tokens -const sourceAddress = '0x647f7...'; -const sourceAddressBech32 = 'rms1qpj8775lm...'; -const sourceAddressPublicKey = '0x554....'; -const sourceAddressPrivateKey = '0xa060ff...'; - -// The address that will receive the native tokens in a new Output -const destAddress = '0xc8413...'; -``` - -## Query Native Tokens Output to be Spent - -The first thing you need to do is to find the Basic Output that holds the native tokens. The easiest way to do it is through a query to the [indexation plugin](/hornet/2.0/inx-plugins/indexer/api_reference), as shown below. You will need to obtain the full Output details, as you will need to use it as Input for your following transaction. - -```typescript -const indexerPlugin = new IndexerPluginClient(client); -const outputList = await indexerPlugin.basicOutputs({ - addressBech32: sourceAddressBech32, - hasNativeTokens: true, -}); - -if (outputList.items.length === 0) { - throw new Error('No output with native tokens found on the source address'); -} - -const consumedOutputNativeTokensID = outputList.items[0]; -const consumedOutputNativeTokensDetails = await client.output( - consumedOutputNativeTokensID, -); -const theOutput = consumedOutputNativeTokensDetails.output as IBasicOutput; - -if (!Array.isArray(theOutput.nativeTokens)) { - throw new Error('No native tokens to spend'); -} - -// 12 native tokens will be transferred -const nativeAmountTransferred = bigInt(12); - -const currentNativeAmount = HexHelper.toBigInt256( - theOutput.nativeTokens[0].amount, -); -const remainingNativeAmount = currentNativeAmount.minus( - nativeAmountTransferred, -); - -if (remainingNativeAmount.lesser(bigInt(0))) { - throw new Error('Not enough funds'); -} - -inputs.push(TransactionHelper.inputFromOutputId(consumedOutputNativeTokensID)); -``` - -The query made to the indexation plugin includes the filter parameter `hasNativeTokens` so that you can easily find the Basic Output you are looking for in this case. In this tutorial, the Output holds at least `12` native tokens. Please take into account that in a real-world case, you would also need to ensure that the Output holds tokens of the class ID you are expecting. - -At the end of this step, you know **Input #1**. - -## Define the New Native Tokens Output - -The next step is to define **Output #1** that will hold the `12` native tokens as shown below: - -```typescript -const nativeTokensOutput: IBasicOutput = { - type: BASIC_OUTPUT_TYPE, - // We don't know yet - amount: '0', - nativeTokens: [ - { - id: theOutput.nativeTokens[0].id, - amount: HexHelper.fromBigInt256(nativeAmountTransferred), - }, - ], - unlockConditions: [ - { - type: ADDRESS_UNLOCK_CONDITION_TYPE, - address: { - type: ED25519_ADDRESS_TYPE, - pubKeyHash: destAddress, - }, - }, - ], - features: [], -}; -``` - -As in previous examples, the `amount` field is initially set to `0` so that you can later assign it depending on the storage costs of this Output. The unlock conditions refer to the destination address that will control this Output. - -At the end of this step, you have defined **Output #1**. - -## Define the Output for the Remaining NativeTokens - -The remainder Output is defined in the following snippet. In this case, the amount of protocol-defined tokens is set to be exactly the same as the original Input, as that should cover the storage costs of this Output. In fact, it is similar to the original one; the only difference is the number of native tokens. The unlock conditions refer to the source address. - -```typescript -const remainderNativeTokensOutput: IBasicOutput = { - type: BASIC_OUTPUT_TYPE, - // Amount is the same as we are not spending any protocol-defined tokens - amount: theOutput.amount, - nativeTokens: [ - { - id: theOutput.nativeTokens[0].id, - amount: HexHelper.fromBigInt256(remainingNativeAmount), - }, - ], - unlockConditions: [ - { - type: ADDRESS_UNLOCK_CONDITION_TYPE, - address: { - type: ED25519_ADDRESS_TYPE, - pubKeyHash: sourceAddress, - }, - }, - ], - features: [], -}; -``` - -At the end of this step, you have defined **Output #2**. - -## Calculate the Storage Costs - -In this step, you need to calculate the storage costs of the new native tokens Output, **Output #3**. The purpose of this calculation is to know the minimal amount of `SMR` you need to use to cover the new Outputs you are going to generate. The storage cost corresponds to the previously defined `nativeTokensOutput`. However, to be on the safe side, you will need an Output that holds an amount of `SMR` that can also cover the remaining amount once the storage costs of `nativeTokensOutput` are covered. To do so, you can pre-define the Output that will hold the remaining amount so that it can be calculated as its an extra cost. As a result, you can calculate the minimum amount of `SMR` needed (`minimumNeeded`) for the target Output as shown bellow: - -```typescript -const nativeTokensOutputStorageDeposit = TransactionHelper.getStorageDeposit( - nativeTokensOutput, - nodeInfo.protocol.rentStructure, -); -nativeTokensOutput.amount = nativeTokensOutputStorageDeposit.toString(); - -// The remaining output remains in the origin address -const remainderStorageBasicOutput: IBasicOutput = { - type: BASIC_OUTPUT_TYPE, - // We don't know yet - amount: '0', - nativeTokens: [], - unlockConditions: [ - { - type: ADDRESS_UNLOCK_CONDITION_TYPE, - address: { - type: ED25519_ADDRESS_TYPE, - pubKeyHash: sourceAddress, - }, - }, - ], - features: [], -}; - -const remainderStorageDeposit = TransactionHelper.getStorageDeposit( - remainderStorageBasicOutput, - nodeInfo.protocol.rentStructure, -); - -const minimumNeeded = bigInt(nativeTokensOutputStorageDeposit).plus( - bigInt(remainderStorageDeposit), -); -``` - -At the end of this step, you have defined **Output #3** and you know the storage costs. - -## Find an Output That Can Cover Storage Costs - -Once you know the storage costs, the problem is simply finding a suitable target Output from the Outputs your source address is controlling, as shown in the snippet below. The indexer plugin is used to find the unspent Basic Outputs that can fit your purpose. The `hasNativeTokens` filter condition is set to `false` to avoid conflicts with **Input #1**. Once you have a list of potential Outputs, the first that has the minimal amount of `SMR` you need will be used. **Please take into account that the edge case of obtaining an Output of the exact amount is not covered in this script**. - -```typescript -const outputList2 = await indexerPlugin.basicOutputs({ - addressBech32: sourceAddressBech32, - hasNativeTokens: false, -}); - -if (outputList2.items.length === 0) { - throw new Error('There are no outputs that can cover the storage cost'); -} - -let storageCostsOutput: IBasicOutput | undefined = undefined; -let storageCostsOutputID: string | undefined = undefined; -for (const output of outputList2.items) { - const outputData = await client.output(output); - const outputAmount = bigInt(outputData.output.amount); - // We are not treating the case where the output amount is equal to the storage cost - if (outputAmount.greater(minimumNeeded)) { - storageCostsOutput = outputData.output as IBasicOutput; - storageCostsOutputID = output; - break; - } -} - -if (!storageCostsOutput) { - throw new Error('There are no outputs that can cover the storage cost'); -} - -console.log('Output used to cover the storage costs: ', storageCostsOutputID); -``` - -The Output obtained from this step becomes **Input #2** of our transaction. - -## Define the Transaction Essence - -In this step, you will create the transaction essence. Before that, you will need to calculate and set the remaining amount. It will be equal to the original amount held by **Input #2** minus the storage cost of the native token Output (**Output #1**). As per the previous calculations, you know beforehand that the remaining amount will suffice to cover the storage costs of **Output #3**. - -```typescript -const remainderAmount = bigInt(storageCostsOutput.amount).minus( - bigInt(nativeTokensOutputStorageDeposit), -); -remainderStorageBasicOutput.amount = remainderAmount.toString(); - -inputs.push( - TransactionHelper.inputFromOutputId(storageCostsOutputID as string), -); - -outputs.push(nativeTokensOutput); -outputs.push(remainderNativeTokensOutput); -outputs.push(remainderStorageBasicOutput); - -const inputsCommitment = TransactionHelper.getInputsCommitment([ - consumedOutputNativeTokensDetails.output, - storageCostsOutput, -]); - -const transactionEssence: ITransactionEssence = { - type: TRANSACTION_ESSENCE_TYPE, - networkId: TransactionHelper.networkIdFromNetworkName( - nodeInfo.protocol.networkName, - ), - inputs, - inputsCommitment, - outputs, -}; - -const wsTsxEssence = new WriteStream(); -serializeTransactionEssence(wsTsxEssence, transactionEssence); -const essenceFinal = wsTsxEssence.finalBytes(); -const essenceHash = Blake2b.sum256(essenceFinal); -``` - -At the end of this step, you have created the transaction essence. It includes two Inputs : - -- **Input #1**: `consumedOutputNativeTokensID`, the source of the transferred native tokens. -- **Input #2**: `storageCostsOutputID` which pays the storage costs. - -And three Outputs: - -- **Output #1**: `nativeTokensOutput`, the destination of some of the native tokens. -- **Output #2**: `remainderNativeTokensOutput`, the remainder native tokens. -- **Output #3**: `remainderStorageBasicOutput`, the remainder of the storage costs. - -## Provide the Transaction’s Unlock Signature - -As two Inputs are being involved in this transaction, you will need to provide two unlocks. But, since the two Inputs are controlled by the same address, the second one is just a reference to the first one as shown bellow: - -```typescript -const unlockSignature: ISignatureUnlock = { - type: SIGNATURE_UNLOCK_TYPE, - signature: { - type: ED25519_SIGNATURE_TYPE, - publicKey: sourceAddressPublicKey, - signature: Converter.bytesToHex( - Ed25519.sign(Converter.hexToBytes(sourceAddressPrivateKey), essenceHash), - true, - ), - }, -}; - -const unlockRef: IReferenceUnlock = { - type: REFERENCE_UNLOCK_TYPE, - reference: 0, -}; - -const transactionPayload: ITransactionPayload = { - type: TRANSACTION_PAYLOAD_TYPE, - essence: transactionEssence, - unlocks: [unlockSignature, unlockRef], -}; -``` - -## Submit the Block - -Finally, you have to submit a Block. After the block is confirmed, you can query the [Shimmer Explorer](https://explorer.shimmer.network/) to see the state of the different addresses and Outputs involved in this tutorial. - -```typescript -const block: IBlock = { - protocolVersion: DEFAULT_PROTOCOL_VERSION, - parents: [], - payload: transactionPayload, - nonce: '0', -}; - -const blockId = await client.blockSubmit(block); -console.log('Block Id:', blockId); -``` - -## Putting It All Together - -You can download the code to send native tokens from the [iota.js repository](https://github.com/iotaledger/iota.js/tree/feat/stardust/packages/iota/examples/shimmer-native-token-transaction-tutorial/src/native-tokens-transaction.ts). diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/native-token-transactions/05-melt-native-tokens.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/native-token-transactions/05-melt-native-tokens.md deleted file mode 100644 index 5ddb6c9d5c2..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/native-token-transactions/05-melt-native-tokens.md +++ /dev/null @@ -1,329 +0,0 @@ ---- -description: 'Melt native tokens with iota.js.' -image: /img/client_banner.png -keywords: - - tutorial - - alias - - address - - output - - melt - - foundry - - native tokens - - token - - digital - - asset ---- - -# Melting Native Tokens - -This section in the tutorial will show you how to transition an existing Foundry Output to a new state. Specifically, how to melt the tokens that were transferred to an Output where you [sent your native tokens](04-native-tokens-transaction.md). - -This transaction will involve three Inputs and three Outputs: - -- **Input #1**: The unspent Output of the Alias Address that controls your Foundry, created when you [minted your native tokens](03-mint-native-tokens.md#prepare-the-alias-address). -- **Input #2**: The Foundry Output you created when you [minted your native tokens](03-mint-native-tokens.md#define-the-foundry-output), controlled by your [Alias Address](](03-mint-native-tokens.md#prepare-the-alias-address) and corresponds to the serial number `1`. -- **Input #3**: The UTXO created in [when you sent native tokens](04-native-tokens-transaction.md#define-the-new-native-tokens-output) that holds `12` native tokens that you are going to melt by issuing this transaction. - -- **Output #1**: The next Alias Output that captures the state of your Alias Address. -- **Output #2**: The next Foundry Output that captures the next state of your Foundry. It declares the melted tokens after transaction confirmation. -- **Output #3**: The same as **Input #3** but without any native tokens, as you will have melted them. - -## Preparation - -To perform the transaction that will melt the native tokens, you will need: - -- A Shimmer Node. You can use the [Shimmer Testnet nodes](https://api.testnet.shimmer.network). - -- The Alias ID of your Alias, in hexadecimal format `0x6dd4...`. - -- The keys of the State Controller of your Alias. - -- The address (and keys) that holds the native tokens to be melted `rms1qryyzvm...`. - -```typescript -const aliasId = process.argv[2]; -if (!aliasId) { - console.error('Please provide your Alias Id'); - process.exit(-1); -} - -const client = new SingleNodeClient(API_ENDPOINT, { - powProvider: new NeonPowProvider(), -}); -const nodeInfo = await client.info(); -const protocolInfo = nodeInfo.protocol; - -const stateControllerAddress = '0x647f...'; -const stateControllerPubKey = '0x55419...'; -const stateControllerPrivateKey = '0xa060f...'; - -const nativeTokenOwnerAddress = '0xc8413...'; -const nativeTokenOwnerAddressBech32 = 'rms1qryyzvmx...'; -const nativeTokenOwnerPubKey = '0xa5e76a...'; -const nativeTokenOwnerPrivateKey = '0xc4e210...'; -``` - -## Set the New State of Your Alias Address - -In this step, you need to transition the Alias Address to a new state, as one of its bound elements, the Foundry, is changing its state. - -### Query for the Alias Output - -First, you need to find the unspent Alias Output of your Alias Address through a query to the [indexing plugin](/hornet/2.0/inx-plugins/indexer/api_reference) using the Alias ID. You need to obtain the full Output details, as you will need to use it as Input for your transaction. - -```typescript -const indexerPlugin = new IndexerPluginClient(client); -const outputList = await indexerPlugin.alias(aliasId); -const consumedOutputID = outputList.items[0]; -console.log('Consumed Output Id', consumedOutputID); - -const initialAliasOutputDetails = await client.output(consumedOutputID); -const initialAliasOutput: IAliasOutput = - initialAliasOutputDetails.output as IAliasOutput; -``` - -### Assign the New State of the Alias - -To continue, you can create the next Alias Output by cloning the one obtained in the [previous step](#query-for-the-alias-output), and then increment the `stateIndex`. - -```typescript -const nextAliasOutput: IAliasOutput = JSON.parse( - JSON.stringify(initialAliasOutput), -); -nextAliasOutput.stateIndex++; -``` - -At the end of this step, you know both **Input #1** and **Output #1**. - -## Set the New State of Your Foundry - -In this step, you need to transition your Foundry to a new state, as some tokens will be put in **melted** state. - -### Query for the Foundry Output - -First, you need to find the unspent Foundry Output to transition by sending a query to the indexing plugin using the Alias Address. You need to obtain the full Output details as you will need to use it as Input for your transaction. - -```typescript -const aliasIdBech32 = Bech32Helper.toBech32( - ALIAS_ADDRESS_TYPE, - Converter.hexToBytes(aliasId), - protocolInfo.bech32Hrp, -); -const foundryList = await indexerPlugin.foundries({ - aliasAddressBech32: aliasIdBech32, -}); -if (foundryList.items.length === 0) { - throw new Error('Foundry Output not found'); -} - -const foundryOutputID = foundryList.items[0]; - -const initialFoundryOutputDetails = await client.output(foundryOutputID); -const initialFoundryOutput: IFoundryOutput = - initialFoundryOutputDetails.output as IFoundryOutput; -``` - -Keep in mind that you will need to use the `Bech32Helper.toBech32(bech32Text, humanReadablePart)`(references/client/classes/Bech32Helper#frombech32) function to convert your Alias ID to a Bech32 address to match the format of the parameter expected by the indexing plugin. - -At the end of this step, you know **Input #2**. - -### Query for the Native Tokens Output - -As you are going to melt all the tokens of your formerly created Output, you need to perform a query to obtain its ID and the number of native tokens involved. You will also use this Output as **Input #3** of the transaction. - -```typescript -const tokenClassId: string = TransactionHelper.constructTokenId( - initialAliasOutput.aliasId, - initialFoundryOutput.serialNumber, - initialFoundryOutput.tokenScheme.type, -); - -const outputWithTokensToMeltList = await indexerPlugin.basicOutputs({ - addressBech32: nativeTokenOwnerAddressBech32, - hasNativeTokens: true, -}); - -if (outputWithTokensToMeltList.items.length === 0) { - throw new Error('There are no outputs with native tokens'); -} - -// We assume the first one is the right one -const outputWithTokensToMeltID = outputWithTokensToMeltList.items[0]; -const outputWithTokensToMeltDetails = await client.output( - outputWithTokensToMeltID, -); -const outputWithTokensToMelt = - outputWithTokensToMeltDetails.output as IBasicOutput; - -if ( - !outputWithTokensToMelt.nativeTokens?.some( - (element) => element.id === tokenClassId, - ) -) { - throw new Error('Unexpected token class Id'); -} -``` - -The `some` function check that the Output actually holds native tokens of the expected class ID. - -At the end of this step, you know **Input #3**. - -### Set the Amount of Melted Tokens on the Foundry - -Once you know how many tokens you are going to melt, you just need to set the `meltedTokens` field of the next Foundry Output. - -As an Output can hold tokens of many classes at the same time, you should use the `findIndex` function to ensure you are referring to the right token class. In this simple case, you can check that `index` is equal to `0`. - -```typescript -const index = outputWithTokensToMelt.nativeTokens?.findIndex( - (element) => element.id === tokenClassId, -); - -nextFoundryOutput.tokenScheme.meltedTokens = - outputWithTokensToMelt.nativeTokens[index].amount; -``` - -At the end of this step, you know **Output #2**. - -## Create the Remainder Output - -In this step, you must create the remainder Output. The remainder Output will be the same as **Input #3** except for the native tokens of `tokenClassId` that are removed from the Output. - -```typescript -const remainderOutput = JSON.parse( - JSON.stringify(outputWithTokensToMelt), -) as IBasicOutput; - -// No longer have native tokens (assumption: there is only one entry of native tokens of tokenClassId) -remainderOutput.nativeTokens = remainderOutput.nativeTokens?.filter( - (element) => { - element.id !== tokenClassId; - }, -); -``` - -At the end of this step you know, **Output #3**. - -## Define the transaction - -### Define the Inputs and Outputs - -Now, you can create the transaction essence to melt your native tokens as shown in the following snippet: - -```typescript -const inputs: IUTXOInput[] = []; -const outputs: (IAliasOutput | IFoundryOutput | IBasicOutput)[] = []; - -inputs.push(TransactionHelper.inputFromOutputId(consumedOutputID)); -inputs.push(TransactionHelper.inputFromOutputId(foundryOutputID)); -inputs.push(TransactionHelper.inputFromOutputId(outputWithTokensToMeltID)); - -outputs.push(nextAliasOutput); -outputs.push(nextFoundryOutput); -outputs.push(remainderOutput); - -const inputsCommitment = TransactionHelper.getInputsCommitment([ - initialAliasOutput, - initialFoundryOutput, - outputWithTokensToMelt, -]); - -const transactionEssence: ITransactionEssence = { - type: TRANSACTION_ESSENCE_TYPE, - networkId: TransactionHelper.networkIdFromNetworkName( - protocolInfo.networkName, - ), - inputs, - inputsCommitment, - outputs, -}; -``` - -At the end of this step, you have defined the transaction essence. It includes three Inputs: - -- **Input #1**: From `consumedOutputID`, the unspent Alias Output of the Alias Address. -- **Input #2**: From `foundryOutputID`, the unspent Foundry Output owned by the Alias Address. -- **Input #3**: From `outputWithTokensToMeltID`, the Basic Output holding native tokens. - -And three Outputs: - -- **Output #1**: `nextAliasOutput`, the next Alias Output of the Alias Address. -- **Output #2**: `nextFoundryOutput`, the next Foundry Output, now declaring melted tokens. -- **Output #3**: `remainderOutput`, the remainder of the Basic Output with no native tokens of `tokenClassID`. - -## Provide the Unlocks - -In this case, you need to provide three unlocks:: - -- The State Controller unlock signature for the Alias Output. -- The reference to the former to unlock the Foundry Output. Remember that the Alias controls the Foundry. -- The unlock signature of the controller of the address that holds the native tokens melted. - -```typescript -const wsTsxEssence = new WriteStream(); -serializeTransactionEssence(wsTsxEssence, transactionEssence); -const essenceFinal = wsTsxEssence.finalBytes(); - -const essenceHash = Blake2b.sum256(essenceFinal); - -const unlockSignature: ISignatureUnlock = { - type: SIGNATURE_UNLOCK_TYPE, - signature: { - type: ED25519_SIGNATURE_TYPE, - publicKey: stateControllerPubKey, - signature: Converter.bytesToHex( - Ed25519.sign( - Converter.hexToBytes(stateControllerPrivateKey), - essenceHash, - ), - true, - ), - }, -}; - -const unlockFoundry: IAliasUnlock = { - type: ALIAS_UNLOCK_TYPE, - reference: 0, -}; - -const unlockTokens: ISignatureUnlock = { - type: SIGNATURE_UNLOCK_TYPE, - signature: { - type: ED25519_SIGNATURE_TYPE, - publicKey: nativeTokenOwnerPubKey, - signature: Converter.bytesToHex( - Ed25519.sign( - Converter.hexToBytes(nativeTokenOwnerPrivateKey), - essenceHash, - ), - true, - ), - }, -}; - -const transactionPayload: ITransactionPayload = { - type: TRANSACTION_PAYLOAD_TYPE, - essence: transactionEssence, - unlocks: [unlockSignature, unlockFoundry, unlockTokens], -}; -``` - -## Submit the blockB - -And finally, you can submit the block. After the block is confirmed, you can query the [Shimmer Explorer](https://explorer.shimmer.network/) for your Alias Address and find the new Alias Output with the updated state. - -```typescript -const block: IBlock = { - protocolVersion: DEFAULT_PROTOCOL_VERSION, - parents: [], - payload: transactionPayload, - nonce: '0', -}; - -const blockId = await client.blockSubmit(block); -console.log('Block Id:', blockId); -``` - -## Putting It All Together - -You can download the code to melt native tokens from the [iota.js repository](https://github.com/iotaledger/iota.js/tree/feat/stardust/packages/iota/examples/shimmer-native-token-transaction-tutorial/src/melt-tokens.ts). diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/nft-transactions/01-introduction.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/nft-transactions/01-introduction.md deleted file mode 100644 index 6b6b59cc2bb..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/nft-transactions/01-introduction.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -description: "Get acquainted with the structure and functionality of transactions in IOTA's Stardust protocol in the -Shimmer network using iota.js primitives to issue transactions involving NFT Outputs." -image: /img/client_banner.png -keywords: - -- tutorial -- UTXO -- nft -- shimmer -- ledger -- outputs -- inputs -- digital -- assets -- fungible -- token ---- - -# Stardust for iota.js: NFT Transactions - -This tutorial will get you acquainted with the structure and functionality of [NFT Transactions](/learn/protocols/stardust/core-concepts/multi-asset-ledger#non-fungible-tokens-nfts) in -IOTA's [Stardust protocol](/introduction/welcome) in -the [Shimmer network](https://shimmer.network) using [iota.js](https://github.com/iotaledger/iota.js) primitives to -issue transactions that involve NFT Output. - -## Introduction - -Starting from [Chrysalis](/introduction/welcome), IOTA is -a [UTXO-based (Unspent Transaction Output)](/introduction/reference/details#unspent-transaction-output-utxo) -Ledger. Each UTXO, also known as **Output**, has an associated number of tokens that determines its value. -Thus, the permanent data on the ledger is composed of a set of records (_Outputs_) that can be unlocked by the owner of -its associated address, i.e., the one who knows the address' private key. - -There are different [output types](/tips/tips/TIP-0018#output-design). This tutorial series will only focus on -**NFT Outputs** known as [`INftOutput`](./../../references/client/interfaces/INftOutput.md). NFT Outputs are -generated by transactions that unlock and consume already existing Outputs. When a transaction consumes them, these -Outputs turn into Inputs and generate new Outputs, typically another NFT Output with the same NFT ID but in a different state. At pruning time, _consumed Outputs_ will be removed by Nodes. - -## Storage Costs and Deposits - -You need to take into account that NFT Output, as any other UTXOs, need to be stored by [Hornet Nodes](/hornet/welcome), so there is a [storage cost](/iota.js/tutorials/value-transactions/introduction#storage-costs-and-deposits). diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/nft-transactions/02-prepare-the-dev-env.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/nft-transactions/02-prepare-the-dev-env.md deleted file mode 100644 index a9a351be825..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/nft-transactions/02-prepare-the-dev-env.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -description: 'Prepare a development environment to run the NFT transactions with iota.js tutorial.' -image: /img/client_banner.png -keywords: - - tutorial - - Node.js 16 - - auxiliary library - - proof of work - - pow - - shimmer - - Testnet node ---- - -# Prepare Your Development Environment - -To run the code in this tutorial, you will need the following: - -- [Node.js 16](https://nodejs.org/en/blog/release/v16.16.0/). -- The [`@iota/iota.js`](https://www.npmjs.com/package/@iota/iota.js) library -- The `iota.js` auxiliary libraries: - - - [`@iota/crypto.js`](https://www.npmjs.com/package/@iota/crypto.js) - - [`@iota/util.js`](https://www.npmjs.com/package/@iota/util.js). - - [`@iota/pow-neon.js`](https://www.npmjs.com/package/@iota/pow-neon.js) to run Proof of Work (PoW). Alternatively, - you can spin up your own node to run the PoW remotely. - -- Access to a Stardust Node (Hornet 2.0.0). You can use the Shimmer Testnet Nodes - at [https://api.testnet.shimmer.network](https://api.testnet.shimmer.network). -- (Optional) A TypeScript compiler and related packages - -## (optional) Download the Code - -You -can [download the tutorials codebase](https://github.com/iotaledger/iota.js/tree/feat/stardust/packages/iota/examples/shimmer-alias-transaction-tutorial) -to follow while you read the next sections. - -:::warning Running Code Examples - -If you plan on using the provided code example, please read the article [How To Run Code Examples](../../how_tos/run_how_tos.mdx). - -::: - -:::warning Shimmer Addresses and Outputs - -The tutorial's codebase uses several predefined Shimmer addresses and outputs. If you use other addresses, you will need to update the code accordingly. Likewise, the tutorial codebase assumes a particular state of the addresses and outputs. Before executing the code, please ensure your addresses and outputs are in the expected state. - -::: - -### Available Commands - -#### Mint new NFT - -You can run the `mint-nft` script by running the following command from the example's directory: - -```bash -npm run mint-nft -``` - -#### NFT Transaction - -You can run the `nft-transaction` script by running the following command from the example's directory: - -```bash -npm run nft-transaction -``` - -### NFT Claim - -You can run the `claim-nft` script by running the following command from the example's directory: - -```bash -npm run claim-nft -``` - -## Create Your package.json File - -You can create your `package.json` file from the example below and place it in your projects base directory: - -```json -{ - "name": "tutorial-nft", - "type": "module", - "version": "1.0.0", - "scripts": { - "dist": "tsc", - "mint-nft": "node dist/mint-new-nft", - "nft-transaction": "node dist/nft-transaction", - "claim-nft": "node dist/claim-nft" - }, - "dependencies": { - "@iota/crypto.js": "2.0.0-rc.1", - "@iota/iota.js": "2.0.0-rc.2", - "@iota/util.js": "2.0.0-rc.1", - "@iota/pow-neon.js": "2.0.0-rc.2" - }, - "devDependencies": { - "typescript": "^4.4.3", - "@types/node": "18.7.23" - } -} -``` - -After you have created the `package.json` file, you can install all the necessary dependencies by running the following -command from the same directory: - -```bash -npm install -``` - -## Troubleshooting - -If you are getting any errors during the installation process, please make sure your system is -using [Node.js 16](https://nodejs.org/en/blog/release/v16.16.0/). You can check your node version by running the -following command: - -```bash -node -v -``` diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/nft-transactions/03-mint-new-nft.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/nft-transactions/03-mint-new-nft.md deleted file mode 100644 index 5172908d17a..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/nft-transactions/03-mint-new-nft.md +++ /dev/null @@ -1,280 +0,0 @@ ---- -description: 'Mint a new NFT with iota.js.' -image: /img/client_banner.png -keywords: - - tutorial - - NFT - - token - - asset - - digital - - non - - fungible - - output - - mint ---- - -# Mint a New NFT - -An [NFT](/learn/protocols/stardust/core-concepts/multi-asset-ledger#non-fungible-tokens-nfts) is a unique token on the ledger. Its owner -controls it through the private key of -an [address](/iota.rs/explanations/address_key_space/). An NFT has a unique ID assigned by the -Ledger, bound to an Output in the Ledger. An NFT has some immutable -features that cannot be changed through the lifetime of the NFT, namely the issuer of the NFT. Additionally, immutable -metadata links the NFT with a Digital Asset (image, video, etc.). The owner of the NFT can only change non-immutable -aspects of -the NFT by unlocking its unspent Output in a transaction and generating a -new Output (conserving the NFT ID). The owner can also use a transaction to transfer the NFT to another owner. As with -other types of Outputs, NFT Outputs must also cover -their [storage costs](/learn/protocols/stardust/core-concepts/storage-deposit) with -protocol-defined tokens (`SMR`). - -To mint an NFT, you will need the following: - -- A unspent [Basic Output](/tips/tips/TIP-0018#basic-output) that holds enough funds for - the minimal storage deposit needed for the NFT Output. In - the [Testnet](/build/networks-endpoints#public-testnet), you - can [request funds from the Faucet](/iota.js/tutorials/value-transactions/request-funds-from-the-faucet). - -- The key pair that corresponds to the Shimmer address that owns the former Output, as you need to unlock a certain - amount of funds to cover the storage deposit of the Output corresponding to the newly minted NFT. - -- The immutable metadata that will allow you to associate the NFT with a digital asset. For instance, you could store a - digital asset in a permissioned server. Upon proving ownership of the NFT, the server would grant access to the - associated digital asset. Remember the longer the metadata, the higher the storage deposit. - -```typescript -const consumedOutputId = '0xcb16...'; - -const sourceAddress = '0x62c0...'; - -const sourceAddressPublicKey = '0x91db...'; -const sourceAddressPrivateKey = '0x22f...'; - -const client = new SingleNodeClient(API_ENDPOINT, { - powProvider: new NeonPowProvider(), -}); -const info = await client.info(); -``` - -## Define the NFT Output - -The initial NFT Output needed to mint your NFT can be defined as follows: - -```typescript -const initialNftId = new Uint8Array(new ArrayBuffer(32)); - -const immutableData = { - standard: 'IRC27', - version: 'v1.0', - type: 'image/jpeg', - uri: 'https://nft-oceean.example.org/my-nft.jpeg', -}; - -const nftOutput: INftOutput = { - type: NFT_OUTPUT_TYPE, - amount: '0', - nftId: Converter.bytesToHex(initialNftId, true), - immutableFeatures: [ - { - type: ISSUER_FEATURE_TYPE, - address: { - type: ED25519_ADDRESS_TYPE, - pubKeyHash: sourceAddress, - }, - }, - { - type: METADATA_FEATURE_TYPE, - data: Converter.utf8ToHex(JSON.stringify(immutableData), true), - }, - ], - unlockConditions: [ - { - type: ADDRESS_UNLOCK_CONDITION_TYPE, - address: { - type: ED25519_ADDRESS_TYPE, - pubKeyHash: sourceAddress, - }, - }, - ], -}; - -const nftStorageCost = TransactionHelper.getStorageDeposit( - nftOutput, - nodeInfo.protocol.rentStructure, -); -const amountNeeded = bigInt(nftStorageCost).multiply(bigInt(2)); -nftOutput.amount = amountNeeded.toString(); -``` - -## Initialize the NFT - -The `nftId` is initialized as a hexadecimal string that represents `32` bytes set to `0`. By doing this, you tell the -request to mint a **new** NFT. The Output also includes two immutable features: -The `Issuer`. It must be equal to the owner of the Input of the transaction that will create the NFT -The `metadata`. This allows knowing information about the asset bound to the NFT. In this case, -the [IRC27 standard](/tips/tips/TIP-0027) is used to assert that the asset is an image -hosted at a particular URI. - -### Unlock Conditions - -The unlock conditions set that the `sourceAddress` is the one that owns this NFT. You will need to calculate the storage -costs of the NFT Output and assign it to the `amount` held by the Output. In this case, the code transferred double the -actual cost so that, if needed, the NFT Output can be expanded with extra metadata or unlock conditions. - -## Define the Transaction Essence - -The transaction involves an Input (the Output that holds at least enough funds to cover the storage deposit of -the new NFT) and two Outputs. The new NFT Output and another Basic Output with the remaining funds from the original -Input that you can only unlock with the original address that controls the funds. - -To calculate the remaining funds, you need to query the node to obtain the details of the consumed Output. - -```typescript -const inputs: IUTXOInput[] = []; -const outputs: (INftOutput | IBasicOutput)[] = []; - -inputs.push(TransactionHelper.inputFromOutputId(consumedOutputId)); - -const consumedOutputDetails = await client.output(consumedOutputId); -const totalFunds = bigInt(consumedOutputDetails.output.amount); - -const remainderBasicOutput: IBasicOutput = JSON.parse( - JSON.stringify(consumedOutput), -); - -const remainingFunds = bigInt(consumedOutput.amount).minus( - bigInt(nftOutput.amount), -); -remainderBasicOutput.amount = remainingFunds.toString(); - -outputs.push(nftOutput); -outputs.push(remainderBasicOutput); - -const inputsCommitment = TransactionHelper.getInputsCommitment([ - consumedOutput, -]); - -const transactionEssence: ITransactionEssence = { - type: TRANSACTION_ESSENCE_TYPE, - networkId: TransactionHelper.networkIdFromNetworkName( - nodeInfo.protocol.networkName, - ), - inputs, - inputsCommitment, - outputs, -}; -``` - -## Issue the Transaction - -Once the transaction essence is defined you can issue the transaction the same way as -with [value transaction](../value-transactions/08-transfer-funds.md#create-a-transaction-payload). You will need to sign the -essence with the keys of the address that controls the initial Output, which will provide funds for your NFT (the -storage deposit as a minimum). - -After submitting the corresponding block with the Block ID, you can check the resulting outputs in -the [Tangle Explorer](https://explorer.shimmer.network/testnet). - -```typescript -const essenceHash = - TransactionHelper.getTransactionEssenceHash(transactionEssence); - -const unlockCondition: ISignatureUnlock = { - type: SIGNATURE_UNLOCK_TYPE, - signature: { - type: ED25519_SIGNATURE_TYPE, - publicKey: sourceAddressPublicKey, - signature: Converter.bytesToHex( - Ed25519.sign(Converter.hexToBytes(sourceAddressPrivateKey), essenceHash), - true, - ), - }, -}; - -const transactionPayload: ITransactionPayload = { - type: TRANSACTION_PAYLOAD_TYPE, - essence: transactionEssence, - unlocks: [unlockCondition], -}; - -const block: IBlock = { - protocolVersion: DEFAULT_PROTOCOL_VERSION, - parents: [], - payload: transactionPayload, - nonce: '0', -}; - -console.log('Calculating PoW, submitting block...'); -const blockId = await client.blockSubmit(block); -console.log('Block Id:', blockId); -``` - -## Calculate the NFT ID - -It is important to understand that the new NFT ID is derived from the ID of the NFT Output. In turn, the ID of the NFT -Output is derived from the transaction ID. The transaction ID is a hash of the _transaction payload_. You can calculate it -using the function `computeTransactionIdFromTransactionPayload` as shown below. The Output ID is -calculated using the function `TransactionHelper.outputIdFromTransactionData`, and then the NFT ID is the Blake256 hash -of the Output Id. Afterward, you can calculate the Bech32 address corresponding to the NFT ID using -the [`Bech32Helper`](../../references/client/classes/Bech32Helper.md) and specifying that it is an `NFT_ADDRESS_TYPE`. - -Before querying the block, you can wait some seconds for confirmation and check through the `blockMetadata` -function that the Ledger included your block. - -```typescript -setTimeout(async () => { - const blockMetadata = await client.blockMetadata(blockId); - if (!blockMetadata.ledgerInclusionState) { - throw new Error('Block still pending confirmation'); - } - - if (blockMetadata.ledgerInclusionState === 'included') { - const transactionId = calculateTransactionId(transactionPayload); - const outputId = TransactionHelper.outputIdFromTransactionData( - transactionId, - 0, - ); - console.log('Output Id:', outputId); - const nftIdBytes = Blake2b.sum256(Converter.hexToBytes(outputID)); - const nftId = Converter.bytesToHex(nftIdBytes, true); - console.log('NFT ID:', nftId); - console.log( - 'NFT Address:', - Bech32Helper.toBech32( - NFT_ADDRESS_TYPE, - nftIdBytes, - nodeInfo.protocol.bech32Hrp, - ), - ); - } else if (blockMetadata.ledgerInclusionState === 'conflicting') { - throw new Error('Conflicting Block'); - } -}, 6000); - -function computeTransactionIdFromTransactionPayload( - payload: ITransactionPayload, -) { - const tpWriteStream = new WriteStream(); - serializeTransactionPayload(tpWriteStream, payload); - return Converter.bytesToHex(Blake2b.sum256(tpWriteStream.finalBytes()), true); -} -``` - -If you run the code above, you should get an output similar to: - -```text -Block Id: 0xfd8fdb766f6e55afc52c4828cb93510530b7efcd7bdd55aadf8b8a01d6505b59 -Output Id: 0xaced9bcc3b7b4ea5f55d19990de851dbe58676f2b3453a3a8bd780906154422e0000 -NFT ID: 0x601c1c6a67b25c453a2286f639a43f8a68aeb865bcc53632cb670e6afa2ad12a -NFT Address: rms1zpspc8r2v7e9c3f6y2r0vwdy879x3t4cvk7v2d3jednsu6h69tgj5y8mzdm -``` - -Remember that the NFT ID remains constant and known by every node regardless of the transactions (NFT Outputs -generated) issued. That means you can query, through the [Tangle Explorer](https://explorer.shimmer.network/testnet), -for instance, the current NFT Output of an -NFT by supplying the NFT ID or its representation as a Bech32 address. - -## Putting It All Together - -The complete source code of this part of the tutorial is available in -the [official iota.js GitHub repository](https://github.com/iotaledger/iota.js/blob/feat/stardust/packages/iota/examples/shimmer-nft-transaction-tutorial/src/mint-new-nft.ts). diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/nft-transactions/04-nft-transaction.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/nft-transactions/04-nft-transaction.md deleted file mode 100644 index d46bd93bf71..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/nft-transactions/04-nft-transaction.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -description: 'Update an NFT’s state using a transaction with iota.js.' -image: /img/client_banner.png -keywords: - - tutorial - - NFT - - output - - transaction ---- - -# Create an NFT Transaction - -The owner of an NFT can perform transactions that change the NFT’s mutable fields to a new state. The transaction -generates a new NFT Output with the same NFT ID as the original. Remember that the NFT ID remains constant regardless of -the NFT Output that holds the funds and the NFT metadata. The **NFT Output Id** changes once it is "spent" and pruned -from the ledger. - -This section will show you how to issue a transaction that will transfer the ownership of your NFT to a different -address. Since you probably want to recover the tokens you used to cover -the [storage deposits](/iota.js/tutorials/value-transactions/introduction#storage-costs-and-deposits), -this code example includes an -additional [storage deposit return](/learn/protocols/stardust/core-concepts/output-unlock-conditions#storage-deposit-return) [unlock condition](/learn/protocols/stardust/core-concepts/output-unlock-conditions) -to the NFT Output. - -## Preparation - -To create this transaction, you will need the following: - -- A Shimmer Node. You can use the [Shimmer Testnet nodes](https://api.testnet.shimmer.network). - -- The NFT ID of your NFT, in hexadecimal format `0x7d08...`. - -- The keys of the address that controls your NFT. - -```typescript -const client = new SingleNodeClient(API_ENDPOINT, { - powProvider: new NeonPowProvider(), -}); -const nodeInfo = await client.info(); - -const nftOwnerAddr = '0x62c0...'; -const nftOwnerPubKey = '0x91db...'; -const nftOwnerPrivateKey = '0x22f6...'; - -const nftBuyerAddr = '0x57d3...'; -``` - -## Query For the NFT Output - -You will first need to query for the NFT Output of your NFT. The easiest way to do so is through a query to -the [indexation plugin](/hornet/2.0/inx-plugins/indexer/api_reference) by NFT ID. You need to obtain the full -Output details as you need to use them as input for the transaction. - -```typescript -const indexerPlugin = new IndexerPluginClient(client); -const outputList = await indexerPlugin.nft(nftId); -if (outputList.items.length === 0) { - throw new Error('NFT not found'); -} -const consumedOutputId = outputList.items[0]; -console.log('Consumed Output Id', consumedOutputId); - -const initialNftOutputDetails = await client.output(consumedOutputId); -const initialNftOutput: INftOutput = - initialNftOutputDetails.output as INftOutput; -``` - -## Set the New Unlock Conditions - -Once you have [queried for the NFT output](#query-for-the-nft-output), you should create the new NFT Output by cloning -it, and then set the two new unlock conditions: - -1. The [address](/learn/protocols/stardust/core-concepts/output-unlock-conditions#address) - corresponding to the new owner of the NFT (for instance, the buyer of the NFT). -2. A [storage deposit unlock condition](/learn/protocols/stardust/core-concepts/output-unlock-conditions#storage-deposit-return) - that will allow you to get a refund of the storage costs of the NFT Output. That way, the `SMR` tokens you used to cover - the storage costs will be refunded whenever the new owner of the NFT decides to unlock it. - -## Define the Transaction - -### Add the Unlock Conditions - -Now, you are ready to define the transaction. You should assign the correct `nftId` to your new NFT Output. - -As you add more unlock conditions, the storage deposit of the NFT Output increases, but that will be covered with the -extra funds you supplied when you [minted the NFT](03-mint-new-nft.md). Remember that the amount was double the minimum -one. - -```typescript -const nextNftOutput: INftOutput = JSON.parse(JSON.stringify(initialNftOutput)); -nextNftOutput.unlockConditions = [ - { - type: ADDRESS_UNLOCK_CONDITION_TYPE, - address: { - type: ED25519_ADDRESS_TYPE, - pubKeyHash: nftBuyerAddr, - }, - }, - { - type: STORAGE_DEPOSIT_RETURN_UNLOCK_CONDITION_TYPE, - amount: nextNftOutput.amount, - returnAddress: { - type: ED25519_ADDRESS_TYPE, - pubKeyHash: nftOwnerAddr, - }, - }, -]; - -nextNftOutput.nftId = nftId; -``` - -### Define the Transaction Essence - -The transaction takes the original NFT Output as Input and generates a **new NFT Output** with the new state that **will -still keep the original NFT ID**. - -```typescript -const inputs: IUTXOInput[] = []; -const outputs: INftOutput[] = []; - -inputs.push(TransactionHelper.inputFromOutputId(consumedOutputId)); -outputs.push(nextNftOutput); - -const inputsCommitment = TransactionHelper.getInputsCommitment([ - initialNftOutput, -]); - -const transactionEssence: ITransactionEssence = { - type: TRANSACTION_ESSENCE_TYPE, - networkId: TransactionHelper.networkIdFromNetworkName( - nodeInfo.protocol.networkName, - ), - inputs, - inputsCommitment, - outputs, -}; -``` - -### Add the Unlock Conditions to the New NFT Output - -The unlock you need to provide correspond to the signature calculated against the transaction essence using the private -key of the original owner address. - -```typescript -const essenceHash = - TransactionHelper.getTransactionEssenceHash(transactionEssence); - -const unlockCondition: ISignatureUnlock = { - type: SIGNATURE_UNLOCK_TYPE, - signature: { - type: ED25519_SIGNATURE_TYPE, - publicKey: nftOwnerPubKey, - signature: Converter.bytesToHex( - Ed25519.sign(Converter.hexToBytes(nftOwnerPrivateKey), essenceHash), - true, - ), - }, -}; - -const transactionPayload: ITransactionPayload = { - type: TRANSACTION_PAYLOAD_TYPE, - essence: transactionEssence, - unlocks: [unlockCondition], -}; -``` - -## Submit the Block - -Finally, you should submit the block. After the block is confirmed, if you query your NFT ID -through [the Shimmer Explorer](https://explorer.shimmer.network/shimmer), you will find the new NFT Output with the -updated state. - -```typescript -const block: IBlock = { - protocolVersion: DEFAULT_PROTOCOL_VERSION, - parents: [], - payload: transactionPayload, - nonce: '0', -}; - -const blockId = await client.blockSubmit(block); -console.log('Block Id:', blockId); -``` - -## Putting It All Together - -The complete source code of this part of the tutorial is available in -the [official iota.js GitHub repository](https://github.com/iotaledger/iota.js/blob/feat/stardust/packages/iota/examples/shimmer-nft-transaction-tutorial/src/nft-transaction.ts). diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/nft-transactions/05-claim-nft.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/nft-transactions/05-claim-nft.md deleted file mode 100644 index 7f43e13d19e..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/nft-transactions/05-claim-nft.md +++ /dev/null @@ -1,337 +0,0 @@ ---- -description: 'Claim an NFT under conditional transfer with iota.js.' -image: /img/client_banner.png -keywords: - - tutorial - - nft - - output - - claim - - storage - - deposit - - conditional - - transfer - - refund ---- - -# Claim NFT Under Conditional Transfer - -In the previous section of this tutorial, you [transferred and NFT](./04-nft-transaction.md) to a new owner. However, -since you added -a [storage deposit return unlock condition](/learn/protocols/stardust/core-concepts/output-unlock-conditions#storage-deposit-return) -to the transfer, the new owner will need to create a new Output to return the deposit. - -This section will show you how to refund the issuer of the NFT and gain complete control over the NFT. To do so, you -will need to do the following: - -Issue a [new NFT transaction](./04-nft-transaction.md) that changes the unlock conditions so that the only remaining -condition is -the [address](/learn/protocols/stardust/core-concepts/output-unlock-conditions#address). - -Create an additional Input with enough funds to cover the storage deposit for the new NFT Output, -Generate an Output to refund the issuer. - -So, the transaction will include two Inputs: - -- **Input #1** The [NFT Input you minted](03-mint-new-nft.md). -- **Input #2** A Basic Input that holds enough funds to cover the storage deposit of the new NFT Output controlled by the - new NFT Owner. - -The transaction will also include three Outputs: - -- **Output #1** The new NFT Output, controlled by the new NFT Owner. -- **Output #2** The refund Output, controlled by the NFT Issuer. -- **Output #3** The Output holding the remaining funds after covering the storage costs of **Output #1** (controlled by the NFT - Owner). - -## Preparation - -To create this transaction, you will need the following: - -- A Shimmer Node. You can use the [Shimmer Testnet nodes](https://api.testnet.shimmer.network). - -- The NFT ID of your NFT, in hexadecimal format `0x7d08...`. - -- The keys of the address you [transferred your NFT to](./04-nft-transaction.md). - -- A UTXO controlled by the new owner of the NFT with enough funds to cover the new NFT Output storage costs. - -```typescript -const client = new SingleNodeClient(API_ENDPOINT, { - powProvider: new NeonPowProvider(), -}); -const nodeInfo = await client.info(); - -const nftOwnerAddr = '0x57d3...'; -const nftOwnerBech32Addr = 'rms1qpta...'; -const nftOwnerPubKey = '0xd38f...'; -const nftOwnerPrivateKey = '0xc2be...'; -``` - -## Query For the NFT Output - -You will first need to retrieve the NFT Output of your NFT from the network. The easiest way to do so is through a query -to the [indexation plugin](/hornet/2.0/inx-plugins/indexer/api_reference) by NFT ID. You need to obtain the full -Output details as you need to use them as Input for the transaction. - -```typescript -const indexerPlugin = new IndexerPluginClient(client); -const outputList = await indexerPlugin.nft(nftId); -if (outputList.items.length === 0) { - throw new Error('NFT not found'); -} - -const consumedOutputId = outputList.items[0]; -console.log('Consumed Output Id', consumedOutputId); - -const initialNftOutputDetails = await client.output(consumedOutputId); -const initialNftOutput: INftOutput = - initialNftOutputDetails.output as INftOutput; -``` - -At the end of this step you have obtained **Input #1** of your transaction. - -## Set the New Unlock Conditions - -You can create the new NFT Output by cloning the [one received from the node](#query-nft-output), removing -the [storage deposit return unlock condition](/learn/protocols/stardust/core-concepts/output-unlock-conditions#storage-deposit-return), -and only keep -the [address unlock condition](/learn/protocols/stardust/core-concepts/output-unlock-conditions#address). -That way, you will have full control of the NFT through your address keys. - -The `amount` field is set to `0`, so you can later calculate the minimum storage deposit needed for your new NFT Output. -Keep in mind that you should ensure that you assign the correct `nftId` to your new NFT Output, in this case the -original NFT ID. - -```typescript -const nextNftOutput: INftOutput = JSON.parse(JSON.stringify(initialNftOutput)); -nextNftOutput.unlockConditions =; - -const nextNftOutput: INftOutput = JSON.parse(JSON.stringify(initialNftOutput)); -nextNftOutput.unlockConditions = nextNftOutput.unlockConditions.filter( - (condition) => condition.type !== STORAGE_DEPOSIT_RETURN_UNLOCK_CONDITION_TYPE -); - -nextNftOutput.nftId = nftId; -nextNftOutput.amount = "0"; -``` - -At the end of this step you have defined **Output #1** of your transaction. - -## Refund the NFT Issuer - -In this step, you need to create a new Basic Output to refund the Issuer of the NFT so that you take full control over -it. **You don't need to use your own funds to refund the Issuer**. You only need to take the `SMR` deposited in the -original NFT Output and transfer it to an Output controlled by the Issuer. - -```typescript -const refundCondition = initialNftOutput - .unlockConditions[1] as IStorageDepositReturnUnlockCondition; - -const refundToBePerformed = bigInt(refundCondition.amount); - -const refundOutput: IBasicOutput = { - type: BASIC_OUTPUT_TYPE, - amount: refundToBePerformed.toString(), - unlockConditions: [ - { - type: ADDRESS_UNLOCK_CONDITION_TYPE, - address: { - type: ED25519_ADDRESS_TYPE, - pubKeyHash: (refundCondition.returnAddress as IEd25519Address) - .pubKeyHash, - }, - }, - ], -}; -``` - -At the end of this step you have defined **Output #2** of your transaction. - -## Calculate the NFT Storage Costs - -Once you have returned the original storage deposit, you will need to calculate the storage costs for your new NFT. This -way, you will have an estimation of the minimum amount of funds that should be held by a transaction Output covering -them. - -```typescript -const depositNft = bigInt( - TransactionHelper.getStorageDeposit( - nextNftOutput, - nodeInfo.protocol.rentStructure, - ), -); -nextNftOutput.amount = depositNft.toString(); -``` - -At the end of this step, you have set the right amounts to cover NFT storage deposits. - -## Cover Storage Deposits - -Once you have [calculated the storage deposit](#calculate-the-nft-storage-costs), you will need to find a Basic Output -owned by the new NFT owner that can cover the deposit. The minimal amount of funds is determined by the storage cost of -the NFT plus the storage costs of the Output holding the remainder funds. - -### Define the Remainder Output - -The remainder Output is just a Basic Output, as shown below: - -```typescript -const remainderOutput: IBasicOutput = { - type: BASIC_OUTPUT_TYPE, - amount: '0', - unlockConditions: [ - { - type: ADDRESS_UNLOCK_CONDITION_TYPE, - address: { - type: ED25519_ADDRESS_TYPE, - pubKeyHash: nftOwnerAddr, - }, - }, - ], -}; - -const remainderOutputCost = bigInt( - TransactionHelper.getStorageDeposit( - remainderOutput, - nodeInfo.protocol.rentStructure, - ), -); -const totalCost = depositNft.plus(remainderOutputCost); -``` - -At the end of this sub-step you know the total cost that should be covered by your Output at a minimum. - -### Find an Output With Enough Funds - -You can find the right Basic Output by querying -the [indexation plugin](/hornet/2.0/inx-plugins/indexer/api_reference). You should check that the Output has not -been spent yet. - -```typescript -const basicOutputList = await indexerPlugin.basicOutputs({ - addressBech32: nftOwnerBech32Addr, -}); - -let costsOutput: IBasicOutput | undefined; -let costsOutputId: string | undefined; -for (const basicOutput of basicOutputList.items) { - const theOutput = await client.output(basicOutput); - if (theOutput.metadata.isSpent === false) { - const output = theOutput.output as IBasicOutput; - const amount = bigInt(output.amount); - if (amount.greater(totalCost)) { - costsOutputId = basicOutput; - costsOutput = output; - break; - } - } -} - -if (!costsOutput) { - throw new Error('No Outputs found to refund and cover costs'); -} - -remainderOutput.amount = bigInt(costsOutput.amount) - .minus(depositNft) - .toString(); -``` - -At the end of this step you have defined **Output #3** of your transaction. - -## Define the Transaction - -The next thing you need to do is define the transaction essence, as shown bellow: - -```typescript -const inputs: IUTXOInput[] = []; -const outputs: (INftOutput | IBasicOutput)[] = []; - -inputs.push(TransactionHelper.inputFromOutputId(consumedOutputId)); -inputs.push(TransactionHelper.inputFromOutputId(costsOutputId as string)); - -outputs.push(nextNftOutput); -outputs.push(refundOutput); -outputs.push(remainderOutput); - -const inputsCommitment = TransactionHelper.getInputsCommitment([ - initialNftOutput, - costsOutput, -]); - -const transactionEssence: ITransactionEssence = { - type: TRANSACTION_ESSENCE_TYPE, - networkId: TransactionHelper.networkIdFromNetworkName( - nodeInfo.protocol.networkName, - ), - inputs, - inputsCommitment, - outputs, -}; -``` - -At the end of this step, you have created the transaction essence. It includes two Inputs : - -- **Input #1**: `consumedOutputId`, the last NFT unspent Output of your NFT. -- **Input #2**: `costsOutputId`, which pays the storage costs. - -And three Outputs: - -- **Output #1**: `nextNftOutput`, the next NFT Output of your NFT. -- **Output #2**: `refundOutput`, the refund made to the Issuer of your NFT. -- **Output #3**: `remainderOutput`, the remainder of the storage costs. - -## Unlock the Outputs - -The unlock condition you need to provide corresponds to the signature calculated against the transaction essence using -the private key of the NFT Owner. The same signature also unlocks the second Input. - -```typescript -const essenceHash = - TransactionHelper.getTransactionEssenceHash(transactionEssence); - -const unlockConditionNft: ISignatureUnlock = { - type: SIGNATURE_UNLOCK_TYPE, - signature: { - type: ED25519_SIGNATURE_TYPE, - publicKey: nftOwnerPubKey, - signature: Converter.bytesToHex( - Ed25519.sign(Converter.hexToBytes(nftOwnerPrivateKey), essenceHash), - true, - ), - }, -}; - -const unlockConditionCost: IReferenceUnlock = { - type: REFERENCE_UNLOCK_TYPE, - reference: 0, -}; - -const transactionPayload: ITransactionPayload = { - type: TRANSACTION_PAYLOAD_TYPE, - essence: transactionEssence, - unlocks: [unlockConditionNft, unlockConditionCost], -}; -``` - -## Submit the Block - -Finally, you should submit the block. After the block is confirmed, if you query your NFT ID -through [the Shimmer Explorer](https://explorer.shimmer.network/shimmer), you will find the new NFT Output with the -updated state. - -```typescript -const block: IBlock = { - protocolVersion: DEFAULT_PROTOCOL_VERSION, - parents: [], - payload: transactionPayload, - nonce: '0', -}; - -const blockId = await client.blockSubmit(block); -console.log('Block Id:', blockId); -``` - -## Putting It All Together - -The complete source code of this part of the tutorial is available in -the [official iota.js GitHub repository](https://github.com/iotaledger/iota.js/blob/feat/stardust/packages/iota/examples/shimmer-nft-transaction-tutorial/src/claim-nft.ts). diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/01-introduction.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/01-introduction.md deleted file mode 100644 index 667ac5f6864..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/01-introduction.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -description: "Get acquainted with the structure and functionality of transactions in IOTA's Stardust protocol in the -Shimmer network using iota.js primitives to issue value transactions." -image: /img/client_banner.png -keywords: - -- tutorial -- UTXO -- transactions -- shimmer -- ledger -- outputs -- inputs - ---- - -# Stardust for iota.js: Value Transactions - -This tutorial will get you acquainted with the structure and functionality of transactions in -IOTA's [Stardust protocol](/introduction/welcome) in -the [Shimmer network](https://shimmer.network) using [iota.js](https://github.com/iotaledger/iota.js) primitives to -issue value transactions. - -## Introduction - -Starting from [Chrysalis](/introduction/welcome), IOTA is -a [UTXO-based (Unspent Transaction Output)](/introduction/reference/details#unspent-transaction-output-utxo) -Ledger. Each UTXO, also known as **output**, has an associated number of tokens that determines its value. -Thus, the permanent data on the ledger is composed of a set of records (_outputs_) that can be unlocked by the owner of -its associated address, i.e., the one who knows the address' private key. - -There are different [output types](/tips/tips/TIP-0018#output-design). This tutorial series will only focus on -value outputs known as [`IBasicOutput`](./../../references/client/interfaces/IBasicOutput.md). Outputs are -generated by transactions that unlock and consume already existing outputs. When a transaction consumes them, these -outputs turn into inputs and generate new outputs. At pruning time, _consumed outputs_ will be removed by Nodes. -However, they might be stored permanently by Nodes that have enabled -the [INX Chronicle](/chronicle/welcome) plugin. -Each output in the Ledger has a unique identifier as it has each transaction that mutates the Ledger state by -manipulating other outputs. - -## Storage Costs and Deposits - -UTXOs need to be stored by [Hornet Nodes](/hornet/welcome), so there is a storage cost. -The Stardust protocol defines a parameter, named ["vByte cost"](../../references/client/interfaces/IRent.md#vbytecost), -that establishes the cost of storage of each "virtual byte" in _Glow_ (one Glow corresponds to 0.000001 Shimmer). -As each output consumes a number of vBytes in the Ledger, it is a necessary condition for an output -to cover the vByte cost with its value in the Ledger. This means that Nodes will reject transactions -whose outputs do not meet this condition. For instance, in the current Shimmer network, you cannot -send `1 Glow` to a new output because the [storage deposit cost](09-understanding-deposits.md) of such an output will be -higher. The size of a UTXO and its cost depends structurally on the type and any additional data it may carry. diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/02-prepare-the-dev-env.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/02-prepare-the-dev-env.md deleted file mode 100644 index 1c715e7906f..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/02-prepare-the-dev-env.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -description: 'Prepare a development environment to run the value transactions in iota.js tutorial.' -image: /img/client_banner.png -keywords: - - tutorial - - Node.js 16 - - auxiliary library - - proof of work - - pow - - shimmer - - testnet node ---- - -# Prepare Your Development Environment - -To run the code in this tutorial, you will need the following: - -- [Node.js 16](https://nodejs.org/en/blog/release/v16.16.0/). -- The [`@iota/iota.js`](https://www.npmjs.com/package/@iota/iota.js) library -- The `iota.js` auxiliary libraries: - - - [`@iota/crypto.js`](https://www.npmjs.com/package/@iota/crypto.js) - - [`@iota/util.js`](https://www.npmjs.com/package/@iota/util.js). - - [`@iota/pow-neon.js`](https://www.npmjs.com/package/@iota/pow-neon.js) to run Proof of Work (PoW). Alternatively, - you can spin up your own node to run the PoW remotely. - -- Access to a Stardust Node (Hornet 2.0.0). You can use the Shimmer testnet Nodes - at [https://api.testnet.shimmer.network](https://api.testnet.shimmer.network). -- (Optional) A TypeScript compiler and related packages - -## (optional) Download the Code - -You -can [download the tutorials codebase](https://github.com/iotaledger/iota.js/tree/feat/stardust/packages/iota/examples/shimmer-value-transaction-tutorial) -to follow while you read the next sections. - -:::warning Running Code Examples - -If you plan on using the provided code example, please read the article [How To Run Code Examples](../../how_tos/run_how_tos.mdx). - -::: - -:::warning Shimmer Addresses and Outputs - -The tutorial's codebase uses several predefined Shimmer addresses and outputs. If you are going to use other addresses, you will need to update the code accordingly. Likewise, the tutorial codebase assumes a particular state of the addresses and outputs. Before executing the code, please ensure your addresses and outputs are in the expected state. - -::: - -### Available Commands - -#### Generate Addresses - -You can run the `generate-addresses` script by running the following command from the example's directory: - -```bash -npm run address -``` - -#### Send a Value Transaction - -You can run the `send-value-transaction` script by running the following command from the example's directory: - -```bash -npm run transaction -``` - -#### Sweep Outputs - -You can run the `sweep-outputs` script by running the following command from the example's directory: - -```bash -npm run sweep -``` - -## Create Your package.json File - -You can create your `package.json` file from the example below and place it in your projects base directory: - -```json -{ - "name": "tutorial", - "version": "1.0.0", - "scripts": { - "dist": "tsc", - "address": "node dist/generate-addresses", - "transaction": "node dist/send-value-transactions", - "sweep": "node dist/sweep-outputs" - }, - "dependencies": { - "@iota/crypto.js": "2.0.0-rc.1", - "@iota/iota.js": "2.0.0-rc.2", - "@iota/util.js": "2.0.0-rc.1", - "@iota/pow-neon.js": "2.0.0-rc.2" - }, - "devDependencies": { - "typescript": "^4.4.3", - "@types/node": "18.7.23" - } -} -``` - -After you have created the `package.json` file, you can install all the necessary dependencies by running the following -command from the same directory: - -```bash -npm install -``` - -## Troubleshooting - -If you are getting any errors during the installation process please make sure your system is -using [Node.js 16](https://nodejs.org/en/blog/release/v16.16.0/). You can check your node version by running the -following command: - -```bash -node -v -``` diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/03-generate-a-seed.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/03-generate-a-seed.md deleted file mode 100644 index 2fb0e4d3571..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/03-generate-a-seed.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -description: 'Generate a Seed Phrase and Ed25519 Master Seed with iota.js.' -image: /img/client_banner.png -keywords: - - tutorial - - addresses - - seed - - seed phrase - - ed25519 master seed - - mnemonic seed phrase ---- - -# Generate Seeds - -The first thing you will need to send or receive a transaction is a valid address that can unlock outputs or receive new -outputs. Addresses are derived from a public key, and their associated outputs can be unlocked with the corresponding -private key. As with Firefly wallets, you can generate multiple addresses from an initial master secret (seed phrase), -and, from that point on, use a hierarchical deterministic method to derive multiple addresses. - -## Generate a Seed Phrase and Ed25519 Master Seed - -### Generate a Random Mnemonic Seed Phrase - -The seed phrase is generated in accordance with -the [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) specification and is composed of a set of -words represented as a whitespace-separated string. You can generate a random mnemonic seed phrase using the -[`Bip39.randomMnemonic()`](../../references/crypto/classes/Bip39.md#randommnemonic) function as shown in the code snippet -below: - -```typescript -// Default entropy length is 256 -const randomMnemonic = Bip39.randomMnemonic(); - -console.log('Seed phrase:', randomMnemonic); -``` - -### Generate an Ed25519 Master Seed - -Once you have the seed phrase, also known as BIP39 random mnemonic, the next step is to obtain an _Ed25519 master seed_ -from the seed phrase. You can use the -[`Ed25519Seed.fromMnemonic(randomMnemonic)`](../../references/client/classes/Ed25519Seed.md#frommnemonic) function as shown -in the following snippet: - -```typescript -const masterSeed = Ed25519Seed.fromMnemonic(randomMnemonic); -``` - -You can later use this Ed25519 master seed will be used later to generate as many Ed25519 key pairs as you may need -through the BIP32 deterministic method. - -## Putting It All Together - -By this point in the tutorial, your `generate-addresses.ts`file should look something like this: - -```typescript -import { Bip39 } from '@iota/crypto.js'; -import { Ed25519Seed } from '@iota/iota.js'; - -// Default entropy length is 256 -const randomMnemonic = Bip39.randomMnemonic(); - -console.log('Seed phrase:', randomMnemonic); - -const masterSeed = Ed25519Seed.fromMnemonic(randomMnemonic); -``` diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/04-generate-addresses.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/04-generate-addresses.md deleted file mode 100644 index f19910f7cf6..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/04-generate-addresses.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -description: 'Use an Ed25519 master seed to generate addresses in a deterministic manner' -image: /img/client_banner.png -keywords: - - tutorial - - deterministic address path - - ed25519 key pair - - key pair - - bip32 path - - external operations - - internal operations ---- - -# Generate Addresses - -## Deterministic Address Paths (BIP32) - -You can use the [Ed25519 master seed](./03-generate-a-seed.md#generate-an-ed25519-master-seed) to generate addresses in -a deterministic manner. -These addresses will be Ed25519 key pairs generated through -the [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) -method and structured as per the [BIP44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) logical -hierarchy. - -The `iota.js` library provides a method [`generateBip44Address`](../../references/client/api_ref.md#generatebip44address) -that creates these BIP32 paths using a state object that is updated on each call, as shown in the following snippet: - -```typescript -const NUM_ADDR = 6; -const addressGeneratorAccountState = { - accountIndex: 0, - addressIndex: 0, - isInternal: false, -}; -const paths: string[] = []; -for (let i = 0; i < NUM_ADDR; i++) { - const path = generateBip44Address( - addressGeneratorAccountState, - COIN_TYPE_SHIMMER, - ); - paths.push(path); - - console.log(`${path}`); -} -``` - -In this case we are generating addresses for the Shimmer Coin Type. - -The script above will generate the following BIP32 paths: - -```text -m/44'/4218'/0'/0'/0' -m/44'/4218'/0'/1'/0' -m/44'/4218'/0'/0'/1' -m/44'/4218'/0'/1'/1' -m/44'/4218'/0'/0'/2' -m/44'/4218'/0'/1'/2' -``` - -**Where**: - -- `44` is a constant that denotes _purpose_, (`0x8000002C`) following - the [BIP43](https://github.com/bitcoin/bips/blob/master/bip-0043.mediawiki) recommendation. -- `4218` is the _coin type_ defined for Shimmer -- The three following numbers are: - - The **account index**. Users can use these accounts to organize the funds in the same fashion as bank accounts; - for - donation purposes (where all addresses are considered public), for saving purposes, for common expenses, etc. - - The **change index**. Allows separate addresses used for external operations (i.e., receive funds) or - internal operations (i.e., generate change). - - The **address index** that increments sequentially - -The example above generated six address paths for the account `0`. One address is for external operations and another for -internal operations for each index from `0` to `2`. - -## Ed25519 Key Pairs for the Addresses - -Before you can generate an Ed25519 key pair, you will need to generate a subsequent Ed25519 seed from a BIP32 path -before. - -```typescript -const keyPairs: IKeyPair[] = []; - -for (const path of paths) { - // Master seed was generated previously - const addressSeed = masterSeed.generateSeedFromPath(new Bip32Path(path)); - const addressKeyPair = addressSeed.keyPair(); - keyPairs.push(addressKeyPair); - - console.log(Converter.bytesToHex(addressKeyPair.privateKey, true)); - console.log(Converter.bytesToHex(addressKeyPair.publicKey, true)); -} -``` - -As the keys are generated as byte arrays (`UInt8Array`) it is necessary to encode them using displayable characters. In -this case, hexadecimal characters using -the [`Converter.bytesToHex()`](../../references/util/classes/Converter.md#bytestohex) -function. The trailing `true` parameter indicates that the `0x` prefix will be included in the representation. -You can revert the result to bytes (`UInt8Array`) using -the [`Converter.hexToBytes()`](../../references/util/classes/Converter.md#hextobytes) - -The generated key pairs should look like the following: - -- `0x6f0fa2f7a9d5fbd221c20f54d944378acb871dcdeafc3761e73d7f0aa05c75356f8eeee559daa287ec40a3a7113e88df2fc27bc77819e6d3d146a7dc7a4e939c` -- `0x6f8eeee559daa287ec40a3a7113e88df2fc27bc77819e6d3d146a7dc7a4e939c` - -The Ed25519 private key contains `128` hex chars that correspond to `64` bytes. The public key can be represented -using `64` hex chars, i.e. `32` bytes. - -You now have your asymmetric cryptography set, but you still need to -generate [public addresses](05-public-addresses.md) that will be used in the Shimmer network. - -## Putting It All Together - -By this point in the tutorial, your `generate-addresses.ts`file should look something like this: - -```typescript -import { Bip32Path, Bip39 } from '@iota/crypto.js'; -import { Ed25519Seed, generateBip44Address, IKeyPair } from '@iota/iota.js'; -import { Converter } from '@iota/util.js'; - -// Default entropy length is 256 - -const randomMnemonic = Bip39.randomMnemonic(); - -console.log('Seed phrase:', randomMnemonic); - -const masterSeed = Ed25519Seed.fromMnemonic(randomMnemonic); - -const NUM_ADDR = 6; -const addressGeneratorAccountState = { - accountIndex: 0, - addressIndex: 0, - isInternal: false, -}; -const paths: string[] = []; -for (let i = 0; i < NUM_ADDR; i++) { - const path = generateBip44Address( - addressGeneratorAccountState, - COIN_TYPE_SHIMMER, - ); - paths.push(path); - - console.log(`${path}`); -} - -const keyPairs: IKeyPair[] = []; - -for (const path of paths) { - // Master seed was generated previously - const addressSeed = masterSeed.generateSeedFromPath(new Bip32Path(path)); - const addressKeyPair = addressSeed.keyPair(); - keyPairs.push(addressKeyPair); - - console.log(Converter.bytesToHex(addressKeyPair.privateKey, true)); - console.log(Converter.bytesToHex(addressKeyPair.publicKey, true)); -} -``` diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/05-public-addresses.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/05-public-addresses.md deleted file mode 100644 index 9737d1f905a..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/05-public-addresses.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -description: 'Derive a public address from an Ed25519 public key.' -image: /img/client_banner.png -keywords: - - public key - - ed25519 - - different address format - - hash - - bech32 - - rms - - shimmer testnet ---- - -# Public Addresses - -As it usually happens in Blockchain, public addresses are derived from a public key by hashing it. In the Stardust -protocol, they are derived from the [Ed25519 public key](03-generate-a-seed.md#generate-an-ed25519-master-seed). - -There are two different address formats: - -- `Ed25519`: A hash of the Ed25519 public key. -- `Bech32`: An easily identified and error-resistant format that complies - with [BECH32](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki). - - In the case of the [Shimmer mainnet](https://explorer.shimmer.network), the BECH32 human-readable part (HRP) is `smr`, - and `rms` is used for the Shimmer testnet. Those HRPs are also provided as [metadata elements of the `info` - primitive of the protocol](07-query-output-details.md). - -```typescript -const publicAddresses: { ed25519: string; bech32: string }[] = []; - -for (const keyPair of keyPairs) { - const ed25519Address = new Ed25519Address(keyPair.publicKey); - // Address in bytes - const ed25519AddressBytes = ed25519Address.toAddress(); - // Conversion to BECH32 - const bech32Addr = Bech32Helper.toBech32( - ED25519_ADDRESS_TYPE, - ed25519AddressBytes, - 'rms', - ); - - const publicAddress = { - ed25519: Converter.bytesToHex(ed25519AddressBytes, true), - bech32: bech32Addr, - }; - publicAddresses.push(publicAddress); - - console.log(publicAddress); -} -``` - -As you can see, the BECH32 address is generated from the Ed25519 address, which it is a hash of the public key. - -This results in the following: - -```text -{ - ed25519: '0x1696e3735e8871ce7086af6a9920e1a3b83cdf8b265adf449fc4bda86b91e2bb', - bech32: 'rms1qqtfdcmnt6y8rnnss6hk4xfqux3ms0xl3vn94h6ynlztm2rtj83tk9qkzrx' -} -``` - -The Ed25519 format has a length of `64` hex chars (32 bytes) as the Ed25519 public key. On the other hand, the BECH32 -address starts with `rms` or `smr` and continues with a `1` character. - -You can now transform the BECH32 address into an Ed25519 address using -the [`Bech32Helper.fromBech32()`](../../references/client/classes/Bech32Helper.md#frombech32) function, as shown in the -following snippet: - -```typescript -const ed25519Addr = Bech32Helper.fromBech32(bech32Address, 'rms').addressBytes; -``` - -However, you cannot derive your Ed25519 public key, as it is a hash of a public key, and hashes are irreversible -functions. - -## Putting It All Together - -By this point in the tutorial, your `generate-addresses.ts` file should look something like this: - -```typescript -import { Bip32Path, Bip39 } from '@iota/crypto.js'; -import { - Bech32Helper, - ED25519_ADDRESS_TYPE, - Ed25519Address, - Ed25519Seed, - generateBip44Address, - IKeyPair, -} from '@iota/iota.js'; -import { Converter } from '@iota/util.js'; - -// Default entropy length is 256 -const randomMnemonic = Bip39.randomMnemonic(); - -console.log('Seed phrase:', randomMnemonic); - -const masterSeed = Ed25519Seed.fromMnemonic(randomMnemonic); - -const NUM_ADDR = 6; -const addressGeneratorAccountState = { - accountIndex: 0, - addressIndex: 0, - isInternal: false, -}; -const paths: string[] = []; -for (let i = 0; i < NUM_ADDR; i++) { - const path = generateBip44Address(addressGeneratorAccountState); - paths.push(path); - - console.log(`${path}`); -} - -const keyPairs: IKeyPair[] = []; - -for (const path of paths) { - // Master seed was generated previously - const addressSeed = masterSeed.generateSeedFromPath(new Bip32Path(path)); - const addressKeyPair = addressSeed.keyPair(); - keyPairs.push(addressKeyPair); - - console.log(Converter.bytesToHex(addressKeyPair.privateKey, true)); - console.log(Converter.bytesToHex(addressKeyPair.publicKey, true)); -} - -const publicAddresses: { ed25519: string; bech32: string }[] = []; - -for (const keyPair of keyPairs) { - const ed25519Address = new Ed25519Address(keyPair.publicKey); - // Address in bytes - const ed25519AddressBytes = ed25519Address.toAddress(); - // Conversion to BECH32 - const bech32Addr = Bech32Helper.toBech32( - ED25519_ADDRESS_TYPE, - ed25519AddressBytes, - 'rms', - ); - - const publicAddress = { - ed25519: Converter.bytesToHex(ed25519AddressBytes, true), - bech32: bech32Addr, - }; - publicAddresses.push(publicAddress); - - console.log(publicAddress); -} -``` diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/06-request-funds-from-the-faucet.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/06-request-funds-from-the-faucet.md deleted file mode 100644 index 17981062a17..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/06-request-funds-from-the-faucet.md +++ /dev/null @@ -1,25 +0,0 @@ -# Request Funds from the Testnet Faucet - -Once you have [generated a set of addresses](04-generate-addresses.md), you will need some funds to experiment with -value -transactions. - -Since this tutorial uses the [testnet](https://explorer.shimmer.network/testnet), you can request funds from -the [Shimmer testnet faucet](https://faucet.testnet.shimmer.network/). - -In this example we are going to use `rms1qp5kej93urfvrc5lhuay7jgupjwuwvxxunzwp59tvqg7nufqntcpxp26uj8` -or `0x696cc8b1e0d2c1e29fbf3a4f491c0c9dc730c6e4c4e0d0ab6011e9f1209af013` in Ed25519 format. - -![Shimmer testnet faucet](/img/tutorials/value-transfer/shimmer-testnet-faucet.png) - -Once you have entered your address and clicked `Request`, you can use -the [Shimmer Network Explorer](https://explorer.shimmer.network/testnet) to verify that the balance on your address is -now `1000 SMR` (the default quantity transferred by the Faucet). You can also analyze the information provided by the -Explorer: - -- The `1000 SMR` corresponds to an output with a certain ID and timestamp. - -- The output has been generated by a transaction signed by the faucet and which has a particular ID. - -- A storage deposit is reported. It corresponds to `42600 Glow` which it is the vByte cost for the output associated - with our initial address. diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/07-query-output-details.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/07-query-output-details.md deleted file mode 100644 index 2483c56ec1f..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/07-query-output-details.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -description: 'Query for any output details by ID using the Node API through the iota.js library.' -image: /img/client_banner.png -keywords: - - tutorial - - query output details - - output details - - metadata - - output type - - unlock conditions - - public key hash ---- - -# Query Output Details - -If you know an `output Id`, you can query the details of using the Node API through the `iota.js` library. - -## Connect to a Node - -The first thing you will need to do is to connect to a node by instantiating a `client` using -the [`SingleNodeClient()`](../../references/client/classes/SingleNodeClient.md) -class. - -```typescript -const API_ENDPOINT = 'https://api.testnet.shimmer.network'; -const client = new SingleNodeClient(API_ENDPOINT, { - powProvider: new NeonPowProvider(), -}); -const protocolInfo = await client.protocolInfo(); - -console.log(protocolInfo); -``` - -The code above uses the [`NeonPowProvider`](../../references/pow-neon/classes/NeonPowProvider.md) to calculate the PoW when -submitting blocks. -The `NeonPowProvider` executes native code and calculates the PoW faster. - -The code above uses the the [`client.protocolInfo()`](../../references/client/classes/SingleNodeClient.md#protocolinfo) -function to retrieve metadata about the network, including the HRP for the BECH32 addresses, as mentioned when -you [generated the public address](05-public-addresses.md): - -```json -{ - "networkName": "testnet-1", - "networkId": "1856588631910923207", - "bech32Hrp": "rms", - "minPowScore": 1500 -} -``` - -Through the interface exposed by the `iota.js` `SingleNodeClient`, you can get the details of your output, for example: - -```typescript -const outputID = - '0xcba9a6616df8e8e323d8203ea5d1a42e2e7c64dc9ead6b59f5d26bdc301efa540000'; -const outputDetails = await client.output(outputID); -console.log(outputDetails); -``` - -```json -{ - "metadata": { - "blockId": "0x2b6a3301572f19e3596c2832e55c913ef9d3acc1ba345600ad76a8e4068b9f47", - "transactionId": "0xcba9a6616df8e8e323d8203ea5d1a42e2e7c64dc9ead6b59f5d26bdc301efa54", - "outputIndex": 0, - "isSpent": false, - "milestoneIndexBooked": 1692812, - "milestoneTimestampBooked": 1666599405, - "ledgerIndex": 1693193 - }, - "output": { - "type": 3, - "amount": "1000000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x696cc8b1e0d2c1e29fbf3a4f491c0c9dc730c6e4c4e0d0ab6011e9f1209af013" - } - } - ] - } -} -``` - -The output details contain two different groups of information: - -- **metadata** that conveys the status of the output on the Ledger. - -- The **output details** include the type of output (`3` for value, i.e., basic outputs), the amount (in Glows), and the - unlock conditions. You can observe that the unlock conditions contain - the [Ed22519 public key hash](../../references/client/interfaces/IEd25519Address.md#pubkeyhash) of your initial - address. That means that only the one who controls the private key corresponding to that public key hash can - unlock this output and use the corresponding funds. The protocol defines other - possible [unlock conditions](/learn/protocols/stardust/core-concepts/output-unlock-conditions) - that will be when you [prepare the transaction](08-transfer-funds.md#Preparing-outputs). - -## Putting It All Together - -By this point in the tutorial, your `send-value-transactions.ts`file should look something like this: - -```typescript -import { Bip32Path, Bip39 } from '@iota/crypto.js'; -import { - Bech32Helper, - ED25519_ADDRESS_TYPE, - Ed25519Address, - Ed25519Seed, - generateBip44Address, - IKeyPair, - SingleNodeClient, -} from '@iota/iota.js'; -import { Converter } from '@iota/util.js'; -import { NeonPowProvider } from '@iota/pow-neon.js'; - -const API_ENDPOINT = 'https://api.testnet.shimmer.network'; -const client = new SingleNodeClient(API_ENDPOINT, { - powProvider: new NeonPowProvider(), -}); -const protocolInfo = await client.protocolInfo(); - -console.log(protocolInfo); - -const outputID = - '0xcba9a6616df8e8e323d8203ea5d1a42e2e7c64dc9ead6b59f5d26bdc301efa540000'; -const outputDetails = await client.output(outputID); -console.log(outputDetails); -``` diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/08-transfer-funds.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/08-transfer-funds.md deleted file mode 100644 index 1ed62f16272..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/08-transfer-funds.md +++ /dev/null @@ -1,403 +0,0 @@ ---- -description: 'Transfer funds using the iota.js library: prepare the input and outputs, submit the block and check your results.' -image: /img/client_banner.png -keywords: - - tutorial - - origin address - - ed25519 format - - destination address - - output - - new output - - unlock conditions - - transactions payload - - transactions essence - - output id - - public key ---- - -# Transfer Funds - -This example uses the following addresses declared as constants, but you should use -the [addresses you generated](04-generate-addresses.md): - -- **Origin address**: `rms1qp5kej93urfvrc5lhuay7jgupjwuwvxxunzwp59tvqg7nufqntcpxp26uj8` - or `0x696cc8b1e0d2c1e29fbf3a4f491c0c9dc730c6e4c4e0d0ab6011e9f1209af013` in Ed25519 format. - -- **Destination address:** `rms1qz7f4y6kje2xyykzxljfazqlc67mmy9apmrpgqu3nqsh9uz6qxcf2zqse0d` - or `0xbc9a935696546212c237e49e881fc6bdbd90bd0ec6140391982172f05a01b095` in Ed25519 format. - -```typescript -const sourceAddress = '0x696cc...'; -const sourceAddressBech32 = 'rms1qp5kej9...'; -const sourceAddressPublicKey = '0x5782872d...'; -const sourceAddressPrivateKey = '0x003dd7e...'; - -const destAddress = '0xbc9a935...'; -``` - -You will need to take the following steps to transfer funds: - -1. [Prepare the input](#prepare-the-input) by selecting the output to be consumed and turn into a transaction input. -2. [Prepare the outputs](#prepare-the-outputs) - 1. [Determine the new outputs that will be generated](#define-the-output-type) - 2. [Provide the unlock conditions for such new outputs](#provide-the-unlock-conditions) - 3. [Create a _transaction payload_](#create-a-transaction-payload), by wrapping the inputs and outputs into a - [transaction essence](#create-a-transaction-essence). - 4. [Sign the transaction essence](#sign-the-transaction-essence) with the corresponding private key so those inputs - can be unlocked. - 5. Attach a transaction payload (essence + unlock conditions) into a block and [submit the block](#submit-the-block) - . - -## Prepare the Input - -In this example, we will consume the output that holds the initial -funds [requested from the testnet Faucet](06-request-funds-from-the-faucet.md). As -the unit of measurement is the Glow, you should use a `BigInt` data type to perform arithmetic operations. In this -case, the transferred value is `50000` Glow. - -An input is represented by the type [`IUTXOInput`](../../references/client/interfaces/IUTXOInput.md), and can be easily -obtained from an output ID using -the [`TransactionHelper.inputFromOutputId()`](../../references/client/classes/TransactionHelper.md#inputfromoutputid) -function, as shown below: - -```typescript -const consumedOutputId = - '0xcba9a6616df8e8e323d8203ea5d1a42e2e7c64dc9ead6b59f5d26bdc301efa540000'; -const outputDetails = await client.output(consumedOutputId); -const totalFunds = bigInt(outputDetails.output.amount); - -const amountToSend = bigInt('50000'); - -const inputs: IUTXOInput[] = []; - -inputs.push(TransactionHelper.inputFromOutputId(consumedOutputId)); -``` - -## Prepare the Outputs - -In this case, you will need to generate two new outputs: - -- The output where the `50000` Glow will reside, associated to the destination address. -- The output where the remaining funds will stay, associated to the origin address. - -```typescript -const outputs: IBasicOutput[] = []; - -const basicOutput: IBasicOutput = { - type: BASIC_OUTPUT_TYPE, - amount: amountToSend.toString(), - nativeTokens: [], - unlockConditions: [ - { - type: ADDRESS_UNLOCK_CONDITION_TYPE, - address: { - type: ED25519_ADDRESS_TYPE, - pubKeyHash: destAddress, - }, - }, - ], - features: [], -}; -``` - -### Define the Output Type - -You can define a basic output by assigning the [`BASIC_OUTPUT_TYPE`](../../references/client/api_ref.md#basic_output_type) -the `type` field. - -### Provide the Unlock Conditions - -This example above uses -the [`ADDRESS_UNLOCK_CONDITION_TYPE`](../../references/client/api_ref.md#address_unlock_condition_type). -This means that whoever controls the specified address can unlock the funds (i.e. the owner of the corresponding -private key). - -The output that will hold the remaining funds is as follows: - -```typescript -// The remaining output that remains in the origin address -const remainderBasicOutput: IBasicOutput = { - type: BASIC_OUTPUT_TYPE, - amount: totalFunds.minus(amountToSend).toString(), - nativeTokens: [], - unlockConditions: [ - { - type: ADDRESS_UNLOCK_CONDITION_TYPE, - address: { - type: ED25519_ADDRESS_TYPE, - pubKeyHash: originAddress, - }, - }, - ], - features: [], -}; - -outputs.push(basicOutput); -outputs.push(remainderBasicOutput); -``` - -**Where**: - -- The number of funds will be the total funds of the original input minus the amount now held by the new output. -- The unlock condition, in this case, will still be `ADDRESS_UNLOCK_CONDITION_TYPE`, but it will correspond to the - origin Ed25519 address. - -### Create a Transaction Payload - -#### Create a transaction essence - -Before you can create a transaction payload, you will need to create a transaction essence, as it will -be used to calculate a hash for the corresponding signature. - -The transaction essence must include the commitments to the inputs so that it is ensured that those outputs already -exist at the time of submitting the transaction. You can retrieve them using -the [`TransactionHelper.getInputsCommitment()`](../../references/client/classes/TransactionHelper.md#getinputscommitment) -function as shown below: - -```typescript -const inputsCommitment = TransactionHelper.getInputsCommitment([ - outputDetails.output, -]); - -const transactionEssence: ITransactionEssence = { - type: TRANSACTION_ESSENCE_TYPE, - networkId: TransactionHelper.networkIdFromNetworkName( - protocolInfo.networkName, - ), - inputs, - inputsCommitment, - outputs, -}; - -const wsTsxEssence = new WriteStream(); -serializeTransactionEssence(wsTsxEssence, transactionEssence); -const essenceFinal = wsTsxEssence.finalBytes(); - -const essenceHash = Blake2b.sum256(essenceFinal); -``` - -#### Sign the Transaction Essence - -Once you have calculated the hash of the transaction essence, you can create the final transaction payload by adding the -corresponding signature that unlocks your Input: - -```typescript -const privateKey = Converter.hexToBytes(sourceAddressPrivateKey); -const signatureUnlock: ISignatureUnlock = { - type: SIGNATURE_UNLOCK_TYPE, - signature: { - type: ED25519_SIGNATURE_TYPE, - publicKey: sourceAddressPublicKey, - signature: Converter.bytesToHex( - Ed25519.sign(privateKey, essenceHash), - true, - ), - }, -}; - -const transactionPayload: ITransactionPayload = { - type: TRANSACTION_PAYLOAD_TYPE, - essence: transactionEssence, - unlocks: [signatureUnlock], -}; -``` - -The signature unlock is composed of the **public key** corresponding to the source address (not the -hash) and the signature represented in hex format. The node receiving the transaction needs the public key to properly -verify the attached signature. - -You must note that _for each input_ there should be one unlock in the transaction payload. If you need to -unlock other -inputs with the same signature, then you should -use [`IReferenceUnlock`](../../references/client/interfaces/IReferenceUnlock.md) ( -see [Sweep Outputs To Reduce Deposits](10-sweep-outputs-to-reduce-deposits.md)). - -## Submit the Block - -In order the transaction to be attached to the Tangle, you will need to add it to a block. -You can retrieve the parents for the block using -the [`SingleNodeClient.tips()`](../../references/client/classes/SingleNodeClient.md#tips) function or you can leave it -empty if you are using the [`NeonPowProvider`](../../references/pow-neon/classes/NeonPowProvider.md). - -```typescript -const block: IBlock = { - protocolVersion: DEFAULT_PROTOCOL_VERSION, - parents: [], - payload: transactionPayload, - nonce: '0', -}; - -const blockId = await client.blockSubmit(block); - -console.log(blockId); -``` - -## Check the Results - -If you have transferred the funds successfully, you have: - -- Created a new block identified by a certain `Block Id` (Block Ids are `32` bytes long, i.e. `256` bit). -- Create a new transaction identified by a `transaction Id` (Transaction Ids are `32` bytes long). -- Created two new outputs on the ledger, one associated with each address and identified by their corresponding ID ( - Output Ids are `34` bytes long). -- After the transaction is confirmed, the funds of the origin address will be `999.95 SMR` and the funds of the - destination address will be `0.05 SMR` (`50,000 Glow`) as `1 SMR` is `10^6` (`1M`) Glow. - -You can now check the balance of both addresses using -the [Shimmer Testnet Explorer](https://explorer.shimmer.network/testnet). - -## Putting It All Together - -By this point in the tutorial, your `send-value-transactions.ts`file should look something like this: - -```typescript -import { Bip32Path, Bip39, Blake2b, Ed25519 } from '@iota/crypto.js'; -import { - ADDRESS_UNLOCK_CONDITION_TYPE, - BASIC_OUTPUT_TYPE, - Bech32Helper, - DEFAULT_PROTOCOL_VERSION, - ED25519_ADDRESS_TYPE, - ED25519_SIGNATURE_TYPE, - Ed25519Address, - Ed25519Seed, - generateBip44Address, - IBasicOutput, - IBlock, - IKeyPair, - ISignatureUnlock, - ITransactionEssence, - ITransactionPayload, - IUTXOInput, - serializeTransactionEssence, - SIGNATURE_UNLOCK_TYPE, - SingleNodeClient, - TRANSACTION_ESSENCE_TYPE, - TRANSACTION_PAYLOAD_TYPE, - TransactionHelper, -} from '@iota/iota.js'; -import { Converter } from '@iota/util.js'; -import { NeonPowProvider } from '@iota/pow-neon.js'; -import { Converter, WriteStream } from '@iota/util.js'; - -const API_ENDPOINT = 'https://api.testnet.shimmer.network'; -const client = new SingleNodeClient(API_ENDPOINT, { - powProvider: new NeonPowProvider(), -}); -const protocolInfo = async () => { - await client.protocolInfo(); -}; - -console.log(protocolInfo); - -const sourceAddress = - '0x1f3df4a2c6e785cf61bac23c68363fc226c2268cc03175e07b84c01f370dcd11'; -const sourceAddressBech32 = - 'rms1qq0nma9zcmnctnmphtprc6pk8lpzds3x3nqrza0q0wzvq8ehphx3znqy4vh'; -const sourceAddressPublicKey = - '0xb549f7f8be80eb101ec5d4ea5be2c2e5aaed110ab12941550456c5e5c1e83ff0f7a2e789c9fd56d44d856fd45389e7b44dac1428a31be42de86ab902be5ae2f9'; -const sourceAddressPrivateKey = - '0xf7a2e789c9fd56d44d856fd45389e7b44dac1428a31be42de86ab902be5ae2f9'; - -const destAddress = - '0xb94bf2aa9c30ada6690a98b11c1e75f30871621e8f076e73e97d8360aee5a71b'; - -const consumedOutputId = - '0xcba9a6616df8e8e323d8203ea5d1a42e2e7c64dc9ead6b59f5d26bdc301efa540000'; -const outputDetails = await client.output(consumedOutputId); -const totalFunds = bigInt(outputDetails.output.amount); - -const amountToSend = bigInt('50000'); - -const inputs: IUTXOInput[] = []; - -inputs.push(TransactionHelper.inputFromOutputId(consumedOutputId)); - -const outputs: IBasicOutput[] = []; - -const basicOutput: IBasicOutput = { - type: BASIC_OUTPUT_TYPE, - amount: amountToSend.toString(), - nativeTokens: [], - unlockConditions: [ - { - type: ADDRESS_UNLOCK_CONDITION_TYPE, - address: { - type: ED25519_ADDRESS_TYPE, - pubKeyHash: destAddress, - }, - }, - ], - features: [], -}; - -// The remaining output that remains in the origin address -const remainderBasicOutput: IBasicOutput = { - type: BASIC_OUTPUT_TYPE, - amount: totalFunds.minus(amountToSend).toString(), - nativeTokens: [], - unlockConditions: [ - { - type: ADDRESS_UNLOCK_CONDITION_TYPE, - address: { - type: ED25519_ADDRESS_TYPE, - pubKeyHash: sourceAddress, - }, - }, - ], - features: [], -}; - -outputs.push(basicOutput); -outputs.push(remainderBasicOutput); - -const inputsCommitment = TransactionHelper.getInputsCommitment([ - outputDetails.output, -]); - -const transactionEssence: ITransactionEssence = { - type: TRANSACTION_ESSENCE_TYPE, - networkId: TransactionHelper.networkIdFromNetworkName( - protocolInfo.networkName, - ), - inputs, - inputsCommitment, - outputs, -}; - -const wsTsxEssence = new WriteStream(); -serializeTransactionEssence(wsTsxEssence, transactionEssence); -const essenceFinal = wsTsxEssence.finalBytes(); - -const essenceHash = Blake2b.sum256(essenceFinal); - -const privateKey = Converter.hexToBytes(sourceAddressPrivateKey); -const signatureUnlock: ISignatureUnlock = { - type: SIGNATURE_UNLOCK_TYPE, - signature: { - type: ED25519_SIGNATURE_TYPE, - publicKey: sourceAddressPublicKey, - signature: Converter.bytesToHex( - Ed25519.sign(privateKey, essenceHash), - true, - ), - }, -}; - -const transactionPayload: ITransactionPayload = { - type: TRANSACTION_PAYLOAD_TYPE, - essence: transactionEssence, - unlocks: [signatureUnlock], -}; - -const block: IBlock = { - protocolVersion: DEFAULT_PROTOCOL_VERSION, - parents: [], - payload: transactionPayload, - nonce: '0', -}; - -const blockId = await client.blockSubmit(block); - -console.log(blockId); -``` diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/09-understanding-deposits.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/09-understanding-deposits.md deleted file mode 100644 index c1208e25973..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/09-understanding-deposits.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -description: 'Learn how deposit costs work and how you can minimize them. ' -image: /img/client_banner.png -keywords: - - tutorial - - deposits - - smr - - origin address - - address - - balance ---- - -# Understanding Deposits - -You can try executing all the steps described in this tutorial again but using a new output ID corresponding to the -value `999.95 SMR` in the origin address. This time, instead of hard-coding the output ID, you can obtain the output -ID through the [indexation plugin](/hornet/2.0/inx-plugins/indexer/api_reference). The indexation plugin keeps the -correspondence between addresses and their associated outputs, so it is easy to obtain the balance of an address. - -```typescript -const client = new SingleNodeClient(API_ENDPOINT, { - powProvider: new NeonPowProvider(), -}); -const indexerPlugin = new IndexerPluginClient(client); -const outputList = await indexerPlugin.basicOutputs({ - addressBech32: sourceAddressBech32, -}); - -console.log(outputList.items[0]); -``` - -With that code, you can obtain the new output ID and execute all the to [transfer funds](08-transfer-funds.md). As a -result, the address `rms1qp5kej93urfvrc5lhuay7jgupjwuwvxxunzwp59tvqg7nufqntcpxp26uj8` (our origin address) will end up -with a balance of `999.90 SMR`, while the address `rms1qz7f4y6kje2xyykzxljfazqlc67mmy9apmrpgqu3nqsh9uz6qxcf2zqse0d` will -end up with a balance of `0.10 SMR`. - -If you check the balance of the second address, the one with `0.10 SMR`, the storage deposit now is `85200 Glow` -whereas the storage deposit of the origin address is just `42600 Glow`. This happens because the first address has its -funds scattered into multiple outputs, and each output consumes ledger storage, making its deposit higher. This -drawback can be overcome by [sweeping the two outputs](10-sweep-outputs-to-reduce-deposits.md) into one of -value `100,000 Glow,` i.e. `0.10 SMR`. diff --git a/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/10-sweep-outputs-to-reduce-deposits.md b/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/10-sweep-outputs-to-reduce-deposits.md deleted file mode 100644 index 210cb7381b0..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/tutorials/value-transactions/10-sweep-outputs-to-reduce-deposits.md +++ /dev/null @@ -1,295 +0,0 @@ ---- -description: 'Learn how sweep your outputs into a single output to reduce storage costs.' -image: /img/client_banner.png -keywords: - - tutorial - - single output - - unlock conditions - - transactions payload - - transactions essence - - reference unlock conditions - - main unlock conditions ---- - -# Sweep Outputs to Reduce Deposits - -As introduced in [Understanding Deposits](09-understanding-deposits.md), if you would like to reduce your total storage -deposit, you can sweep your two outputs into a single output that will contain `0.10 SMR` by combining each `0.05 SMR` -existing output. To do so, you will need to create a new transaction and use the two existing outputs as inputs. - -## Obtain the Existing Outputs - -You can obtain the existing outputs by sending the address in Bech32 format to the indexer plugin. In this case, since -you want the two latest outputs; you can select the first two returned elements as shown below: - -```typescript -const indexerPlugin = new IndexerPluginClient(client); -const outputList = await indexerPlugin.basicOutputs({ - addressBech32: destinationAddressBech32, -}); - -const consumedOutputId1 = outputList.items[0]; -const consumedOutputId2 = outputList.items[1]; -``` - -You already know that each output will hold `0.05 SMR`. Still, you can query each output and obtain its amount by calling -the [`SingleNodeClient.output()`](../../references/client/classes/SingleNodeClient.md#output) function as shown below: - -```typescript -const output1 = await client.output(consumedOutputId1); -const output2 = await client.output(consumedOutputId2); - -// The two outputs are combined into only one output (the final amount will be 100000 Glow, 0.1 Shimmer) -const amount1 = bigInt(output1.output.amount); -const amount2 = bigInt(output2.output.amount); -``` - -## Define the Combined Output - -The new output will hold the sum amount of `output1` and `output2`. - -The unlock conditions correspond to the controller of the origin address. That means that, in this case, you are not -transferring funds to another address but to the same address collapsed into a single output. - -Please note that you could also have transferred your new output to another address you control. Remember that with the initial seed, you can [generate multiple deterministic addresses](04-generate-addresses.md). - -```typescript -const combinedOutput: IBasicOutput = { - type: BASIC_OUTPUT_TYPE, - amount: amount1.add(amount2).toString(), - nativeTokens: [], - unlockConditions: [ - { - type: ADDRESS_UNLOCK_CONDITION_TYPE, - address: { - type: ED25519_ADDRESS_TYPE, - pubKeyHash: destAddress, - }, - }, - ], - features: [], -}; -``` - -## Sweep the _Transaction Payload_ - -To generate the sweep transaction, you need to: - -1. Convert your initial outputs to inputs. -2. Generate a commitment -3. Create a transaction essence. - -```typescript -const inputs: IUTXOInput[] = []; - -inputs.push(TransactionHelper.inputFromOutputId(consumedOutputId1)); -inputs.push(TransactionHelper.inputFromOutputId(consumedOutputId2)); - -const inputsCommitment = TransactionHelper.getInputsCommitment([ - output1.output, - output2.output, -]); - -const transactionEssence: ITransactionEssence = { - type: TRANSACTION_ESSENCE_TYPE, - networkId: TransactionHelper.networkIdFromNetworkName( - protocolInfo.networkName, - ), - inputs, - inputsCommitment, - outputs: [combinedOutput], -}; -``` - -Now, you need to unlock each Input by calculating a signature. To perform this calculation you will need the _public and private keys_ of your address and the hash of the transaction essence. - -In this particular case, the unlock signature will be the same for each Input, so the examples use a "Reference unlock type", [`REFERENCE_UNLOCK_TYPE`](../../references/client/api_ref.md#reference_unlock_type). - -```typescript -const wsTsxEssence = new WriteStream(); -serializeTransactionEssence(wsTsxEssence, transactionEssence); -const essenceFinal = wsTsxEssence.finalBytes(); - -const essenceHash = Blake2b.sum256(essenceFinal); - -const destAddressPubKey = '0x....'; -const destAddressPrivateKey = '0x....'; - -// Main unlock condition -const unlock1: ISignatureUnlock = { - type: SIGNATURE_UNLOCK_TYPE, - signature: { - type: ED25519_SIGNATURE_TYPE, - publicKey: destAddressPubKey, - signature: Converter.bytesToHex( - Ed25519.sign(Converter.hexToBytes(destAddressPrivateKey), essenceHash), - true, - ), - }, -}; - -const unlock2: IReferenceUnlock = { - type: REFERENCE_UNLOCK_TYPE, - reference: 0, -}; - -const transactionPayload: ITransactionPayload = { - type: TRANSACTION_PAYLOAD_TYPE, - essence: transactionEssence, - unlocks: [unlock1, unlock2], -}; -``` - -You can now [submit your transaction payload as block](08-transfer-funds.md#submit-the-block). Once the transaction is -confirmed, you can observe that the storage deposit is now reduced to `42600` Glow, but the balance is still `0.1 SMR`. - -## Putting It All Together - -By this point in the tutorial, your `sweep-deposits.ts`file should look something like this: - -```typescript -import { Bip32Path, Bip39, Blake2b, Ed25519 } from '@iota/crypto.js'; -import { - ADDRESS_UNLOCK_CONDITION_TYPE, - BASIC_OUTPUT_TYPE, - Bech32Helper, - DEFAULT_PROTOCOL_VERSION, - ED25519_ADDRESS_TYPE, - ED25519_SIGNATURE_TYPE, - Ed25519Address, - Ed25519Seed, - generateBip44Address, - IBasicOutput, - IBlock, - IKeyPair, - IndexerPluginClient, - IReferenceUnlock, - ISignatureUnlock, - ITransactionEssence, - ITransactionPayload, - IUTXOInput, - REFERENCE_UNLOCK_TYPE, - serializeTransactionEssence, - SIGNATURE_UNLOCK_TYPE, - SingleNodeClient, - TRANSACTION_ESSENCE_TYPE, - TRANSACTION_PAYLOAD_TYPE, - TransactionHelper, -} from '@iota/iota.js'; -import { Converter, WriteStream } from '@iota/util.js'; -import { NeonPowProvider } from '@iota/pow-neon.js'; -import bigInt from 'big-integer'; - -const API_ENDPOINT = 'https://api.testnet.shimmer.network'; -const client = new SingleNodeClient(API_ENDPOINT, { - powProvider: new NeonPowProvider(), -}); -const protocolInfo = await client.protocolInfo(); - -console.log(protocolInfo); - -const sourceAddress = - '0x696cc8b1e0d2c1e29fbf3a4f491c0c9dc730c6e4c4e0d0ab6011e9f1209af013'; -const sourceAddressBech32 = - 'rms1qp5kej93urfvrc5lhuay7jgupjwuwvxxunzwp59tvqg7nufqntcpxp26uj8'; -const sourceAddressPublicKey = 'NEED KEYS FOR EXAMPLE ADDRESS'; -const sourceAddressPrivateKey = 'NEED KEYS FOR EXAMPLE ADDRESS'; - -const destAddress = - '0xbc9a935696546212c237e49e881fc6bdbd90bd0ec6140391982172f05a01b095'; - -const indexerPlugin = new IndexerPluginClient(client); -const outputList = await indexerPlugin.basicOutputs({ - addressBech32: sourceAddressBech32, -}); - -const consumedOutputId1 = outputList.items[0]; -const consumedOutputId2 = outputList.items[1]; - -const output1 = await client.output(consumedOutputId1); -const output2 = await client.output(consumedOutputId2); - -// The two outputs are combined into only one output (the final amount will be 100000 Glow, 0.1 Shimmer) -const amount1 = bigInt(output1.output.amount); -const amount2 = bigInt(output2.output.amount); - -const combinedOutput: IBasicOutput = { - type: BASIC_OUTPUT_TYPE, - amount: amount1.add(amount2).toString(), - nativeTokens: [], - unlockConditions: [ - { - type: ADDRESS_UNLOCK_CONDITION_TYPE, - address: { - type: ED25519_ADDRESS_TYPE, - pubKeyHash: destAddress, - }, - }, - ], - features: [], -}; - -const inputs: IUTXOInput[] = []; - -inputs.push(TransactionHelper.inputFromOutputId(consumedOutputId1)); -inputs.push(TransactionHelper.inputFromOutputId(consumedOutputId2)); - -const inputsCommitment = TransactionHelper.getInputsCommitment([ - output1.output, - output2.output, -]); - -const transactionEssence: ITransactionEssence = { - type: TRANSACTION_ESSENCE_TYPE, - networkId: TransactionHelper.networkIdFromNetworkName( - protocolInfo.networkName, - ), - inputs, - inputsCommitment, - outputs: [combinedOutput], -}; - -const wsTsxEssence = new WriteStream(); -serializeTransactionEssence(wsTsxEssence, transactionEssence); -const essenceFinal = wsTsxEssence.finalBytes(); - -const essenceHash = Blake2b.sum256(essenceFinal); - -const destAddressPubKey = '0x....'; -const destAddressPrivateKey = '0x....'; - -// Main unlock condition -const unlock1: ISignatureUnlock = { - type: SIGNATURE_UNLOCK_TYPE, - signature: { - type: ED25519_SIGNATURE_TYPE, - publicKey: destAddressPubKey, - signature: Converter.bytesToHex( - Ed25519.sign(Converter.hexToBytes(destAddressPrivateKey), essenceHash), - true, - ), - }, -}; - -const unlock2: IReferenceUnlock = { - type: REFERENCE_UNLOCK_TYPE, - reference: 0, -}; - -const transactionPayload: ITransactionPayload = { - type: TRANSACTION_PAYLOAD_TYPE, - essence: transactionEssence, - unlocks: [unlock1, unlock2], -}; - -const block: IBlock = { - protocolVersion: DEFAULT_PROTOCOL_VERSION, - parents: [], - payload: transactionPayload, - nonce: '0', -}; - -const blockId = await client.blockSubmit(block); - -console.log(blockId); -``` diff --git a/docs/build/iota.js/2.0-rc.1/docs/welcome.md b/docs/build/iota.js/2.0-rc.1/docs/welcome.md deleted file mode 100644 index 3b48b86a719..00000000000 --- a/docs/build/iota.js/2.0-rc.1/docs/welcome.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -description: "The iota.js client library is implemented in TypeScript to strongly type the objects sent and received from the API. You -can use it in both NodeJs and Browser environments. You can use the client library to handle communications between your -software and the IOTA network." -image: /img/client_banner.png -keywords: -- js -- client library -- welcome -- explanation -- IOTA ---- - -# Welcome - -The iota.js client library is implemented in TypeScript to strongly type the objects sent and received from the API. You -can use it in both NodeJs and Browser environments. You can use the client library to handle communications between your -software and the IOTA network. - -If you have questions, jump into a discussion or start a new one on our [Discord server](https://discord.iota.org) or -ask questions and find answers at our community on [Stack Exchange](https://iota.stackexchange.com/). If you wish to -contribute to the project, make sure that you read our [contribution guide](contribute.md) - -We are glad that you are here! diff --git a/docs/build/iota.js/2.0-rc.1/sidebars.js b/docs/build/iota.js/2.0-rc.1/sidebars.js deleted file mode 100644 index 3cf246c0627..00000000000 --- a/docs/build/iota.js/2.0-rc.1/sidebars.js +++ /dev/null @@ -1,255 +0,0 @@ -module.exports = { - docs: [ - { - type: 'doc', - id: 'welcome', - label: 'Welcome', - }, - { - type: 'doc', - label: 'Getting Started', - id: 'getting_started', - }, - { - type: 'category', - label: 'How Tos', - items: [ - 'how_tos/run_how_tos', - 'how_tos/simple', - 'how_tos/address', - 'how_tos/peers', - 'how_tos/data', - 'how_tos/transaction', - 'how_tos/pow', - 'how_tos/browser', - 'how_tos/mint_nft', - ], - }, - { - type: 'category', - label: 'Tutorials', - items: [ - { - type: 'category', - label: 'Value Transactions', - link: { - type: 'doc', - id: 'tutorials/value-transactions/introduction', - }, - items: [ - 'tutorials/value-transactions/prepare-the-dev-env', - 'tutorials/value-transactions/generate-a-seed', - 'tutorials/value-transactions/generate-addresses', - 'tutorials/value-transactions/public-addresses', - 'tutorials/value-transactions/request-funds-from-the-faucet', - 'tutorials/value-transactions/query-output-details', - 'tutorials/value-transactions/transfer-funds', - 'tutorials/value-transactions/understanding-deposits', - 'tutorials/value-transactions/sweep-outputs-to-reduce-deposits', - ], - }, - { - type: 'category', - label: 'Alias Transactions', - link: { - type: 'doc', - id: 'tutorials/alias-transactions/introduction', - }, - items: [ - 'tutorials/alias-transactions/prepare-the-dev-env', - 'tutorials/alias-transactions/mint-new-alias', - 'tutorials/alias-transactions/alias-transaction', - ], - }, - { - type: 'category', - label: 'Native Token Transactions', - link: { - type: 'doc', - id: 'tutorials/native-token-transactions/introduction', - }, - items: [ - 'tutorials/native-token-transactions/prepare-the-dev-env', - 'tutorials/native-token-transactions/mint-native-tokens', - 'tutorials/native-token-transactions/native-tokens-transaction', - 'tutorials/native-token-transactions/melt-native-tokens', - ], - }, - { - type: 'category', - label: 'NFT Transactions', - link: { type: 'doc', id: 'tutorials/nft-transactions/introduction' }, - items: [ - 'tutorials/nft-transactions/prepare-the-dev-env', - 'tutorials/nft-transactions/mint-new-nft', - 'tutorials/nft-transactions/nft-transaction', - 'tutorials/nft-transactions/claim-nft', - ], - }, - ], - }, - { - type: 'category', - label: 'Reference', - items: [ - { - type: 'category', - label: '@iota/iota.js', - items: [ - { - type: 'doc', - id: 'references/client/api_ref', - label: 'API Reference', - }, - { - type: 'category', - label: 'Classes', - items: [ - { - type: 'autogenerated', - dirName: 'references/client/classes', - }, - ], - }, - { - type: 'category', - label: 'Enums', - items: [ - { - type: 'autogenerated', - dirName: 'references/client/enums', - }, - ], - }, - { - type: 'category', - label: 'Interfaces', - items: [ - { - type: 'autogenerated', - dirName: 'references/client/interfaces', - }, - ], - }, - ], - }, - { - type: 'category', - label: '@iota/crypto.js', - items: [ - { - type: 'category', - label: 'Classes', - items: [ - { - type: 'autogenerated', - dirName: 'references/crypto/classes', - }, - ], - }, - ], - }, - { - type: 'category', - label: '@iota/mqtt.js', - items: [ - { - type: 'category', - label: 'Classes', - items: [ - { - type: 'autogenerated', - dirName: 'references/mqtt/classes', - }, - ], - }, - { - type: 'category', - label: 'Interfaces', - items: [ - { - type: 'autogenerated', - dirName: 'references/mqtt/interfaces', - }, - ], - }, - ], - }, - { - type: 'category', - label: '@iota/pow-neon.js', - items: [ - { - type: 'category', - label: 'Classes', - items: [ - { - type: 'autogenerated', - dirName: 'references/pow-neon/classes', - }, - ], - }, - ], - }, - { - type: 'category', - label: '@iota/pow-node.js', - items: [ - { - type: 'category', - label: 'Classes', - items: [ - { - type: 'autogenerated', - dirName: 'references/pow-node/classes', - }, - ], - }, - ], - }, - { - type: 'category', - label: '@iota/pow-wasm.js', - items: [ - { - type: 'category', - label: 'Classes', - items: [ - { - type: 'autogenerated', - dirName: 'references/pow-wasm/classes', - }, - ], - }, - ], - }, - { - type: 'category', - label: '@iota/util.js', - items: [ - { - type: 'category', - label: 'Classes', - items: [ - { - type: 'autogenerated', - dirName: 'references/util/classes', - }, - ], - }, - ], - }, - ], - }, - { - type: 'doc', - id: 'troubleshooting', - label: 'Troubleshooting', - }, - { - type: 'doc', - id: 'contribute', - label: 'Contribute', - }, - ], -}; diff --git a/docs/build/iota.rs/1.4/docs/_admonitions/_active_development.md b/docs/build/iota.rs/1.4/docs/_admonitions/_active_development.md deleted file mode 100644 index e81561f483f..00000000000 --- a/docs/build/iota.rs/1.4/docs/_admonitions/_active_development.md +++ /dev/null @@ -1,6 +0,0 @@ -:::note Active Development - -Given that both Bee and Hornet APIs are still in active development, the following items and signatures may change in -the future. - -::: diff --git a/docs/build/iota.rs/1.4/docs/_admonitions/_android_app_example.md b/docs/build/iota.rs/1.4/docs/_admonitions/_android_app_example.md deleted file mode 100644 index 456c29c2e28..00000000000 --- a/docs/build/iota.rs/1.4/docs/_admonitions/_android_app_example.md +++ /dev/null @@ -1,5 +0,0 @@ -:::info android-app-example - -When trying to build the `android-app` example in the repository with precompiled binaries, comment out all the `archTriplets` inside `iota.rs/bindings/java/examples/android-app/build.gradle` (otherwise you will try to regenerate the `.so` files). - -::: diff --git a/docs/build/iota.rs/1.4/docs/_admonitions/_android_cross_compile.mdx b/docs/build/iota.rs/1.4/docs/_admonitions/_android_cross_compile.mdx deleted file mode 100644 index fb6911c2edb..00000000000 --- a/docs/build/iota.rs/1.4/docs/_admonitions/_android_cross_compile.mdx +++ /dev/null @@ -1,11 +0,0 @@ -:::note Cross compile - -To build on Windows, we need to add android triplets to our VCPKG and use that during compilation. - -Currently, cross compiling has only worked on WSL/Linux. - -If you wish to use Android Studio in Windows, first make the android target binaries in WSL/Linux, then copy them over to `src/main/jniLibs/$TARGET/`. (See step [Compiling a binary](#Adding%20shared%20library), but do that for each enabled target in WSL/Linux) - -Afterwards, you need to comment out all `archTriplets` in `build.gradle` for you not to regenerate them (and fail on Windows). - -::: diff --git a/docs/build/iota.rs/1.4/docs/_admonitions/_android_gradle.md b/docs/build/iota.rs/1.4/docs/_admonitions/_android_gradle.md deleted file mode 100644 index cf9b30e225a..00000000000 --- a/docs/build/iota.rs/1.4/docs/_admonitions/_android_gradle.md +++ /dev/null @@ -1,5 +0,0 @@ -:::info Gradle - -Since Android development mainly uses Gradle, this tutorial will use that. - -::: diff --git a/docs/build/iota.rs/1.4/docs/_admonitions/_android_unnecessary_build.md b/docs/build/iota.rs/1.4/docs/_admonitions/_android_unnecessary_build.md deleted file mode 100644 index 62a9df5ab10..00000000000 --- a/docs/build/iota.rs/1.4/docs/_admonitions/_android_unnecessary_build.md +++ /dev/null @@ -1,5 +0,0 @@ -:::info Unnecessary build - -This step is simplifying the process by running an Unnecessary build (We compile here for our current system). If you have a working environment already, you can run cargo with a `--target=$TARGET` to save time later on. - -::: diff --git a/docs/build/iota.rs/1.4/docs/_admonitions/_avoid_seed_generators.md b/docs/build/iota.rs/1.4/docs/_admonitions/_avoid_seed_generators.md deleted file mode 100644 index 5a7fdcc085b..00000000000 --- a/docs/build/iota.rs/1.4/docs/_admonitions/_avoid_seed_generators.md +++ /dev/null @@ -1,6 +0,0 @@ -:::info Avoid Seed Generators - -Please note, it is highly recommended that you avoid using online seed generators. The seed is the only key to the given -addresses. So, anyone who owns the seed also owns all the funds related to respective IOTA addresses. - -::: diff --git a/docs/build/iota.rs/1.4/docs/_admonitions/_compiling_for_android.md b/docs/build/iota.rs/1.4/docs/_admonitions/_compiling_for_android.md deleted file mode 100644 index c8b0cf9c5ac..00000000000 --- a/docs/build/iota.rs/1.4/docs/_admonitions/_compiling_for_android.md +++ /dev/null @@ -1,6 +0,0 @@ -:::info Compiling for Android - -Compiling for Android requires additional compilation instructions. -Specific instructions can be found in [Android development](./../getting_started/java/android_development.mdx) - -::: diff --git a/docs/build/iota.rs/1.4/docs/_admonitions/_dust_protection.md b/docs/build/iota.rs/1.4/docs/_admonitions/_dust_protection.md deleted file mode 100644 index 7886b76c94a..00000000000 --- a/docs/build/iota.rs/1.4/docs/_admonitions/_dust_protection.md +++ /dev/null @@ -1,8 +0,0 @@ -:::note Dust Protection - -Due to the [dust protection](/introduction/explanations/faq#what-is-dust-protection-and-how-does-it-work) -mechanism implemented in the network protocol, microtransactions below 1Mi of IOTA tokens can only be sent to another -address if there is already at least 1Mi on that address - -That's why the code in the example sent 1Mi, to comply with the protection. -::: diff --git a/docs/build/iota.rs/1.4/docs/_admonitions/_enable_mqtt b/docs/build/iota.rs/1.4/docs/_admonitions/_enable_mqtt deleted file mode 100644 index c6139f58e32..00000000000 --- a/docs/build/iota.rs/1.4/docs/_admonitions/_enable_mqtt +++ /dev/null @@ -1,7 +0,0 @@ -:::info Enable MQTT - -The IOTA node needs to have the MQTT layer enabled. There is a set of test nodes available that have MQTT enabled. -You can find more information in the [devnet section](/introduction/devnet/) of the Chrysalis -documentation. - -::: diff --git a/docs/build/iota.rs/1.4/docs/_admonitions/_example_seed_note.md b/docs/build/iota.rs/1.4/docs/_admonitions/_example_seed_note.md deleted file mode 100644 index 11385d70fba..00000000000 --- a/docs/build/iota.rs/1.4/docs/_admonitions/_example_seed_note.md +++ /dev/null @@ -1,6 +0,0 @@ -:::note Example Seed - -The examples use an example seed `b3d7092195c36d47133ff786d4b0a1ef2ee6a0052f6e87b6dc337935c70c531e` that is stored in an -environment variable called `IOTA_SEED_SECRET`. This seed serves for training purposes only. - -::: diff --git a/docs/build/iota.rs/1.4/docs/_admonitions/_explanation_outputs.md b/docs/build/iota.rs/1.4/docs/_admonitions/_explanation_outputs.md deleted file mode 100644 index c730a9f7119..00000000000 --- a/docs/build/iota.rs/1.4/docs/_admonitions/_explanation_outputs.md +++ /dev/null @@ -1,6 +0,0 @@ -:::tip EXPLANATION: Outputs - -You can learn more about Outputs in the -[Messages, Payloads and Transactions](../explanations/messages_payloads_and_transactions.md) section. - -::: diff --git a/docs/build/iota.rs/1.4/docs/_admonitions/_explanation_seeds.md b/docs/build/iota.rs/1.4/docs/_admonitions/_explanation_seeds.md deleted file mode 100644 index bab04d0b36b..00000000000 --- a/docs/build/iota.rs/1.4/docs/_admonitions/_explanation_seeds.md +++ /dev/null @@ -1,5 +0,0 @@ -:::tip EXPLANATION: Seeds - -You can learn more about seeds in the [Explanations Section](../explanations/seeds.mdx). - -::: diff --git a/docs/build/iota.rs/1.4/docs/_admonitions/_faucet_service.md b/docs/build/iota.rs/1.4/docs/_admonitions/_faucet_service.md deleted file mode 100644 index 44944df9a37..00000000000 --- a/docs/build/iota.rs/1.4/docs/_admonitions/_faucet_service.md +++ /dev/null @@ -1,6 +0,0 @@ -:::note Faucet Service - -You can use the [faucet service](https://faucet.chrysalis-devnet.iota.cafe/) to send test tokens to any Chrysalis -[devnet](/introduction/reference/networks/devnet) address. - -::: diff --git a/docs/build/iota.rs/1.4/docs/_admonitions/_load_balancer_health_checks.md b/docs/build/iota.rs/1.4/docs/_admonitions/_load_balancer_health_checks.md deleted file mode 100644 index 4b7f8335616..00000000000 --- a/docs/build/iota.rs/1.4/docs/_admonitions/_load_balancer_health_checks.md +++ /dev/null @@ -1,8 +0,0 @@ -:::note Load Balancers & Health Checks - -If you use node load balancers then the health check may be useless as the follow-up API calls may be served by a -different node behind the load balancer that may not have been checked. You should be aware of this fact and trust that the -load balancer participates only with nodes that are in healthy state. The `iota.rs` library additionally supports -a management of internal node pool, so you can mimic a load-balancer-like behavior using this feature locally. - -::: diff --git a/docs/build/iota.rs/1.4/docs/_admonitions/_message_finder_helper_class.md b/docs/build/iota.rs/1.4/docs/_admonitions/_message_finder_helper_class.md deleted file mode 100644 index bc1179a6b87..00000000000 --- a/docs/build/iota.rs/1.4/docs/_admonitions/_message_finder_helper_class.md +++ /dev/null @@ -1,6 +0,0 @@ -:::tip Message Finder Helper Class - -You can use the `MessageFinder` helper class that can be instantiated using the `Client.getMessage()` function to -retrieve it from the network. The `MessageFinder` provides helper functions related to the message. - -::: diff --git a/docs/build/iota.rs/1.4/docs/_admonitions/_minimum_nodes.md b/docs/build/iota.rs/1.4/docs/_admonitions/_minimum_nodes.md deleted file mode 100644 index 8156a4e8bca..00000000000 --- a/docs/build/iota.rs/1.4/docs/_admonitions/_minimum_nodes.md +++ /dev/null @@ -1,5 +0,0 @@ -::: note Minimum Nodes - -There must be at least one node to build the instance successfully. - -::: diff --git a/docs/build/iota.rs/1.4/docs/_admonitions/_password_storage.md b/docs/build/iota.rs/1.4/docs/_admonitions/_password_storage.md deleted file mode 100644 index e7abca479c9..00000000000 --- a/docs/build/iota.rs/1.4/docs/_admonitions/_password_storage.md +++ /dev/null @@ -1,7 +0,0 @@ -:::warning Password Storage - -It is not recommended to store passwords or seeds on a host's environment variables or in the source code in a production -setup. Please follow our [backup and security](/introduction/how_tos/backup_security/) -recommendations for production use. - -::: diff --git a/docs/build/iota.rs/1.4/docs/_admonitions/_rust_standard.md b/docs/build/iota.rs/1.4/docs/_admonitions/_rust_standard.md deleted file mode 100644 index 47298cb9cdb..00000000000 --- a/docs/build/iota.rs/1.4/docs/_admonitions/_rust_standard.md +++ /dev/null @@ -1,6 +0,0 @@ -:::note Rust Standard - -This is the standard approach to do initialization in Rust. Different languages might use different methods, such as -directly calling an initialization function. - -::: diff --git a/docs/build/iota.rs/1.4/docs/_admonitions/_seed_mnemonics.md b/docs/build/iota.rs/1.4/docs/_admonitions/_seed_mnemonics.md deleted file mode 100644 index 2424a884eb1..00000000000 --- a/docs/build/iota.rs/1.4/docs/_admonitions/_seed_mnemonics.md +++ /dev/null @@ -1,9 +0,0 @@ -:::info Seed Mnemonics/Phrases - -In modern wallet implementations such as the [wallet.rs library](/wallet.rs/welcome) and the -[firefly wallet](https://blog.iota.org/firefly-beta-release/), the seed is usually generated from a `seed mnemonic` -(`seed phrase`), using [BIP39 standard](https://en.bitcoin.it/wiki/BIP_0039), to be better memorized/stored by humans. -It is based on a randomly generated list of english words and later used to generate the seed. The seed is a root for -all generated private keys and addresses. - -::: diff --git a/docs/build/iota.rs/1.4/docs/_admonitions/_wallet_transaction_recommendation.md b/docs/build/iota.rs/1.4/docs/_admonitions/_wallet_transaction_recommendation.md deleted file mode 100644 index 1de84752302..00000000000 --- a/docs/build/iota.rs/1.4/docs/_admonitions/_wallet_transaction_recommendation.md +++ /dev/null @@ -1,8 +0,0 @@ -:::info - -Though it is possible to send transactions with iota.rs, we strongly recommend that you use the official -[`wallet.rs`](/wallet.rs/welcome) library together with the -[`stronghold.rs`](/stronghold.rs/welcome) enclave for value-based transfers. This combination -incorporates the best security practices while dealing with seeds, related addresses, and `UTXO`. - -::: diff --git a/docs/build/iota.rs/1.4/docs/_partials/examples/01_get_info/_client_builder.md b/docs/build/iota.rs/1.4/docs/_partials/examples/01_get_info/_client_builder.md deleted file mode 100644 index 11b6ccb4901..00000000000 --- a/docs/build/iota.rs/1.4/docs/_partials/examples/01_get_info/_client_builder.md +++ /dev/null @@ -1,3 +0,0 @@ -You can instantiate the `Client`, and optionally configure it, by chaining calls to the -`ClientBuilder` helper class. The `ClientBuilder` helper class provides several chaining calls through which the process -can be closely managed. diff --git a/docs/build/iota.rs/1.4/docs/_partials/examples/01_get_info/outputs/camelCase.md b/docs/build/iota.rs/1.4/docs/_partials/examples/01_get_info/outputs/camelCase.md deleted file mode 100644 index 08b663d5fda..00000000000 --- a/docs/build/iota.rs/1.4/docs/_partials/examples/01_get_info/outputs/camelCase.md +++ /dev/null @@ -1,32 +0,0 @@ -```json -{ - "nodeinfo": { - "name": "HORNET", - "version": "0.6.0-alpha", - "isHealthy": true, - "networkId": "migration", - "bech32HRP": "atoi", - "minPoWScore": 100, - "messagesPerSecond": 4.2, - "referencedMessagesPerSecond": 4.1, - "referencedRate": 97.61904761904762, - "latestMilestoneTimestamp": 1618139001, - "latestMilestoneIndex": 7092, - "confirmedMilestoneIndex": 7092, - "pruningIndex": 0, - "features": ["PoW"] - }, - "url": "https://api.lb-0.h.chrysalis-devnet.iota.cafe" -} -``` - -The most important properties are: - -- `isHealthy`: Indicates whether the given node is in sync with the network and therefore safe to use. Even if a node is - up and running, it may not be fully prepared to process your API calls properly. The node should be "synced", meaning - that it should be aware of all transactions in the Tangle. It is better to avoid interacting with nodes which are not - fully synced. -- `bech32HRP`: Indicates whether the given node is a part of [devnet](/introduction/reference/networks/devnet) - (`atoi`) or [mainnet](/introduction/reference/networks/mainnet) (`iota`). You can find more info regarding the - [IOTA address format](/introduction/reference/details#iota-15-address-anatomy) in the official - [Chrysalis documentation](/introduction/welcome). diff --git a/docs/build/iota.rs/1.4/docs/_partials/examples/01_get_info/outputs/snake_case.md b/docs/build/iota.rs/1.4/docs/_partials/examples/01_get_info/outputs/snake_case.md deleted file mode 100644 index c8f4ff22629..00000000000 --- a/docs/build/iota.rs/1.4/docs/_partials/examples/01_get_info/outputs/snake_case.md +++ /dev/null @@ -1,32 +0,0 @@ -```json -{ - "nodeinfo": { - "name": "HORNET", - "version": "0.6.0-alpha", - "is_healthy": true, - "network_id": "migration", - "bech32_hrp": "atoi", - "min_pow_score": 100, - "messages_per_second": 4.2, - "referenced_messages_per_second": 4.1, - "referenced_rate": 97.61904761904762, - "latest_milestone_timestamp": 1618139001, - "latest_milestone_index": 7092, - "confirmed_milestone_index": 7092, - "pruning_index": 0, - "features": ["PoW"] - }, - "url": "https://api.lb-0.h.chrysalis-devnet.iota.cafe" -} -``` - -The most important properties are: - -- `is_healthy`: Indicates whether the given node is in sync with the network and therefore safe to use. Even if a node is - up and running, it may not be fully prepared to process your API calls properly. The node should be "synced", meaning - that it should be aware of all transactions in the Tangle. It is better to avoid interacting with nodes which are not - fully synced. -- `bech32_hrp`: Indicates whether the given node is a part of [devnet](/introduction/reference/networks/devnet) - (`atoi`) or [mainnet](/introduction/reference/networks/mainnet) (`iota`). You can find more info regarding the - [IOTA address format](/introduction/reference/details#iota-15-address-anatomym) in the official - [Chrysalis documentation](/introduction/welcome). diff --git a/docs/build/iota.rs/1.4/docs/charts.pptx b/docs/build/iota.rs/1.4/docs/charts.pptx deleted file mode 100644 index d18edb58aef51a563834ada726f6bc1ca29259c1..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 52676 zcmeFZbC4!Y-zD7Ew5@5|S5MovyRWuw+qN-n+qQe!wl&RZ+uC{V_uY-%Z=d*L|K4{i zDk`HQtD@>u=E)y2Pbo-)L!g5|fxv)(fDnW5lG$8zgMxreB7lIPfxv)i3ESB^o7g(* zsd(6%IO#CB+gKA7K!8!@fq?zJ{{LV)k86SC-2$}3VrD+XZp=X_*eK^%}! zqL^@(0=&(|dV&r8vnL4xS(FElq#?q1W|Mm);>S;|Y)QH<0QN)*yu?&3Dw1&-2?I3f z%O74~#$aRYSU4;>F_Cgz(E=a8)k6txRhXp(IJ2|dj-ur+;=##Rsh~j#z4SCr{0z_~ zx_49Xya&r>L1FUm5^4?+&=#!(c{5@I9&u<{(-J)_@ZoN`54C9GEV35R$c+Hcr;`QQ;?<|?B3a-;=3;C4z+Z{bQR5o>;9rT z8E1BGnn4w>J_JHV1B%h8ert4?exbgTZCQ+lXweuPF9TJ-F_zGqsGc`=sY$O7=g zkQe3U>^&Rg|fhC5+~@qOWl)v>Qg>{lg;y^g*xlrpn1)=K@|*fH$y zfs7hg&2KqtDlwbZNTxxCuYyM(dL@QjB77x=o??Fw9TI#cXQ<4qQlrkwLM5iK>9*3N zDwRJ`PF1q;4^PITT9LrReoWTFMRXL*!9?$G%ruIMHcfY%OV|>lh*()J+%qhHLV|#N zeSw20{4cCGe|F9X|I7Nlzoh>5m-Tv%Ce}`j4F5X*KeqoDruhE^y()1-3LJnOdIh;d zJn6%}K|?ZcZ71?4d-N5=h`AGQ3tysSzNb5X*T8^2uzPZnpKymv!|u@*{VKTuLASr5 zLNI=%Uwwzx-Ifrum58~JodZf94l&taL0h*f*Ia}_*rN^*C3K_F--mxyH0enc)()58 zed0{adEhA19bL9lN7-I+hL`TkoR`itv`i(T5z0>F;Ow-#L@8HZNEHmoEu_EhYNj zE9~u^8SNcSoc) zkY1<+bJ$dplcoEa?}u4Ba{NA+tx94HGhl@gtRMPfW|cGYV*pc&PcHQatV?PQ24GFi zDy*zbz!~52KeTPN?efF>tF;#7@f)>#je0dJz?qkIl9FtAM+e~gx@7ZHbm%)JC3w)3%rYQ zbS&-z5xhg+lplTkgIYU&cG28L-nkl9M)(|$ZzzVFK5jMgHd+>X9#seIV_hG4R}O{a zSxJ^g=fFn03gyoP3lTbOYTI-t0LnbL{6wY~vM zvE@^6R!^Mz%Puq9&oeILuO;|5T^rQ2dTkR51jL&W1O($hyS9_Hg|Uef<39!9pT4bW zW4F(S`sv&E0WFyO=x;>VBL$y9f3Jz&))KXKfuumjrAjN!CFLPJ_vI@rH6E3;<(XZ% z@A{nxQ+6u;SGorQ61C6W#Z-rDP4Z=B3#Zdf#4%R|^?HLP!}Mk@zbTb{w(n>rbM1y$ zc6)1uTd&XCjGy;H_M^**zw1Kok=dmscE`d{0i&vA_7kN|DQ;V<^#d2-Ze@>pGFNY? z;>tsydyab5U4;XsPj`%Or?zT{)cT%db%p`HNF^6x->omu<%37Fb;>+jl^5QqnK1nx zQ&rWwOxo$9GftCw!Lp`jVJqx1yQS5y%d<4Q0>ZCdE~&Pk{?f1m5V2M}m10B3w#ay7 z>g(CKXyp{r%*k%X!11;0%^;K8fs-63M_PxPyKat z=p8&(_&A(@X*}llYS40`q-J($ry)j?V+wCFD>NB}9jQd2C}tjy${z)b(Tit8C-<$o zDz~?H0*fwZ&|C+j<6`5`Ua9Gfdev!Kz?~_Rd3f~&&p>53;EI^w4gw$u0Y^fDVv;k- zoIA%9ye5w2KXtcMV+g2r*X+0n{IS_*Da(;Nc(H9UBL*)`k{-{787zGSdG2rzmdiAK zfQ>;zR(zmne!C#|^vkV6hr7h#$Px&@eD;Eo#vM6LvRpEU+J@NL%pB-)r%T_@$o5+D zt3zd|*|p~Ob#f{SjM*n=SqiV*1i0cBX_Uub$uYJuM4zgEm`b%{v6{Ydr0b!>TJ3A= z?^*Yo=||k{{^r&iVJ@tm)FhjN-4? z8bZD_6q`w|H&Efj2grB>z#qU*RV87+Y&=yJgx8m#v*Z+lOB9Z-kR}~HHlTs>cM-c3 z*KHQdHrt2VFXqNri?WgM^`S|tI>iqjmKO?^wE&@oIOd;*iNuW3hJ(g?#FCui0lA*= z_7e~fPl&SP-nq93hP>G3kvjRDw3iT58ZWf|rVBsE0kGZ(P#ksy0XNDpZGTrwemd6H9FyDs+$q+riZ=6H#~9M72j{swz#>8pJQa-XlkbPFqd6FELXTDNOGF#!n3TQu+@KqrwYW}`w~qKb*+P>X!-a&1$fJ_UuVe|~ zA(AkSjqsvm$yCwhWRe-z;ql!dYn06T5QG8V5Dkz#&)k8{i2(V53-TdPlfVdikkAAR`GVbH}}>8tcRW2$5&rzp{@nd zl$4Lp3UTMfgyS6dOnY<)$kOE2Gs2Pyx%~)?V5D8vjLF3MPxL&VMbV@tU2G=Fr zf~EuRNHw9qtqym=O``ov0q@_?Zzsj0Z(u|dN2qR0A_0$pxSj*a0jyL^d}UmS{X1|H z>>E0S&AVW9g8TXeN+z^Tv%B=ySdqCVs6Ns^c*pC>>;&xc&a(3iXWsrt9pF3nQz36e zpsl1hTzA95l0SSBpDGpWf|rx0FHDrzm!%F()|030Hw4#NY{2_K7nUoWvo%?btYrRl zRkS8FK{T?;oL2dh(mcaNOP{rN?{MP!~zOP0@otM6=8~@qyRxWaB?2u`~0~sD0HJ446Q7~H&q`iI))~^Qld0g; zT+K~hB5wsn{L>!;bmJubkfQb1%2d?$!9|Q{2Z{uvRL1#(?t0{qhuYR%3D<1}@jQJ* z-c?kw7(+Xq1%01M%FzzO-u`y%CiS_AbOOQ91d{|#WJ$?H{3XPx5%)=pUNISgo+?ay zJ&yhn@_`m{9%{-m#*S6gv8+S6O3DX1YVucnwm_xTiFenBXylCydje6Vcn*JFep4Jn z5PEdez{1Jo83%L$n_S#1w=~`%PG{S&yP9s*4lCL>AAGuJkP)bXbvC`L zYo2Z@-No0iuD6r%S2zm1z@%V7Sxc;E;B-W)Rj zV-9t+oNy(7`tF2(AO+{RlCo8I>GAC6j9R&kJkqaUdaSKN!;?pShmZ-_e3YB?%S{5J z3;C0gF)=icBb7j;q-X$Ne2x<-XI}2~_;g~t2%{YNGUT?i64ain)MTI*ew*L^o?5fJ zLY+73ektI`c^p}gyg52|0`R|0uz!8p`Q>!y#D(#i^QQM+_HuS=)0x)J%p3{aml zv1VhSJzp4V>ONpyo4x$@R)6#htJIB|p&q_{ui($fqTfh;Ys%Htj)oFVL#(Nd94qLN z(1?EfhW+yH$dbvfmU-dStf4Xan;CefCHx9?X?^X=Gnsq0*4aRHJ9n_(dU$?up4#yG zQX1Er+&zb!v!Y=)-y1mM=-Tsc;Gy|&d|>2a-!u0v?6m6laZ=DVo@;N{EpIoy``d5& zEBE*+Qa)-s@6*x#?qc`$`1>&;!+vbzOeW&=3fGhy5Xtt<)!m8vD$j}iW6{WLBH^7$ zkHx5iLELWoGXd3wgd!FdpE&lrID=ylstK1;3XjQcZaZs2EwqUu@9~w|UC3y)n=>nJ z^1{o#;f*Czw`R||>2%*2u{WpDEytGuOoYl^F#a9tO&+-;3$?MKeHxUZgZ`H`9~idN zoyOMC%WZ6GYfi3^-3{y|TkmxBlk45AYY$)meyPC|L&S=Ns`KMETrn6$vlpEL!RUTD z^Q1Q?di0inYj-=(_!xhv7D2f2?*0lIQ2?;W1+c zrRKB4+S@8&FXtH&6w};G!^Y{k_wtZAk1lJ~&RsV`>aiNTn*(T}x6D2;s^a+MpyX!B zoSEKDN589VTkNu(ueayzwZ^RW4iC?F`eOSRW!J#Y1Rsds=hK<5M%Kgl(5n2%6k58> z#e<~2Q|A}UzSK&mfN2Nio-tQ{lnD%tP z6*=6((9RUVOfpx>2a5G`{zz1@S5f()J=KfHq9jw_f39vmX?a7p__^(3A#a zS!Sym;zt0r6=>R!a{nfaH)>kuFr)aS=hvMbe>Znc8YFBz#8K@vx&iWjfw-h}{t1tB ziKsv_ZXCxGs)i*bsuV1opCUOS_>?%flD|f@EWK{~aGD*_Jd7B+E=|v%y^Y8Z>0I+v zxf0kqMHl9rd*3jCdA=jGhmh`H-g0zh^f#u<^JP`b)>zKVj}#i%`ceiTING;PPi}>M zzBlkWz=%(jb9LvyR~Akb@JA;Z*xh(Q-I+3HgHY+4s|{UOu`^ISDDqmo72fcfsUFm` zL#7aJALCKe3O?n(etpE0IviUr zpQ&2(3dC-YwW^Dg&%?g6x?e5CFanF3Y>RCpt}wk}Z!UZkjz4(K@)=T?2_QH3tNM8} zQ?_)USM*|c;ot(5nvc*nK$KPAqm$~b5Gge(hkoMZikClIW*0+lBB$)C$mh>ZXgGSa zh>Rh0D1-7Sg(1pHKv@+vEycgcwtt0JCLG6bxa+BBtuH5ZLjoHaIl^&8d5GF{vx@IJEx~E%PQ`rJDd~3hIQ`l zKh5I#EJE$Z?@vp0z&sUWX%OuF613yYDe>{d+Vu!_7Oo8pyyf>PCH96&y{ZCvMsSUH z=wXZ3l7p36(I++?C+H%mM8o=*$*m`B>BO~R0^K7q145`lP_D_6>mr;SPj|tIQvz)5j0BiLDX($C#q0x- z79r&$0y-&q1UlJrT{*aW=qW^Due@&apFU=;tP5i>?hyEo-bVEJ;+_Zy{|J+I<{S$m zL^cjL=kv$3MM`C5rGOTD@e$Y@^yr^(7p8U z-GGMm7M3Nwh$H>#vP@1e`a13&oMBgp&W6tuO ziI^fx@y1PJ#tTJTT+6(5%gDkC9ch(Dnpl-6m8z;|_4mkWQR0}1CO|Ssxa13ePv%nf zEiu_L=`oPICUEH#O(&4J#QGmqo4YJ5+q;CK0VK%=n^eP<(c+i4NoJB+$*>9cBHr26 zab(N?>~8kIl-c_}SUPg#wF+IyXbE3+6_9aa#s7xzlouhbEE0)zw+kVP9kIU^SkIPn z3Oh!e(Ibyvt{Q+=HMg~D@`re-WIY^}G7{hs50rtBIEzoLTNSC1Z)|naS-YIw%x@PR zZ`l@Vw6r?6QA(4HN^r^&yow~j5)v9W%GJjn7+)AY(i(S#K1Q6jQEGwJ4dLG$TtM4g zh6$GldhFL2j0XRbiokfKhY9TC=O%Nm@Q@5rK55gOEeaI$A6G7J6=>1XO`em<(J-hKTn&9e2rZe+uI1I*60_hk20JY-^7$w^E> zn%=~Q43>`Qn53+3*sCc0=cxFF5=joHBkoB zm5boZjJb)0O)ptJ463b9kRNj`Z2%GMLMQVoiz|HRp3-Y_>H0(GaNTg&<%5$!r`|0 zZ<{9cp4ml&^+w*jVS$=qRdUA1;@9yfQ} zr19?Wc=PMyf~zpo(QdQZh3$xG0-+7T$?>}SQ(d39FA`h=ZvM8Z@qXrp{4tlvsL^wt8fB`4Lo5I@=0-+z;O8sY+!r!NySr+CdyIF+Q5C>T^ z@@-s*p-k{w77P9)iDn61ErXpQBXk+@zV8tzS3J-Cw$QGs$f=(s@g#MLO6YU5*0=~U z2lr#u;_8_-t*tn5cU|*S5iE{gePG7*GHBDK=_s^Td{{8?Q(x3OHaI63v5me`3_n?X zNG7nN_Q5dbSE-4q16ogIKdi%8S=Ghp>t-gyqXJ+CgH%RWsp46+K`_)&wt5JLf5Ei? z=eqPt4e^HhNX`S|U!Itj)EJv6{zd|~{b9cy!S2Jppp$;@S#J6{LH+1zjh#DO)A49M z*4w@?kW!C$_oB+L#syK_mM}yg5ECCXa_oabB_)YbP5VPN*h4-0lphQ%9=4GiWmSz8 zg9TF#1b#QkqzvmmIw!o6;&8<_qrK|q#kQ;bLF@%D1i@)1BNNV@5-&+( z+zN)l_8Pv`Q-AfQ|1Q>ch5YU@(}yLq&A(Ds^KajoSX0m6WoRn0UwMeA~W#%^Fw0OxaXHHIep1*b1V)>*_ zHIxh=J`9sZw9AhNv--tMPS9<{6o_W=bbhe@ac34hjcHC!S_OuAX%O5p%viKbml{Bf z@04I=0yB^5$v$3$j1i%`OUgVjUS{V=P(uwH<5j22=?zADKYl`Dw>iN9!Q6%&XSxFn zpn3UIJ9V$)2&FHH-9slX6}>i3A|Y1@^nigiP3Eu5;cR2z$NVMk1eF*~Rdb5|@ZGM9 zY8$!o!fz&ly^c+hHVXY4z5^C3GYd>|8|Cshysj;`#{Ph=gfr=!cy^Wqu{}=*K_=oM zF|xr(Hf*yzTOcjcNGSp-c2XMy>B`*jL_y3FW~iA2o)V-%fpYk6UO$KfL3%RNz<>b( z_TBcCmg1hmI&x_-LiT?1>0nlPpPm-b0(W~?6NfxQhDH1cA#vijfAgYt4{2s7kX zmrTD%y-I>dPP2kJVclOgYw0Asf}rIs*%{14N^K{^%-!KG=v==Z{sMm@l)l@w3npnw zvL`2Wg^G6I01qK9W4+GaK9}#DFE50pA3fW}p=`5Eq++KE+h!2OXc2>~6IX8(h4uFx zJjR0cWrgcd(*HPF;19>&F{BP3EIY!YUYGGjXCjw>x1wlg8&K0^F<3OOpjp_hq|4Z} z{`fP%sEh1$j^e(yEsC}mPKHXCNQS>BKq7z(D9{IktjX=q3%zs^5CTAEKufm!qm&Vf z*bAZcC*V6B9#AZMVL9Pj%(?j4QSB$6O$Bb3-i8YCw-Y&vV>8AwJ+5)gYto8Rms2f| zx?>^7DIH-W1gI-*iloi161aG+b_Y8Y?bdu?X*nU%>vm$w^{&E|z*^mAJA2;*KJRgc z1&UEt{Y)dNuA3=NhM!l5A%mPalxu#tPtzK{I*v+$FsrJ~H8#z2`3zrR%#(m+Q#qb^ z{)IBU1zY^b6+pSZZYU>JZ)_1C&ICKDFDszx9z~@HdzU7ino~m4F_(2y{7n!}mTCK% zPieS$bgm#J99nsYM<4Y(yVusnb0^`wdHTbZ`{B&{r*dz}NU?7>`;8TFC(~3F_d;g- z)zwo6F>;0X>4P!)vz(n!XKJ`GN)d40{k3_f$H-9Hs{D(O91nM^#y$DiiJOvuJW3ldd5Ac#Xv?;?Vhh^;_X0AJT% z9zTk6nt-~vpxwmyX8|2di!rPH8|InG4{r4)OiZLTF^}2-;T9Ad8-zIhMED%XgZk-u z5|2!LYzV6KgSG}$PBa2DJe&T5-xoI`k|Ym~pdkZV+vAUn=+pR%!y- zp?c!8_Y5LVW>XsA4OhB{<5erSE@6W&&7;JjJhr!d2ZG|D!a8z55+W>6U($-lnMErO zIkB}*<8s%pYqV2&rhYi8%S8Ux^)!9BsiCV_oSzyji~YH<(T?9*`5gv42N_9>II~DV zl4-hoVYxA_^eOuK;sinOlD*q(VJFIw?Yk_dN9g_`d~FWcNT9?(c@?23Ys--nYs^k; z*b*H;GHz)ZHcheizznvsj6J@5~Km-994g2@0!yo^V zIvjJ{AI9k^rMc?c8{=$RdSgzh|F&gLRvyW#yv(tIAS{GBfj;U#8%i3G?$E#XzcCV()2zY9TcGtKbQthed=jpjMpo6C7ZYZ_U zL$PCr!F0(*x6`k3qR}D6&)Kd!C&vKhWzB_;I!yM}GWEVODr&4u!mKd!te|RNy23DH zrRE^2a?E?K$EIgu;|N%9Ukh7Kh<-w=);Ra#eBO(7=LS@KuDtzqRq^ujZiC_b`S@$Y zk_o5t5f^d%eVujUy6Pq0gYI3+7Y56Wc8qaj;(h5t)a9aAXA7#eHmv4`|7GTfUu|18 zbfLSGvzwdqgXvUbA#LZ;Nh4cOqgVQ?=Fk9d4Wdouoesd!$Cr~H%6K*TFfOWteo2G&1Pw}41$GTT521L<(MVdefdM?!M$ce64Gjvt- z+gK@Sd}PQ76NVOcQ0%K-~l}jOk5Pihgt&y7FFQ)rO^5 z-Oet*K&y>Do4P$C`IpZ>?{|t)b)1pY5AadLP80hcQ(Vfv*pc|j~O_Zz4#SwQ( z)8z=rlpE&rcphPQGbmZw73TBdofIbx1K&o!>`&r*W6{$df*!e~QEkZBO5V430Uj7> z#X>)nw&SrD8-?dHuDbvT5KBaHY6p^B_|h+L57KLO{{*exUUq)6&>J@Q(lTgYg((tP zDe3e)VU!QF^}^>~T|xOt>=Jg_W32zMNg}&H845YeFtERgKKv!fRBO%=;sl;L-3el>3j&`~ z^WTvyb_q}kV|wCJD05+sIuo$BdE{*^N7Q9u_wLT1P1L8Dq#|p} zQDWFRmIfjfFQJUO;RIAFx!qVKOrPprK03Ogjf?`@X}KntP-)~4h?a?Fm~?H_z>qCi zNZ~9KO&Cet09ZofqpT`K{i+a*YRP+I*M_kip5{s)4Umktfo`|_s9kn<@(UV#x;$F9 z6+o5I*n+@s4E9jz!lGaSXqLDV$;Kd*>L{S}4T)WCY*H9v%-GdWO^V}G+!<^gqN}^5 zV;#-KE7BQMo@%IaXP8DCqLZQcNb!vOgg-g2$h1h>u>5+*D#foE%m}uzI{Un0X4gtA z8S4pvVYL+dW=6>LI>z)cidB+N3NWGt^ALvm=qdi1shtJOfpn4y%u-~UWQ>7A5p|9O z*N7p%G2Ey`(v&1kkbccTgzij_D*~SPE;9MQj$Ygc4IiaAd<5qYWhV#AuW#I58E~(7{j}_6o!kh2$*GE`Y&26KkD?C@oL~f?+(Bp1EU548P!rLIm9>1qlcJV$6kKieZo~>V|8Ioh1Kl;?q z>eAK0QEee4SeiFUteN5T@H4TMM z%>LAU^~S#ob28XQ-4IQky}y)sv&@8daLuI^(HITb=K&7TBq#Gyc*#ubz>dGZpb`2;dP7F(AaE*ZD;i6}DUq<|t(MnFp+YEF zrVFMo5I#&;RYSBh5Bhf_T2^1kJZx*8IYz!AS2xSPM=firmGI!Hf4(pH9XZH3Uf;=o zy-w(TJ^n3y`NUEilkBuf5fs#pDT)u^3nxL*(J1LmGQebkV06qXq}aFURvai$DzMsmJt(SE+xUG8M+dqJID+9K*d}9*`}GnzC|`kOy?K zGv%xB+Lm$s5la0@=>1uU#Zv0fVM{45F^C%(gUggx(j%3^1*Fp8L)DS;350~ZvPi;_ zPfy?d{WXRaNDOILrx6h{P8u^Q(7Iqb&Z1pO!o10jwLF6c%+MOh>=KkWTy%i5z*KSG9}pOp|Kif#;N&LpwEfJGUsGt3$)^BXD;Cgv#+SBT5Ycl+2D zS5W(Y#1RtFA`%F1_}g&=o=OUKH@=j*5teN}YZ(=F6*?hw7qMioA&o$gH!#$_9gd!) ztkP<>%Gpy}jHyln%?!pv4~zt6HP|2lCS|_6BnwdhnON4jSD6yy6d`{GUZ`;6wo5SK zCbd$4M7sCUL+3DQqS8~})Z}E{P!+*mt$VXPVZH<%)TRm&T?4V{0A3;=vf!sufE&V! zUW*jL#%WyR98%QmX4Lve%c6VcZ@d6E{w-mF?M@%Uq@ZtMnf%Sazg34ygzWMZIAwba z2MdehIy+JqTasGm3LHBt+4`GmyL<>)jct6_cGWuTW~(3tYZ_WT3faa(B|t}=r{MF) zJl#NO+8vRL8m*qyX2{h5mz`fqVJZKWGbjWqiVczM2$zL&q#`k#zpG?VdQY8)6Y&mW z&Ic+XQkU#*q8tt#KDcQyS&YG+EOj{Ei8MOb(+^jhz>Y zOoX8f;y4;_I@^%^9WAX2)b#9;YGfkU{7!jrI)Cr}iFOa2IIM;uuKUWw#EbOH zYmgx&et{kUj4Fvr^}%!6fH?@$%3E9_vmS6la=Cc6ff_k4VW_yPycy|#JCS|RxqNC4 zWF9_yVMfMj5yzIV*iC%!yI5v=aONm8eaNMJSb70oHb(8N=@~{N(-_(jL~>^2V+>gn0U}tx~U3zJo0E3SazbuJW7xd_xRl3s@T>8H@McCI52StiXU~WhN%bU>NE&*H@NJmmU+WYKRrN z)5*(-gV}<85Y)29>Dp&-(`Xn*;jD+yuhqrnxFkP^2(xW;M@3I&K2#>%M$hm$S~+P4v^8vw#>ow{HOR4-t!^# zMUl!D*iVv1)j9(Sjgu-rbPAZ(TL?vFaCxopr*REC_mkX~{(20e+R{)maNS71UQNz$ zL5Wdqf`{oA#1TBqFA~|b|K#Y*qmK8_AzQTvGDm!r+&chkN!(phS?S)L)vooKBt$y> zglEusmGN__TQW%s8s8|GPyPr>_Cccho1%Iihk#CwsTEmQ;P4-zk1=yt#-~QSflo&LryjheL8Be~z<0hjhs69c4GQP<*49=lmbZeTDf| z`=+H|7Z}EBOX0yZ6wRtc&68k}?GRF?)1Q41G$rwk?5?aFh?;BTL}ZDqNoc`n?Wmu# zwKT7jY8Ws5^`e*KHMU)S5CAes?O{wQffW7>XiDEh+FvwNRRNwWg&wX6ojFc9iJjH4 zz7B0bElRf0<{Kaf$^Z!SXj`RVuS_vy^j&0wD^VjawIL8(`L+4R`qkkmS8nXDz6{l!gFALYA+(N3e8F^ktIIGa@B2#>J-5`$ z-hUencL$>%ntTHRAu|8>(J;$D(Qx*e?Zzm^NH5kOZsgPBh+|*Cvc`1=<|v!sdESM% zW&yncwGz3-$cbSam~J6F=$e0BC&$33fam!BucnI5Owl%kvy zjY%jTVd8R$F?VBhojf=`yixH4oF*7%NgPv+2gdij)Z+ZTU;Bi*edTI;? z?#t`ruB<0@Q)RlXol|$~yF9-QEO$<*mJp!}EPge)=5YnU_6K*@#54}sT2}0&(3@gh;9dVqk)N`g?b*?7>Z&gf-`v$qA!~?c$s_ z8^bMgZ`pRtorl(1_Kd&-^0udp&9PlFjwyU<_={k6hpEI5dD0kCOnrv3zU?a;6#uEM z(y1ZE%zd^q7ix|rgoBov=@?HfjP+$)Gzi-9^6GCDF@5K*hbU9^2VLd=ESXWA8XSo# zsNy4g*(_(26BA{wvCbb^(YHZs`erC=2_GXoqwx^OP-2s&g)+uLIx&2qCa&>p*x zq{u@MROmLgKI>8zrIEov%J%TCKgiZKwK)W-{*pX8fz5Wvqa~U%)6lj0=-<@PtXR4k zZ0ERh;OU^fvU=e4{R*EiAFdYz0Mq+^4AdqgEiF^xm+wR!b9|~8XEe3(U;|jMr7T%| zh-jI8djluHC{67fZ~(HnSO{a<^T$|GQQ*9K!YRCCE!GU?wT@MlsVY@%`*l=cs-^66 zQ6l!ctCp_1>(4EgOi7saR?me2sV^%MpHxyb@4{(vNdhFp+Y*WAgMW}A#C6R+S&SA2 zl_g5m!J}154MZ>xa~UF;Q0LH2FzhuNuZj9bHQWpQyoXewzN%2VS4kl*!i7vD!cZV| z*ug#+(E5hLs1O(-kRkE?U1!Y>xSsm#q_QUJ{gbA1)J`#luPm|KpJqu1IG$56uNHkq zR3u^5kL-pZrYk@-FyKTTiw=Y*6iJE1ldXH^S19(bq3H~tQ8K}Lp|4;D0Y+v6IeW(B zvfi%9_!5yM_#NSB`=tBOP>RLE z^dSlPjBe;>4aR+1G|$CnZd&rE$*Hm(b|P=G3%R`?!5hqao!vFg$0XVGpV~nNvUf5H z1yqe0sX|t!c)_$|!cQ9Ja=2r(2H^@w(mmEz&KfDQj#{7!-&Q>}c%*+>@2Tuy?VOH}%XcgUU+Zbv3?&XuNgE?o4Iud!5A$iPY|cv`$lIp#nd!yn0}B1);R` z3GZ%di&G96^5WkD4H1w~mC4C^v5+pX_d!BI;cMZc9;vV;l0pa&6=^TRhABs}(AVJy z5KiYTVquv;;GBVXkMPz+m?`-!6afr3n+nd|#0)E!0?u^mXUw32{;FR;ffl26OJ$Do}) zt2XKe&LARD4>Lwv5Mc;a4Y38!M}xp<;uIz;qyVW;xXMy@VpD(O2x2+2%1b1249$Z${oYdMPse^gp%kks|t8kr#O*5U)i68M;lDZ8!ZME?ScOCiH?|f52~UC zgesF~Jfax|DsrQCg;Is2?=}dc1Lv_P>aYYBGuU#Q1`D(orRfSv>FZbLWX)V_`{p(D z5Tcsn*u~VYX85w(39}b!bNT(=N2IGoOPqyaV~TlIgs8xZIg4s!{o5WP9aAP0iCoG= z4{%A5Y9YXMa7pfoLI?%mCdS5!(OS^o;E5AUCtwc)j|v@QuZl z%{5@I#}+(_hlEFlWgZ`VuO2We5vqvJZ0e1$ZF`^p(LwyayUKX6`WELq9}}a}RLfl+ zj*f!ZE;9QQ3FQeG+;rvzlZ6Kz5TTtrE6mLXl=|^V%Bu7Fdv)zIw!0oH;?b2_WRRB> zfhYqN%K_8kKv75$yJIqhp`v7ui9X>$>?Q7a&8}6kryex?(FHm_%x8S7ZkW4Ci{lae zU~E=6`a1j!WI^Df!`Xdit3k|yCi4!WY!P*zyYdxgd44h8qkQgQf<)JI*<@{b!sLYR z_O>6=DrOB` za`YA#XS@s1nZR;D)y7x{pmX$fEu&#LZl?~@fkdUJP5M28nj$u? z-O5GaTLREBkkcZ}JB;n0$AN3Gk9E{P2RyjkfFEn49MTN(%n0+$6WlgIp@FqgsJw!7 z1;qo6%u8|q#~VH+xU|2UHX{W-xPZpyX$pR071Ax@s7nz#)g?-hXH`xUAAZnvA{>0> ztWCx<8qHP&u^=1TWD!}4UV`4b5M9)v5M7ZAh-XzN*cqS2*R0PV+O~-62RHlCw5xqn z3VOlD-9lR6(|3nl51xkTAKvXoK(=<^q&=v2S(o<^ar`}CdOa2^2Tay_==N+6S0zBFHqYGGb~f)nea9yr_o^R@oxl0C!J z-~Dc;dM}R9eB_nOW4zs}=(sapn+)YCSuiILO3{Mp{-=4_eGldO1+|lqKU*OCh#I00 zVeqG>P%HWT2V~mx$OW)cWhUscSPzM+?+odtkLo~7DNllF+DE>V@0(RI1I&&J&E}?T zdDOd>65Vb3Mpoh$DipFF|`lKQmYx{q51TX?NFMua{qqaC@IfH+dDZ)_|TC z`9QXA+70)zb-@xk@P}uV@O6;^NvLq6_M#dtQ!44Dj{CNkt2d58mvgj6)0V{929RW{JetYQ9Z&z7f+*g7+s%zPtTT296Lj z2D*~i1}N&@x5nZaI+VN&&8cl0zJCkdNSm~&?{CfjKlFbDZ~q;-<*$E1=bd#!ZdGgG z4o0Rkp@tMLjpyql&bCq1Lgi{7v?GiGIFJ4d{ff@z1l=c9W1OHcEgmwuwKHEduCJ}$ z6(zDZ6GxU25dt1SdvYVcb3VG5;N}1=ssdt}DJ5}Qsy^FX@FzgAEQ$CCQkwp*40T-( zU($zVO7YMPd~zDSdm-LyC9usVLbraO$z3{kuI5|Ft$gs_8u#lkeNAygnm7$^k@w}* zPfZO{fpocxZPtIUVcoimX(9UC=z4!u;e;SCp#N(4|7h|5uafm2@PD=7pnw1T@b`xQ z+FMuhjMN|#^6*vQmBNwjg6qlyQs$*-FfUBO8Tg>n6XBK0+ zo$n-cS}v9vPUR3wrr=~$w%=;SQ;ZGu@7J$0JR$?+9e z%-4-7aOj)2!jM_id^V0?)|IH;s7y@kKt4~T#rc$fmYKTDm_8&UGp0A8}+WR`Q>0=JH^t#mIvXGNAOr$P?*A zn8e|ol1R{ASkI?i0YL&#dxS7J*+cKp|4u&he>S@OGZX&bDfWNM=<7_(9h9Ky^Vw`1{aM^@?a<0Rtz@;0PDEgrXK~m2p{vz*oM@6+Qmi4@q zDP#+6l$XC2u5`>YjYF;7!7V!f^kO03Yl+rGZ0d2Phx=;U^X%TxYnj``AW&xd($JGB zeQm?k3Ob7W66=nMyF>e-xm}1gYr+UiqLcXx%T!Lsl9G_}Zp*sI*CWoRM|az(I}J;H zQ+?5xHSmq+J9Ft>#bS!1Oaxu*g5XRzn~%qNkGwMKjmfwI9O+^Bh{UGeQ2dNJmyW-a-Q z`4X|Dt>;-pS71-7p=A95shhfcK;A9e#_E3B8v%g@St6R?kPh?6>Q+Ke^!na-TWZRZN65#MDZD1atF|6+Jhl}hhX}*+0U8_0?|Wy@@sv_K8`C~sZ1#)Uho^l7vr}Ff zR5u^t$}FV=@W}4JvG-2lnYCTEa8gOdw(V4G+qRulRIzPa72CFL+qP{dJN16uyL)%P zeSNzR|K0z|dKS*+v(~upImVo0Vz0B8kk#LEV%D8tYhbh5;01%T#?pdZ{(@m}Or2OX z600;aEwNWNYF2MV{v{uTRm9&*D-N6u2m$b2pB0}>Uptgwf}B)rL|~h%jX#163Xib# z5}sn0UbjPOJJCP1`B1O9QMNNrx^Ut}!7VsJ3J|mfUA=M~(%D?C5_5-m3=YXj;fc^53jqp|aQDwwnt5#Zn+st{pUXWo>ybYky3Sx!YL-iI$ zIHG2YAEvHwf5v?O3}!Ybh^C*7@2I0S9dgnw*J#+g$d5`uw(WhED{+GFy`aI1-f34a z9BsfGG=SHzaDN^lvs^(4({cB`U_>KoH}^{DjmB-kotpDXJNscedr&8F{(17~L;}Kv zrrFrDxlx?Nl47A4czL0?v{p=%tlY?s?3$GhVI=uO0V@Y@8>*T%nk)-nI3zD4m;mIx z(D_L^f2v}Bj=fabZje57FN`Yez30VDN6)HESotc(xOP8Q0iTEuD+RR=kA=u+i?2I> zkn5~pJ`eXGYTz5|oKgAAjs9$DBBlj-8zq%-k%MM&S+jB$cQ)h+Uq1K-I0T;RO6ty! zQ-<20i=*4mp@>OaiPZ(s=Yp*zABadnA}})WXh~YI2~sTO!EgOU(nT~zNU>Yn-y3J% zi<)>?)L`>dg&uJ|ZW@Cx2IbEu6*GJBi_=h3U&gU}o_!E9LXGP7dgwa$z_V$3UAu%%W)a=J*X!)5)|LRAsKkP5g($b(o!u!d<1 zBy!VXYA5S~;$BS)%{PlX%q3nW@E%B>mppw!0qppBsSu@dg&j?xuMbJQnv~yf%iNml z35w58xf&GG;SWq&80eZOc|0=SzPR-N+^%}DY?oCI3;_|K8|AB_7K@}{w(b?BIG z0#+|l>+S-{#fA1(sgqmeq~8IOIn)0FtQ}wwQ&&1MKj)UtG_(LpW)@2on=iAS4nxN@ z_$<794c~qa8*Q*@(1fW!f?3~6zGQEs6jE|J47xb2#iCtASDaQ7B4qbG(!TEYu(>;> znSAxjE{+VNtd@&xn1%-J&u&#N;kjzd*1T;%%LvJEdf5;kYLI=A&u~llL0xy=aGiCD zSV?siUtFqfTuR+H zoZ6{5I1#78h0r9zes8<1D6LZGx^>3ST6`4GY+wcbp1ikq*K&SYqw`QWQ{i0Cl_0H! z4mm5nm})6GduG&Fk9|3CbK9(erCDKUuC4`scr!Kct(ELG8GbFXAHS>Hj7haf>NG~R z7{>9_trqB#p^&7Mu4(nSi!HrYooS8kzS;&0)-2M5@KoT@Bcm6X<_2!B1(cr$oUaCq zFj}AwCHjC|aL-Q-JK9g)Hf$JoeyrSkt*5qJf*hn;eo}l|x-aQDKO3qCTpV%#745}8 zfDZ(Z5Xs;4w-3<-nYWyzjrg~e{OO=#0QQ6CdNpT-4uu^CI03I8BaMEu;L!2i4t?jY z17HQFulHl53c02m&a;k=N*StI)QECg=%iNmUki)hPgx0vd26@nR36O0IbOzq7|P48 z(|xcCcJb5}_fxX%s}kjjQGHoW_Jz)c+6H|DtXW1mRlkjiY8HVHhplO-w?5CqI&$$2 z6sdgdZc=eSAz^}V2Dn>4M){gV;Y4Zkb$$G>rcJgPc-$m0pf2s-glg%xH7`iK0wA4+ z((yq&3>~m&gTaY(C~!f4;CME3#Emc!OA1L=L?R7qV**ceNV$fGB_d)8{~0U8fm|O!=7y8*`sZksRU-$7^BUJ z=kvDl<^#LG_N^XT{BF$s0K{X&_(|KTr-&h-)W}&m$r79SYfPfg0))P#0{~@4 z@G(aeG~rck1Siv)l2~Nmy`4OddR?-`P1*w%e?2N7WkQxFwPk0bROvtgh2((~T;QGg3F?p`HdPE-XT|osiOs$BwZqksO_0xN%l6EN~-cyRTYf<;Y zar|Ja1Geu5HoB^w*r|bav(x9Tf1#XJCillHkR$5qn2yjv$?8U5I?*(Z5xE2}g8z$Q zq7YIaTQ}Yy8Pu$QKe;;E#T}n>Du=5z&&A!2@2K|NL#^DF%-u4|fg~?EJ{$qA3~dC~ zvXHsAPRg6Z>QJJPS4};U={Y`my+Awu0jmQ`{~os&DaXrK2K%3}uF*NI1@_CS1`zk3 zV;$39>Z010y7*;F$D@0R=iI3lhGYeif)x7$255#vbp}+Hh;5-@m1tQ^8R^K}B5Ia& z8K1a+qF#Ci3Gg>=gGuO{Gt8tDH_outW;$wfy?82f>Bu^`r-4jaU3e)GrHm6PZWMAX zV(EDfeaKCTq!THsDThnr?uG=lCV&OcXg~>A>f4=G)R|&ahcEWSX$LGuLR6@m!cQD^#`h zNRxYJ6Nk740E3@8OvSB5-K!U6?A$!ur7+STNvc1sYke&_mw`Tab2+O=io7GUC{Buo zS4tS2R$iLK6xJzJI+^d~JeHEcag~E25{NN$lUS2sSOWD9jGO5rj_Z#L4H#C~GFbvT zdMs5BTM@xl0zNWMI_}zPcRCof9|ywxGzJF3u6|F?+V~s~m!^&q@X>D>yW~X&|E*aN^H$kZ)OlQ zK@uoj2mP4sa48=YoZl&wY?^O zKuCHoI?0V$RrNUSF7rihFm?}`Q^jCSP=!;AU8gwp-5p{RMuiZE%PO`5s*9QD+{&Xc(V*PL#-d$+~v5@pY!MikfMx!@_IP`OE-)hL1WxsCMHf?|CL*S_LX|!J^sp$CX%!ZZ3N(Lh|{fv6+^T{M9)-#-Vhu@ag; zF;-fHVaA(pu6PDEw)A^I-*Z+qf~l(pT2(AB>*=}*!`yq{T$P{54%~~gYyd;IAEYb` zW23Ko*nDs@mQgc2svSQZD>v8Gr`EAAJL=j zv#1!!*w2QoN70(z?BJM!FW0W-&#|)Bj?m?5|oG( z*thk~>e~r^Ng{xyM-7Q4&vDnFJK=P)a8UX^Ui@OB){)z>61~6pa#G*X!sOMT)LC03 zQAtGOl|6jwk};YfONNIOyQl>5JoX6hPId=oT6^_;TAFuSS{fljwASg{!4NWzc|*lu zkwGfJM4k*3B?e6Atj(|3nIAV(uh-ixgSqO1baMMN!{dYIs1{RlX1|;VIy&Kh#U57H zaOBGwF*3?|@sL(*&?}ADMuL>2+oMeqB!_sMdxC+CE5O1wBc+sp;xE+`lK4V25lq8X zv`?3Y5v&hS5cP`oTv7R!Y)zE>4$w2+deGpC(y8#?AjaSI3|G=B6lxO~J zB7Y0G&J|2yGN!(s{YqrTtLb3;wTN34Jr=1z6hcy^JY*SG3wF9A%1i6={coA71)NBS zr7uUc$FF_$KjSQz|Ewls%Kx6TP)BgcMOlWnH<0TJi72}T4DY*#m@Y?hs!i?U^(=i) za~BJY-*d1)rG;p{@)I;;Wk^f5W8Fz@3@TuL(1cQ2q?S4yV}{;9(Ne2ll(^kR7V2XJ z8D5E<*BVVch=Dy=ov-X{J4O}I%BVGHj01Tx3Hq*)qCx%|U1IpNrnKRo6Mc)N%=!l_@KSqRy=W{S%C7A zYl^H{G6~bpFIipEo6TUN-tQ^yhkU<@w%?btxB(ZYG7NK#Hg_p&{y3VK2*L*lPALW& z)wr|a@}*QU)k4mMUPf;#%e#(*j)fGsgeApjD*_&5R6<(Gc34?T!T)sHT1S5h7qiq{ zDBD`Cpw>fu6K8`1){|c6*NF#2j{w{H0(KvfPjL@ zV!&xP-tGgzh?`g-?Z6BKCfsy#A7X}r$B%*jPTF9_;V91U%Fx(?KpU^rYwFOB_@+ znui}D3s*2@a)yQ>6-q~do_!U)BsOf3i;k2>CHOe^akKlX)A|1N@yKA0$~Bf)+kE26 zY(pxR15ilB7qTnYL@0=#h58iyQgN6M9-_davUZGpiSNYw#CUPHj!OMfG4rT0m~m8V z%=9K7g2~DZGaP<16r)fF@l-#8JD}cX@ZPT-mp9${s2JudG$wbSmt&hrb5@%9MO6Oh zO{Us~^SbXBEZl?tb68;cKVTu+3ohPRoxnlI5c_B##~TrIeGkawFD8@x;wKBA_nY!7 z+jA@o`LwhJ>Xje#9v=Zy3jX038^+1_s==ZdV$HshY*>E)mxR$c61d54V|jlszj8sX&K6f1}FJQ%E9Ck?8_y4=J2*4r&T_C z$)4OM8?$ci-W9D=xJBsnNT&AozOceR*i{RKYyF}J?92VO;4P}S=+8Ryf#EV{Zlij+ zEAZdb)1Oje8N$47>op&77N#sV06-0sfG+i>=B38iX!PgV;j>SC))hbBx1H!L2Pm^W zHgPNb=jSLKL#osF`*#X(U;Q#zAA79E;>#m7ri5W1G!E*~5##TZ=ADOT@6{W2e{ax6sv!nqprwpobd_=e&$WWYQ}T7S$GzA~hI zPQ-FEXZucDvWk*dJPl&AB_t;)3%3O@B@7?B+xPvd8nbC>d^gyWfxps6VA(#6nZ>P} z=22dO%-d{=#s1qyZWQKFYn;odnpY{Y%LQ8oWCDq*l6eJsUY68?S_}USzDBSX-FJWiV7FdXw`V2yVjXGYZs6_l!bPhqtdOQmJ0IR14Fp21{2cJ*yuf*K>D-ZXIUb6aZ@xr4CjtaW1AGW{F#a1 z_n;NP-Pt+@n9OFhAmPt;U8k5ypL*-OKyGj_X##=SvY6Ii$k&(wxC6><2D|%wVZh8l zv33?13ADzG9H;^7Zx!jEf6IvVCJ`ZZerXXrUrn0-Y+Yyl>jPFj|C1%Y|7(`0Lx9Xk z{zDA|B+r7j5H?HHzD!Cd&TvspE~~Ph>x&UfjE`rH#N@E_+mCXf!o|_P!AX~RzE5?? zP@`00F;z>8yrOh7EGD3it83!M_Gp5N!BUgLL>7xr2w=xvFZy|RaCVrftwJjGJ57XT zzoykjL!DX&z@x?W5Zdzn(qL!}O!Z=ODl+oF&730sZF`0g{K5agx(>a)-7YjXhB+I^p&ytHcv&*7#R|*D z;EJRdbt+e_deYPFHbW_Hs> z?c}wiX%*`L1Yw~zvTg9T6V}>-^m>+L`fG|_5B`vpPnfL(t0ZWg-x=>HS-TNF2_Lk( zW@zz3EAomy++!_lD-1jmyFBF$b&9bK3#&z@N*2lOfRlg-QcDS0gq33$fotQoIH<(f zf^3`xsA@>1LdnFm@GjX1#63T8wzDS0wt7JmMMq=_CfJJR;H7EzC&{N7)i(KHR7eM7 z^~obRwaC%7ANP-S`Raa#b0#Cr9m53;-EuIR^54Ko?2$ME@QOO=F8}!*a@0MSIs@>I zzU+ko0895+0tCoj3c?0}8~N+B6?PTSk?S_Wb4}&T%*CYz)MOeB(!|lZ>)}T`EI0G0 zWWQ02YO;Fq8Gvw2=Cy6iLJ;E2yT4v@**26786k%^T{;i{6ClxZOFLslM z`ojI$&+Dhq8aNxbdK9$w%Ru1gQ6EnYfw+hxzkq!fv-^dSp_7U za8iKhgc^2-dD*o^$vr%+q*g#DLR*dBQWwlN%5j-^Z~ILQVQ8Lz)@#~Q_!C)w8^od` z0LB{9!erK5SsQ4e5qffY8pZR$XfUnlxpP%3eH>kgx7JWsj%)NR$k|c$IY-AdH&5E6_d&^MD;_0YG11R8kK^T*P6pMbfa`^Fy(-l^zn zZ!VSJz{RtBe6>YkO=q+yupCpc@zCg)Jm!jAF5tP8vp3r7<^lst z-s$e3g|fhI-r80XY5WwxRa-+*Jlod7p3&Z}C^}JA5mm}aeL}&Jv2M72Hb4B8*!_xZ zA>fLzI#IF$6rRWKAFMUnWD&V_N&Hbuf1y1mrQB`x)xf@sW4T)DvNC`R(E8(`uOZz9 z{c!%*+2+M;r}mE<_~=4D`h}vvu-T;9|b;UshrJi z8EPbDTD?G=96lp)VFdLhP5z*VE;E%YV=vK<5|qK15r+CL2Q}mL>m>`FjpIUg8z~jW zr?(3u3eZgaV+Xsi21(833k7tYv+rhR10suI4Rb0<@TV`%Absmcm(8BPwH}q}IVG88 z;`UQP_2Z20c<4(Tt$#%2(WZdlJ>$a9raaVNPcgxqn+1Ci?B zYCQtqf}2I*DF_J^d5dnv9tS4mW_|{y^2~@CEHw|BCzD#N&xd^o$tULWlB5IXCq=}c z{NQ=9L}R1(-X;jbKY+t+4yQoUjnX}Ekqo$*Wd)4BwP#Wq8+0A)Ath)zsFU7sQdR zXk5cyoziin|AWv|JwWP)--C`}%}@7pwNjR&H}D29_;0fE++j2#~9RIof^8 zk>>`oW1e0-S#i8o=RhAcRt>361~Gs4i3-3~;Sm@`1oua`hz6@1t>S@_&AWpl&5 z-63TW@F00W{+v&MM8geh?Qs5ep${ob8+x5fKSxHGwFY2@4fiOAZWa$ewf@b%N%!W@ zc@P(4>CA0YghL|-^$VJUVIxPqcGPO5Xl5~?Z{*t0HBg^sCLxFh?oE1^K+LX>f~z7h zzKg5K+y?_g8`Z8pT?*lIvR2xXrtIST0JAjlfM!bY=Oots@^2p6)Apr%Im5x-lhK`yPWfHNV4(q3ud<3e5MVVSe)u1>x3ZOWSz z5F?8)A*8bo%e?JyFPzWD;jWGSTfTjb?^nsrmZfHw{})49ICx?%6Vq|w*Y%1~5a&^aGJY;Bm$*9xSsx}N zT*&GKTH6XVjMM37^bH+e_2-|HYX~vJ_7sw~QOYOPg0g*1pkK%df6;Sf*_wO70O11< zU4Q5~sC?h3J8QfzB%h5}j$ZHhxY@tu>GXJhy98Y8*DUa&C{$x9m*eQTWG9N|zM=Em z$7uQHGO{gdGordBL6a4;Anmv8ao*MYUN<|3ThmZ%cbiDvAo5&hu(VJNQ0hoTf;j3Y z%)D&2Lu3DLO|`OUbNkamP(J0Hi#7^_Y7E~VF~>afqnG>nZ?zt?Fa}riFI_w6>nXuM zsVJhO{R_xd*1v>pr2j2!LnRf7eTUL6k8hZkZh543rZ0Lczm_!q-@?_;;nJeb`FNlNaq4g$DS9zyGkeABoznXkST=wH*JHM|> zo$G#O;(;pVT<3{{XP3&QC2(OCON=>6xd`ND6l@h+s9Df2$7z;Zn=Gw9JcH6NU$lF(h;~sv|IV(dabDooE(tc_1eY%0c zsR;20M8Z(7jDzr_Rk)s0t?gHN(LGzYB5b!~kXE{@iUDVVmiZY-S`0CU2N+!^G2qJQ z`)(*xoSM$?;+ix9L<8XBVEIFZ;lz9wuGA#B1;E~uwn?Y<{|KsTo0!q8sdj0v6wn3!}z0!kaN`MBkjyL7{awfGADdg^BpJ$*^6ES(BQmt znu!%A)1`le?a`AGXM^Gi1f%@2Lw8wz^#SfVW|L{aNIf%}aQ;KxrDXh1=Bp2=H&iBF zt+_V1(+cWtEYCbcQACtHd=fG+az3Iiba878d@LH#1JaG2!Q2n&(c zMvh+{kOKBRpj5u*jKVN$dlHq!HRY8WUF*-e@QiopmfMqy%92={jWtL@pcZu~8gjVV z@Sm!?`z^79ly_cb(GHl!3nJ!3A|_?Zn{v*L6hwB&)J+IFNSU9aVKkA}U9{kGX@Zb~ zC}QDcQUrqQv{}G$oTHyX(wh9$(3f}!+LZ@2n6O=L$77UDlu0H)7*BG7bP(TYc!5RW z$Re~vSsj2_9q2KtVQ=SifuWSHeSwd5P)C39})o-0UV3#s%UTY08KEU{Y zLxnoCaOo!gyd^>Q3bgE&WLa=%`J+qUh=L!!%oP&#fVt7ZQA^T>wuk2k?Fq$$*re2M zZG$(;+ZwKIVp8KfFdTapEPMIcKSDaN3bdD%%B#{akDpcoz~Yc^i5xCgo}P$dG{6~?42o(jng?!Mg$s(^%0=t(vIMns5s3*83>}rcSn)% zKA#FRn22gzT`YZk)!=+#)yvZ*mpv-OSf;4m!uYQp>68Kd36oIyC|Xur#z-h@LmwH@ z-!nwFcH`+Age=WKVS_e>mm3hvP6^K$cWWWs8Wl9?)u{N`m4BnOx40FjTP?0 zbLJhi&%?1>w@YwcvF+Jjenq(P*rRZ3JmmjS;z!EeGoEkADNJCjhg%i%Y3k6)tB;pBU7HGMBmEs2sCX zH~Nq=RW1s){!y?jiR_Ug0up@Wlbx}D_1px*5}mE2Z8(1!Qt&R zQ`i6{uogR&TdTd~!72b>bJIeC-ZgYtl<-@!HHJ~Y#D%itVNg~B`t7o@_cXS#`?nic$ zJ2nbO0+S{^10Y8;7LA+7?Z~yW%IfY4L6HTE26k}%kc!(SnCKhDL!=MKtG}#}-~vJL z5bC%3Qc%a0mNcR`KDrH~kCTxDba$)pyX|PJT=tf#GHU8*t@2u5D`XeB<&n~GU3lnz z8e}y1C=%obgDStUF;Hti#eF_gb;YacdnIZ>~Gj&Z!okk$1KY^R#Ei}`d( z4gCzV-1viXC3x-3A_AK)TP({Whur8Y7hd{ED*KNxqU!X^ z<14Ms-0bjteuOUx!#R-YWcy1Pi4@orGYQw1L?bXo%L;zR(a(?&MVKYCVdziCiCbOs z>ECUdb;4~vY8CgQF>uS7WLDwggIkI(da(V2avSR3-{haaP)_^seYKoKEH^bzkmf%0 z3+1#0pSeHztY7{R5Ra|!Ae826qY2DHR_kS?3kpn*D^}O9O?&#D= zX*nU|NI9U(zG4z4opJ=w*wUlo>gQWbL5j|vzAwwHGKK>(401|3X!0 zculBYzSZ#j3gUm(oe-X#IOx8{veGmE2ip2y!}}itd#3(wnJbF$`I+Yi+V}3FFX_c+ z5K&uGy^KxHfoV|#>z$2l*WJa(kve9U=knVvY;`c1bonH(VK|6ucth}TSUne9%0W(X zvC?xM_vze;rF5+Y#UU=Ce@NI$a}_~IzCg`}t;VZ47|T*4B0P+7Vw6ApOk;X!GyUz| z%BoZ^u8?OS0;&ExbLdaBukk$b^VYN`vH7a~ibF^1CVTJN?lLt2>RK@a=ruHcVR&HznQLQw8> z<{9V4irScW4Ww=GRH3<$tbJK0{`BE+5NUt#Og$b5x@+!|!Wb4wvur-M#FRaO4WKR+ zHTguT=4h)}+j*l%G2SkWY3ld*!Oms_`s6G;d(KQjm~{G`E7~rY>#4a+8yl#@Ei3XD=RK*j)@ux;Vo@5)-G`NUR~!HJ63CwD8->r29Ka!qX8 zv{(^@*JwR&)K^1B!7k!__@Q7w#|WLQBZ8FHhc1PhYZMI(7YSl8ik>ipmr5{@&lOI^ znBrOD=-ZW2?3%v4$x3WJ8>x9!mA`3Cho1q+K`ay9LmP1irnYP{bj}jqR*gA)^b37+ z6m}#qKbHU;!>%-H9%7GLQ7Nfti#fbuMs;0Fc**T&VvQdxi4W;{-fx2r;{?C`(OhF_ z8p0T-tkP$Hl)d1CY}6{G3YY~A(;zUPyP5fE821U`=lQY=B=rf7ses$NItUe;@e<6A zHOV>HD@SX@ojncJ?*2l_n;<}8`iY8y7nvN??!lPlkI&Dj0Fw$bIq@b={9f;=44F9z zj7%rxe*jOi<`o8F_Ng%;B#%;@5N003(@pSE(;sG}%(I?F?f42Uyx;PBlvE>6rYec* z0nJ^TE4v^=(!j-uofuSI=4apiG^@W80=u2b-goIPbf(nVO> zSXLc-2O-kM%yLQ`pX4})W5W}O2XdbT0}bW7x6zL3VI|l>B!u;jiI|al)=qydzKV3I z{vBhuVrv2>O=z)XW7GKkXTnlFms#q2L**gm9fn1w)8PnPx5jz~TC17yiI|3UJK0*B zm_myhx{2URyEEFNE13R{OKY5_=*u-DYFh!-4v#u1X@CI31_U|B=8ArqQBQ%TWHdzf|(EtLjuv679<5=P+hF`{k=W=Q#u4{)JT#6mJ*5W@6 zPR8I40RWreBsouXBcJCY*2q&Pv@|4Zs3GQx; zXRsq$fu`E61aKG~cr5||3}iB;$v91QtR8W%I7m6Gm>@o1t~nYwb8G|*9fCg5oM=%D zEuo(94m$YUgi!{v3LK3Z-YH96fPHR8~@f>Ip)#QQ@fl_CKW}1o^M<=ndm#!tYjE%CV%g%JfvC*zjN{GdGZqi?_Q312fyz1W)13VNQjgMwRg zUk|iJX6zeqscxKdb&gFh0g+0ZxRnw@YXNRJDYH@pWU&cZvGNROOHO1MV7o)blh7Kc z(HGUAv{h{6n5|FsoxYvIK&afpCaD|Is|jCIjLxeA0T0txVB)jP&bwp#3WkY19Lju} z=C|8-x%yop9Lt`G2kEP@BfZY@v0S6r7V%VNe~{oAuLewf;$EXt0_ecoe76f?T_%8e zRl{=L1Q~^eu-(7U7O1ekz$@e$(yI(GvG#vUjwY;-4urw74X^`cJC)j}z74^+gTGk> zZSHCITRY{OfHOK8x={iD>++Hh=V?eqj+Ou81y6<5Df*Ub&tHFH9_J10`P5HydyNn0 z4)1Wy?wxQ{hjWz%_7ugu5a3ME}V8&98K zS*swzf7oyQP0QZDB(47@lbif0rY4u?OYey-`%+4P?Op&v1^*}|A&$Gqfd8hH+|CnA z&;#>Hh7!PDwjUk^KfJ;w8tGXWuI@W9)n9WAHW(%>sA+3Sp34~1AvDYv=Z(bXRP4=d zj7)r3Ki$e)rutP3MaEjRE2HQtuJh5?tB5m!#)&0X7$)0ao(L;jTd6e~Aq(!**q36-VT$52S6>DUSMy*X zs<*(?NGRoB`JKFAsSB_g6z$SNMqer}j>bC6P$m>(JhOI^QmZV!Udr6rFrLF^F&?@* zZfd@tER3eS61P1-JFcmWIh(wu?n&nu=QnDkae@M&rzLH%WnRid>ME&CL3s{3yKd6L z-fV2ylCsI*MsG>GysBtC59-8%OJTyC~2vHVk ztT;-4CzNg5MpW}symDZJZ$(^S*lL-K>TEr`c5Jrc;w0ZSabZ6zOisItr~oLAeWVf| z`Wr$FK($&IJT#h!=U#s>_+(fPUV+V-4)k~Lq`?J4I`kWC1l*9Llw9`rH8mw@K~rtF zjSAyC!;=OzXj^e5^ASeL^UKtUimAt%aP;g*KWHyBL^9;o;if249zF(e}u))#|H?MC)pYAUxFXR*QS9hGr*!mry0|kGv$=i#Pmsx$ANT5CnRNzuSrs zGnVW%d@zV<$rVLCy~RmvlS>bchR1QX>+4O9A_GdFAYc&$^s~nM!I!ptdRnKE`N$rS zRrivSud-+tEC4+K#cj2B@FAX2gfCUumi-)GR`K_nX;$Y$CH_+qli(cIK*@dUtltwHecG2!l0$N5edfoBaO3?!13?N?~M1V zUVg0nOebHxY7-CLH(BD^hGlPHGy9lQ9uJ7=M~G}8`QsSfj2BEdhNm$R1J?nx3=zb( z1pYm$a=_0HG&Z-P-w*-FpC0~T;gNGGw# zaqy7H`4qDJ6|bSWs6PJcn`@?r4DY zILL0AZJ&Gev7dB>G~NDVe&haH#!IR;a&iBes%Ke)3uXcf9`0L*FFC8^mbqQ>VDMD5 zVD_mjOTlNaP1R7=&qrHn?QWAD>j49t*P&f}vETyStc0tC9ZFm#yy`f2-=8HgOW zvQGEUheevr&iD6k7y2pJs~@TkvzT>=z}#(Ug5KXG4Fm~sVQ#AjWydtddwIwBohs^Q zbzN0BXrEZm8Shb-nH?-Wp}QyWGNt4tEw=5xCb5S9xJOw2Uh1NAbeB!F5+!C=Lx({= z4#~|Z5V2syT6Xc0JxdG;6)2a-HS%QQHF5mGOpBb<;1I)+z?) zQGku_PzJZedQ;IJ&TXePP5Lw=ovmYp;hrBIZ1AwMf`WB)z}G*#RK~16c+IIoxB

fNAT~>H$4n>(O=usbd&fO`f7>75}2w@6^7$b zLyW=JdKAdWu3!tdF!{1hfJj=`UnjPjmzoL8z93^ox)@CF|0xl)$r9Z_3hlwmqQH z%u4vqlPWi5TjN6!A^P40yHO?-G(6E`qged3BdF5;?)pJsyGU=|9M@c#eKD^#k^oPf z5$q7=;Z9KQ-*PUgov#~M)M37gs6p2*h(NxIsLMsf#S(JmES-x`$Wyb~RASn_&_>-I{VHi1edzKfh6Hk=Hf^oS0WaLbeTT&R zHjGUJHLNg`Md1V*gGigDuw`}Hn)6{JOlHW4|005Bvl;sEwyONQY-uiK4?V(5VYZ}poGg7Z zEB&CqROF$;U+o0G=UEc0gRj1tX2X#FVJGQ#?+conL7lH80i(8m4TPlU&P6GX6N8I$ zVNP5u*`dG;;K0ljf?|ER;2B5hS434KvS7p#!-t55_mKHzodaV?9khTQCUpfMlJ+`9 z6sSZuY^_(n@81@7dOp7$Um|{0ZA zvktcf>_{Iz!Tv*p*}Y6Ua?baH!gkC1TKy+ccx`<J`RKlUraWHD|t<4*XMMs61jAGDP>pgm@Q^3=P|JV+^=nE-Y{FQJbghX%Ok?E z%5tlBtgowjLZH{T9|Wspt2k}4dxB6J6I7wVm7rRfIZ~`f$tE0d1CX5%itYQICUpe{ z4RA;(4#QUMCtoc&NDLb#qwqo4}`mc0{yL0H~VoD~;>(jtlvk;K^5- z?$hRey>oVbTRYg9$>n1E@U-~6mTJpE22*2O>Gg7uiQ7^4@o_%5DAUQbD}?fSl31zz zetqawoQP3=nbGe0akl^X$GlB@pA~0ZPuWtG?QD@D*z&0NmNbH4mN}>{$^3=t>#Qw2N!NB-Lg&#gf?0 zsGK$e=yuONrGH)MXo<10^I-qN{+o@AB*iGvUkUZuTh0qSV7n{%b zd~G@QvTOH!B=~Qmm8RnIE78XBJGOEZo3e!p~3{GN%35cNK`1IfMn z*wXea-skM=>ou zZO7%#53)*$hFz&p#lZsztJ3#de0fqnMX1W=gME{a*_Pk}HqQzUcRdq|W9RR3Reh7^Uz_J#uKQ6Y42L@TXl0!fd#jU=ZcX26?&baIj+IjIgVM2JOc-Ri>&T7EuEYzA(ZL~Rz}}CD+1Bhh_)%W zr5;T4UYvuz6O8x8v$sb3&5asn8AEbYiPXafE&qz{@hsAJe3ciep4B5#{`h)L2Rd&- zC1_>v|AK`Q{H3C$qN1dvqNAaqre&aGV4$a? zr)OkhV_{@sWum8N;bLKB=iubzWMJmz;o{(7rhhdp`zNu!AQ@@@joua zI)IfHxJw35kR1fbS;;6^$%t>jl*a%W6-ezi!T%{_RB~)jdPk>hDH~SO-wIcwzjdgvv+WG^78h%?(63t5FQa36@4=% zHZkem{Rhbp|4PZoe43S=^DOsyamlOF*Jb4ul?{z=nwneQzI)%<)!ozE_qqSe=-Bwg z

UpW_J18%Iezs24)kx&DS=cf0rMOk?_R|@MunEQS^Lh}pD`Bpf5h28jP3CC1z?~c z13Qm`6@UVG!;IJ? zE$@9ncqIj9uXvPUr$IMu$Pf(_s-&y>d3>{@ucL6jRvIPGKjd`nQ_3lFc7NJ7ShiRF zyaZfJae#RPUkN!+1dctDvb(JmVWHv?Js0O57#H6eSsVF!bft=CWMjtAF7DGa7JMa> zV#pKz=!%w=%!LlGl~u}Bg*(v47gCON(_Y4M4kb4aqQVCXsK2qMBG043Kid%QD{web zLR_M^2t&--@cZQ7*yEt)*5QLTA>ZGj52kl%L|s2wztkCDrrgrrP0_I-L-0`$;tORS zc!EMr@0kwV2bbg9!M>0pss2R8?Er7#dGB-s29l zM*>!FM?lBEa}L>Q#5=f>DJ0}ZTJ+17mE00FzEFCYN>wptAQc_xlWUz|bLDM))Va5^ z6Z=>Ui7T)-#?M-S`^YT{o)~_gT z;T4Y04#rv|(yLvFz(LmqOuh zJu9Az6O%~o;bo2V@Foq0fqVXiL11HhBHM99U=TjsO9c3;vM|p@VrIjmV0#=N2QC-BybXeDEKt23y$W5Hq?g5OInDYjzPX70^c+;RTfSMvI)Z`G>TU3Hdfrd;;Lk$ZF%L7z;U`HWpq-22Y@g6GVb@tB%#%U4UK zwGlDdC5%Z299@KyBmydgM?~O8E`bByfJC?B>9KAE@*IruQgj}4GYE<1CIavNA_5ML zn@~=IMmrRpG}F2dxhz*>olr7m8Q`e^g>?0%<&Ig~%L%V=T?l)Y5t7=4J#Su zvKCsyrezs$T!OY__G3I^4Ec65oWM?x*dzkwL;zVpI0aW;_W6)9l^TZiygYW2@M^E)xD=7C%ja)Xo6ife0Eu9{erQev+VL%TyxVeKif$}b z&xrO%i?QBeM^WL2Z{nC9F2OX3z;5~K69GCR&n?Yje5Tmfu{Jce6kKPPV5P{7@ zUH)0p1@lMVjB)>=Z$w~JpjKiD_SN;ObV5=c|A>!#SV-x>n@Z0?iNY#>!81(z zl4;yU?kLo|wH5@^lYndBM2G+b5$Hf>6M>Oq@JR1kNInsm1Yzr7MBuPZ2@hO&TmGX# z`Z=5aE>0`{mM1GP``eM5a~Dh9*y%N*=ToXTjw~_p{pf#-HOgbU|sy?2h@4wxy zed(4&1SVoHJ(gOUCjy}Ue1Pm0RThlLe31uP-j4TiTQ15$j>0hZgh>2pB0y${J8Dv= z$fwRwNu9#8FHF=BC&Jmt6F~&NB8G^-05?8Qmk_+&qqn3*9rp+eW+cMtv`^kNiwpUt zJ4%nUe?bVwcGpn>WTATfg`Z7b2DaWY4-Me#Q{fhP=OrvcPFIb?5CCTa3hw6NZ-?iG z*G4^vK*pEa0CZDNb@4RU`wtrjmwj8p23=(~J=!g95CKV;3TA+Cb|{cgeFC~_X7V9~ z1=Yl7D!{rPF%qT$Q*NKsoTur{zn-gjf5Ze)s?qO?itzI>RiA%!drC4q4*!0mckjJ; zeb~uaNU=_d?=$nZG{I7%2gW|eW!G+K%FG!TbdNO!Uv2#yw2r@kz&JBwlfl79p-Tkz zW)k=s30X~GcXbhg=D9S`C@A+qr|n9>SA0QZ0v)~U(~ji@`xLz&`~afTAAFRKH=Tx$ z=0j)AVK_!8&Ncog$ihGZFAb=*=_&1?xQB5Lq?igFpeL~<)0*U#w7>zpuH z_S0fAqzGSxf7J>5;yM_O9D62bPrhy&tNs8ABU70Oye0zX*#jY6+^wk?O~U#xW=mE$4N-+!EYsCWBJiCt+|o#t-z)j< zak=&btF$vWmj^?9+TU%R#JqM1)8#QMKRqO}6LlJEEa9GPaKhW<| zI3I#Yb0!z-hc~%je&m3IUAw!Fu;B8UEK##X-bX>f$sV7AvpV$tn_u%6_4^ljN~`!e zf@-$(7o)e_*4~31AN7I=&Kh^=&>}Xj&l8u&?1a%U#lXkm3(iAnJl#X` z8(&%}Sk%YE82$XSC0WDc`1z9+mV)<|4F*%|hc=97or=wS=WJ$Fw1K!()>H(%o}XRU zxbF4PEOm{*zY4h(LUs*hQX=~fTH)#`4v#J$s|7VU5^(xM2FE+*j6 z|56Lza+V+hPrxTP-eTS68FC0=eFQ4@xh0HQ8rdAa$R2?m`}&ZulmpSCX+i>pC-eH_ zEaL~ucz7UeYt{?0a|FH!R5B-eXF4WXNDfI$`n^gRBA;vNG*o5Sorjw^aw5@(9pZ-n@MH zotuFQ*8WcFYJv5mDYna_pq+4i+kA=Ngxg`vjR?3YVZCu?XnK3On!nmK@vUA7;W&jB z(3KiQGs6}F<%vKa*J{f~ung9ub#9ahaOAsNkAf3eNI?{+v2TD^GSM-JBY?FwN}x}%jbQ+dIg<9`pHr=AB|GiyP-3D zQ2}{tf24;0D3YVqWzr0%h>VOav=y&7Q)}>j|>y=u!6=Za_=ou{vt+cMn2F|~-i+t`@tV%{O{m)fpAe!z>|x~_57b6;*=wE=8>RksK^>gq>Rv|f`2pSu-c zy;YkUd<4RUBQI|*vO5_D^&GUcgfm+;1%-citXiO}B2GvQQ#a^}{-gK0JDQ#V`^>A0 zrz*nH3HP;vhwY0RY8@Xve>A zd|{(YUu%_qLJop5S9^A;Lr1xKs7-y!tiGnSd4axRB@#!i;?HF0w()%&ZPi`+^0q31 zRs34&{JupV;bl&_XBX+7P*DI(VHqWc`}2=AGCX?{-;iBY1(l;al5u1EI_i8m!y!d& zD*d2T!obw;rP-fo6j(IC7B2) zpBhc$w0F^N$ltmM58)VjR>%0RWo6&;9OzJea@v5NxO&sOO-Ps@**LJa{&d)@*(zFw z7e6zX29NH-Da_iBn$5t-=OA3wnp{Oe;co(-N2V!py4e6$@jOGC)8^J6f@f+`sj5uw z9$Q^~@^I!HOkiipAntSQp+4SwaacGryz46xiX3(GOD05JF$0~hEFv(rZE$MFU|3!s zHyjg4Wo(w0u1$Lf+lKtuk$CfvRjda%bdr%;rw2i0J@S$WT+z+hszv4~_H5$8p%VB8 zxhgR`jM*;+dcGPs(Iqy}0dLKNk9Z?-7rB{1B$f?%yCc!(39DEy5D8JH#km+_-o!GK zs-*+!dD+|o3^9x@tJVe`suKmEed`2gY9n~V*JUw0LuDC(27IGQ-+lc&9v~IT^srak zfoK_-Z5ctgWi+=!1PELkG4N^I9wb^0MmScfEyh25-qNx5fRlcv_zL%eM3nw8FT7}S z?uPcQe#wR2K*S@~vjO802?*WMC2U}a1u9jIbuRuZLI;Ii$`pZ;!)-yPXq6oTYN+~i45W@Vh?o5+)E800?clGUy_2` zd877?fGrgI6Ck?ijiT5S@*e)q9y!NwXS>}FCfabjaZcPk5O9sZk@!(@pdKN> zzJf>ht*pxg%-Am(quEk~UdIRLt!(|Q4e=PWuR`F>K(aA-M==A(JU_wz4)J8~ zqTdH`6a}jX(Ld*9TLg3)!|C2%*j$*3D3?-N`ny1{Vp_5n` zY~xvZ;Nf6gyVuH9aNO7#NY3CCh=6WDkOc4DmsfJUPDn7TXsl-UzYH|JbmvlnCNxs$ z;TzFrsJ}2ek|6mRu84Q4e8~RkKfYGo@&+zOZVB(-3eNf|Xyl%Ah%aee15;-k+eB9+ zvfUfquch+Kw&=dE>1rANCOC&&Lx~Z>oEzm2(KSBzyVP??<>N_-Bdl*j3^yJw$EySw z1d^@Z_W#(|2#sPl*A~R8N7-FJJ{fECQXYl4ylS#_d$s7En9#Y!Y!e@2rn)GZLn(AI z^GI}FE$EtbK$LM^+jmZpSI|X-8(8Kk1bF`7`b{J%13s)0|4NMrD6kW-9JeM{6p9F( zz70q$#WXYpejBp8zH^h}CvM!T?$)$%X~BA!sI}Qmlw{nZ!-P4%%+eh08NGj69ysq* zjl%F`tB{Y-=6KA-VQ}$an)wOAk#K5CG}q5D`}(&ND*Q@p&rmBf1oGmd!ug2`yVnC8 zGUkV*&&lvE22MRR`>+n(T~P|&P>2D2KBZuq72V|`j;*t>l~2&6bd4_ui9lKmct1p^ z+&UEq!yQ|Sgs;+cz`+{@zEWqj{b&=;cA;AKskwlRC>u3^b$4#4{SN~suY&fRc@?Y~ zeZ=0JwQI49-PkMzfzH5@fev9dxXcvdw6`c6!gSo4%^c&VS*GI7XGAAC^R7s_=oDt= z8z!JWp6*12LiF2iw!+hYATRyDMV$~-YY)y`yBPwP&UWPOm$Spv#qwzPp@a9^Wvo&t zl0U2${fkT_k`2&ZT2GbTS;+1R>ZiKUR4kOQ&8>}P;n!n(v#yON%5H>DX$wHbJ|@&} zSPUV>jaL+`ceneSe*TB<&~KY*eLwZ>V@M-&WX!?hX)M!-r>qY0v0w5o(*NQO%geQ{ z1L8XN)!O&QrW;Z5=!u`yzeKvi;dpIjT}HC66*hUHWQ?nhVk6O;63)8@x>u=&vo@v~ zu}5!!_bz1Gmpi-6I>n?m_h;UjIvn#j;D)+{Ncbm3+RqLFPq{xinHXs95dzb^Ot8)@ zStO|eO7FliY#MEDchF-7cLfP^vNqGw+Rk)xQIu`?) zt-!w3@vouI!o1R`Y`ABzEI|y`I$Ur$;})5|i|wYTOZ)jTHpw~Mm2G>V*eb^B90Xct z8qhk6=`OG5dFxvq3w~hX-n&`fvdC<{jI%(DFQ{H_U9lXvQ~p74ybDtmQrqJidz{M9 zSy)DTyb$UcECV*tK2QL$P3j$nti8d)Yv!;XOUBPK>Mn8>dnCCA*l!4TA;#8lHQ27q zDDS$J0~B!!H{-BGfE)Az^7Ykj6cwZ5J~FvWZe{j?{yTRLX3Ie8G}BYw1M(gZHBs{L z?N=_Q9C^XX*9&_@J?PVHCCra#0zH!~>0+;NSGjSpfq1Y1d}Ysb@KgVfNJGIATvHY9 z!Y^6CbpuM(xX6KIc{|f8`wfl1rBN^@-oW`#(&nWlEoGu+o#1#;fwmgJp|2+Xw~P0G z>pzs(ucu8x$pKIUU{V9{o5j!g+wu9}qu1cY4qn?w1bSOty=H6Z?SIYIYdeD%!v{^K zFmWEG(V7@v2STu@s=gpcgMf(dEZMPp2WFHUGTFw5Y&X9pihYD?Wh9%<+elFmN66SJ zPYpe#p^gs>w^r))81is@W%+`R-v9M*mb{0qzgHfI$y`Ua!y|Xj!COO{X9${<5gWw>*P(xa}?$QQq3Mly*(AV z_+!UIl!~Ds>3@H1y2D)A{i(|6?NA^vOosJ8%w2c1_5J?c={9R|i5GMm#TlZO&f%hu z`1UeoH$3;DjTkAW=%fbMXe*yc$BbR`-dZbn+@Lz+?mXXD1gT1sm-cCr9?>^5M2`wg zGQ_>odQ?0Dxz+cGrcInS^QmP_=1AVSPl~8&x6l`f;r@gH;v8 za#`kc(l48Jh-QKUA1MtUwPH7A<(fb-Qql$%rFS^96r5!-LS#!jXPIsj2h% z;lTzlX9g-=f6wRUrreR^`VX3nJiiw9T+QO#hw!w>O{2Q)PQNu(>U7(>xc%Bqz1UdV z=#zIAtmRl`rStJ+jjZ-YQs=D=>D7>bngHumB?)np@0VOO)c$cM4?g z@89Rx$)EikPxiKXPs&N!a|5}vaEMpuu_3A4lyz?b?-pP8M~{RRgqS=1ZKwF|a#F{n z21-8L)C=FLQZNsHLvxb(szgbCJ@ZWc$Muz*+XeYa7H!HA53wJGUUtlj=!aX=zE*j= zp^+O2;}t>qN%Q5X-8A!63TKaBCRa%3u#S4ACs{sG6+iLF!>DE=8#+TP!|maDS&;B7 zA6{SwHCU*O_kHSe%|J1-NYUK*-Md^qd0(mlAKPA~s2L_ZL2WCu>!LQP9pu(wk6!t0 z-oH@nq*u%BipgkFz8+3zPPrU=s2?I<5MW=;+xYx6wo|xxN?*>oyYpCm@~8=gpn@(2n@<{lrN2lzXu!OfPSIc!!bOoUbVi zJN-h3S3yXVBMEpVmDQPd)ZhF=qc)oiMwj>kEAr7ZPB>8mx* z9Da24(jnDVD$Hd--K94(gczYXJgl&4 z!gznNGEvFTLMw_+WF*qDo=e@4fsVe-?RZD><{Wr&esFcn(vZx66{) z@-Nm-HtCAM2*h!G;d?0THj-pU*km7&F$<-qlULp|j?!dRIhEOMPj#<>`Ng#tiDo9T zH_`_TAEAzg2R;fGtEUW5*r#)(np&J~;$qL9!?(xgSqK-6zT_{qL$lmCXFVRMTykW+ z0acgQ)Mw&Z=saGkJZ*HpF8bjj`TDiTt2nIPdk2dCD;FK_$J~foE`6W6Ce8e`XXrCz zMB4bTItRqf>!B^{S6{^qt=J3I+cVXP2c&U|<$&rfBy{Z9b0? z6J2xqM!~&%mS2u#w_km2A@=I|)lu4hX?8xYX})Y*~6X~)l11b_nxLDxtCJ+I=^7%6^RDLviP2d!)M9Ed}D4K z2bRDK6tFk0zlwi)%mEFNxf-;2ljkgi6>(;8-}1xp$IBB-{HQ8>5;;bo`J9f*9Cr8`_J(DMbCbZcO!)(O~t(f_sHqr;eI6M zCdDJom%D?f4mwf)M&8L^nnlvYlskB$-n;Pr&ZD@?rjVwoB&C!zC*uxsoX;5UxfbNBK{uvQ_P1Nh2PAApAZ!WCwvQ<+q_Cq-2n;1Mh%b1DA%k ztv|`CFew1(TI&vgX4wybpH^N;tCKGJ?Nle0|ET`c5+G^ypVyssDg!`O - - - - - - - - - - - - - - - - - -- You can find the message using its `message ID` in the - [Tangle explorer](https://explorer.iota.org/devnet/message/8d4fa37be3c00691131c2c3e03e7b8b956c9118a2ce4be3a8597d51d82ed2de9). -- There are three prepared [payloads](../explanations/messages_payloads_and_transactions.md#corepayloads)(`transaction`, `milestone`, and `indexation`). However, at the time, the `indexation` - payload is the only one in use. -- `data` contains arbitrary data encoded in bytes. -- Please note there is no IOTA address involved while sending data messages. Data messages are referenced using their - `message ID` or `index` key. -- IOTA addresses are part of the `UTXO` data structure that is sent using the [`SignedTransaction`](./../explanations/messages_payloads_and_transactions.md#signedtransaction) - payload. diff --git a/docs/build/iota.rs/1.4/docs/examples/generate_addresses.mdx b/docs/build/iota.rs/1.4/docs/examples/generate_addresses.mdx deleted file mode 100644 index eadbb8cfc59..00000000000 --- a/docs/build/iota.rs/1.4/docs/examples/generate_addresses.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Generate Addresses -description: You can generate an IOTA address using the Client.get_addresses() function that will return a list of tuples with the generated addresses. -image: /img/logo/iota_mark_light.png -keywords: - - how to - - address - - iota address - - addressgetter - - environment variable - - java - - nodejs - - python - - rust - - wasm ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -import ExampleSeedNote from '../_admonitions/_example_seed_note.md'; -import JavaGenerateAddresses from '../libraries/java/examples/_03_generate_addresses.mdx'; -import NodejsGenerateAddresses from '../libraries/nodejs/examples/_03_generate_addresses.mdx'; -import PythonGenerateAddresses from '../libraries/python/examples/_03_generate_addresses.mdx'; -import RustGenerateAddresses from '../libraries/rust/examples/_03_generate_addresses.mdx'; -import WasmGenerateAddresses from '../libraries/wasm/examples/_03_generate_addresses.mdx'; - - - - - - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/1.4/docs/examples/generate_seed.mdx b/docs/build/iota.rs/1.4/docs/examples/generate_seed.mdx deleted file mode 100644 index e7c426e8ebb..00000000000 --- a/docs/build/iota.rs/1.4/docs/examples/generate_seed.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Generate a Seed -description: You can generate a seed, for example, using the SHA256 algorithm on some random input generated by a cryptographically secure pseudo-random generator, such as crypto.randomBytes(). -image: /img/logo/iota_mark_light.png -keywords: - - how to - - seed - - private key - - address - - online seed generator - - ed25519 signature scheme - - java - - nodejs - - python - - rust - - wasm ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -import KeyConceptSeeds from '../_admonitions/_explanation_seeds.md'; -import AvoidSeedGenerators from '../_admonitions/_avoid_seed_generators.md'; -import WalletRecommendation from '../_admonitions/_wallet_transaction_recommendation.md'; -import JavaGenerateSeed from '../libraries/java/examples/_02_generate_seed.mdx'; -import NodejsGenerateSeed from '../libraries/nodejs/examples/_02_generate_seed.mdx'; -import PythonGenerateSeed from '../libraries/python/examples/_02_generate_seed.mdx'; -import RustGenerateSeed from '../libraries/rust/examples/_02_generate_seed.mdx'; -import WasmGenerateSeed from '../libraries/wasm/examples/_02_generate_seed.mdx'; - - - - - - - - - - - - - - - - - - - - - - - -**Output example**: - -```plaintext -39bccf7b88a8017e6a96e6f31e34f138829c574dc6061523e84c5f2e53f5ca36 -pass phrase weapon yellow diary scissors gift drive strategy antique scheme make surround aerobic mystery coral hope lock walnut become exclude only glove syrup -eff5c97c96ddab55d6fe78f914508750152eaab1b9692236bc79268895ecfd168e91eedd2489ed6c51fc44156b9a2e6c967e4edcfb649ff33d41581be4627347 -``` - - diff --git a/docs/build/iota.rs/1.4/docs/examples/get_balance.mdx b/docs/build/iota.rs/1.4/docs/examples/get_balance.mdx deleted file mode 100644 index 893fef0f776..00000000000 --- a/docs/build/iota.rs/1.4/docs/examples/get_balance.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Check a Balance -description: There are three common API calls you can use to get a balance using the Client, getAddressBalance, getAddressBalances and getBalance. -image: /img/logo/iota_mark_light.png -keywords: - - how to - - account - - address - - nodejs - - message - - output - - java - - nodejs - - python - - rust - - wasm ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import FaucetService from '../_admonitions/_faucet_service.md'; -import JavaGetBalance from '../libraries/java/examples/_04_get_balance.mdx'; -import NodejsGetBalance from '../libraries/nodejs/examples/_04_get_balance.mdx'; -import PythonGetBalance from '../libraries/python/examples/_04_get_balance.mdx'; -import RustGetBalance from '../libraries/rust/examples/_04_get_balance.mdx'; -import WasmGetBalance from '../libraries/wasm/examples/_04_get_balance.mdx'; - - - - - - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/1.4/docs/examples/get_info.mdx b/docs/build/iota.rs/1.4/docs/examples/get_info.mdx deleted file mode 100644 index 2e569673878..00000000000 --- a/docs/build/iota.rs/1.4/docs/examples/get_info.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: Get Node Information -description: You can access all the features of the iota.rs library using an instance of the Client class. The Client class provides high-level abstraction to all interactions over IOTA network (Tangle). -image: /img/logo/iota_mark_light.png -keywords: - - how to - - client class - - iota node - - ClientBuilder - - load balancer - - java - - nodejs - - python - - rust - - wasm ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import WarningPasswordStorage from '../_admonitions/_password_storage.md'; -import JavaGetInfo from '../libraries/java/examples/_01_get_info.mdx'; -import NodejsGetInfo from '../libraries/nodejs/examples/_01_get_info.mdx'; -import PythonGetInfo from '../libraries/python/examples/_01_get_info.mdx'; -import RustGetInfo from '../libraries/rust/examples/_01_get_info.mdx'; -import WasmGetInfo from '../libraries/wasm/examples/_01_get_info.mdx'; - -# Connecting to Node(s) - -You can access all the features of the `iota.rs` library using an instance of the `Client` class. The `Client` class -provides high-level abstraction to all interactions over IOTA network (Tangle). You have to instantiate this class -before you start any interactions with the library, or more precisely with the -[IOTA nodes](/introduction/explanations/node_software) that power IOTA network. - -The library is designed to automatically choose a starting IOTA node based on the network type you would like to -participate in: [`devnet`](/introduction/reference/networks/devnet) or -[`mainnet`](/introduction/reference/networks/mainnet). - - - - - - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/1.4/docs/examples/get_message_data.mdx b/docs/build/iota.rs/1.4/docs/examples/get_message_data.mdx deleted file mode 100644 index 58627467bd0..00000000000 --- a/docs/build/iota.rs/1.4/docs/examples/get_message_data.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Get Message Data -description: Once a message is broadcast, you can use the MessageFinder helper class that can be instantiated using the Client.getMessage() function to retrieve it from the network. -image: /img/logo/iota_mark_light.png -keywords: - - message data - - messagefinder - - client - - message metadata - - java - - nodejs - - python - - wasm - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import JavaGetMessageData from '../libraries/java/examples/_07_get_message_data.mdx'; -import NodejsGetMessageData from '../libraries/nodejs/examples/_07_get_message_data.mdx'; -import PythonGetMessageData from '../libraries/python/examples/_07_get_message_data.mdx'; -import RustGetMessageData from '../libraries/rust/examples/_07_get_message_data.mdx'; -import WasmGetMessageData from '../libraries/wasm/examples/_07_get_message_data.mdx'; - - - - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/1.4/docs/examples/get_outputs.mdx b/docs/build/iota.rs/1.4/docs/examples/get_outputs.mdx deleted file mode 100644 index 67aa5d72e1b..00000000000 --- a/docs/build/iota.rs/1.4/docs/examples/get_outputs.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Get Outputs -description: - There are three functions you can use to get Unspent Transaction Output (UTXO) outputs related an address Client.getAddressOutputs(str), Client.getOutput(str), and Client.findOutputs(output_ids (optional), addresses - (optional)). -image: /img/logo/iota_mark_light.png -keywords: - - how to - - unspent transactions output - - UTXO - - address - - nodejs - - Client - - get_outputs - - get_output - - find_outputs ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import JavaGetOutputs from '../libraries/java/examples/_05_get_outputs.mdx'; -import KeyConceptOutputs from '../_admonitions/_explanation_outputs.md'; -import NodejsGetOutputs from '../libraries/nodejs/examples/_05_get_outputs.mdx'; -import PythonGetOutputs from '../libraries/python/examples/_05_get_outputs.mdx'; -import RustGetOutputs from '../libraries/rust/examples/_05_get_outputs.mdx'; -import WasmGetOutputs from '../libraries/wasm/examples/_05_get_outputs.mdx'; - - - -There are three functions you can use to get -[Unspent Transaction Output (UTXO)](../explanations/messages_payloads_and_transactions.md#unspent-transaction-output-utxo) -outputs related an address. - - - - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/1.4/docs/examples/mqtt.mdx b/docs/build/iota.rs/1.4/docs/examples/mqtt.mdx deleted file mode 100644 index 9dc72c1d791..00000000000 --- a/docs/build/iota.rs/1.4/docs/examples/mqtt.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: Listen to MQTT -description: You can reach the listener using an instance of a Client.TopicSubscriber object that is returned from the Client.subscriber() function. -image: /img/logo/iota_mark_light.png -keywords: - - how to - - message - - message queuing telemetry - - queues - - asynchronous events listener - - list topics - - nodejs - - java - - nodejs - - python - - wasm - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -import KeyConceptOutputs from '../_admonitions/_explanation_outputs.md'; -import Javamqtt from '../libraries/java/examples/_10_mqtt.mdx'; -import Nodejsmqtt from '../libraries/nodejs/examples/_10_mqtt.mdx'; -import Pythonmqtt from '../libraries/python/examples/_10_mqtt.mdx'; -import Rustmqtt from '../libraries/rust/examples/_10_mqtt.mdx'; -// import Wasmmqtt from "../libraries/wasm/examples/_10_mqtt.mdx"; - - - -IOTA node(s) provide a [Message Queuing Telemetry Transport](https://en.wikipedia.org/wiki/MQTT) (MQTT) layer, if -enabled, which is a lightweight publish-subscribe network protocol that provides information about events that are -being triggered by the IOTA network. - -The `iota.rs` client library supports asynchronous event listeners that can be listened to, and continuously receive -MQTT events based on a `topic`, which can be: - -- milestones/latest -- milestones/confirmed -- messages -- messages/referenced -- messages/indexation/{index} -- messages/{messageId}/metadata -- transactions/{transactionId}/included-message -- outputs/{outputId} -- addresses/{address}/outputs -- addresses/ed25519/{address}/outputs - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/1.4/docs/examples/running_examples.mdx b/docs/build/iota.rs/1.4/docs/examples/running_examples.mdx deleted file mode 100644 index dae69792c89..00000000000 --- a/docs/build/iota.rs/1.4/docs/examples/running_examples.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Running Examples -description: The iota.rs has multiple code examples to get you up and running in no time. However, these require a specific set up depending on your language of choice. -image: /img/logo/iota_mark_light.png -keywords: - - how to - - examples - - npm - - cargo - - yarn - - java - - nodejs - - python - - rust - - wasm ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import JavaRunningExamples from '../libraries/java/examples/_running_examples.mdx'; -import NodejsRunningExamples from '../libraries/nodejs/examples/_running_examples.mdx'; -import PythonRunningExamples from '../libraries/python/examples/_running_examples.mdx'; -import RustRunningExamples from '../libraries/rust/examples/_running_examples.mdx'; -import WasmRunningExamples from '../libraries/wasm/examples/_running_examples.md'; -import WarningPasswordStorage from '../_admonitions/_password_storage.md'; - -# Running Examples - - - - - - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/1.4/docs/examples/simple_message.mdx b/docs/build/iota.rs/1.4/docs/examples/simple_message.mdx deleted file mode 100644 index e7596b4a1e9..00000000000 --- a/docs/build/iota.rs/1.4/docs/examples/simple_message.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Post a Message -description: You can use the function Client.postMessage(message) to send a message instance over a network. -image: /img/logo/iota_mark_light.png -keywords: - - how to - - message - - encapsulating data structure - - network - - java - - nodejs - - python - - wasm - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import JavaSimpleMessage from '../libraries/java/examples/_06_simple_message.mdx'; -import NodejsSimpleMessage from '../libraries/nodejs/examples/_06_simple_message.mdx'; -import PythonSimpleMessage from '../libraries/python/examples/_06_simple_message.mdx'; -import RustSimpleMessage from '../libraries/rust/examples/_06_simple_message.mdx'; -import WasmSimpleMessage from '../libraries/wasm/examples/_06_simple_message.mdx'; - -## Messages - -A [message](../explanations/messages_payloads_and_transactions.md#messages) is an encapsulating data structure that is being actually broadcast across the network. It is an atomic unit that is either accepted or rejected as a whole. - -The simplest message you can broadcast is a message without any particular payload, as shown in the following examples. - - - - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/1.4/docs/examples/transaction.mdx b/docs/build/iota.rs/1.4/docs/examples/transaction.mdx deleted file mode 100644 index 39caf751487..00000000000 --- a/docs/build/iota.rs/1.4/docs/examples/transaction.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Send a Signed Transaction -description: Sending value-based messages is a very straightforward process. You will only need to provide a valid seed, output addresses, and amount. -image: /img/logo/iota_mark_light.png -keywords: - - how to - - value - - utxo - - outputs - - core payload type - - unspent transactions output - - java - - nodejs - - python - - wasm - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import WalletRecommendation from '../_admonitions/_wallet_transaction_recommendation.md'; -import DustProtection from '../_admonitions/_dust_protection.md'; -import JavaTransaction from '../libraries/java/examples/_09_transaction.mdx'; -import NodejsGetTransaction from '../libraries/nodejs/examples/_09_transaction.mdx'; -import PythonGetTransaction from '../libraries/python/examples/_09_transaction.mdx'; -import RustGetTransaction from '../libraries/rust/examples/_09_transaction.mdx'; -import WasmGetTransaction from '../libraries/wasm/examples/_09_transaction.mdx'; - -A [SignedTransaction](./../explanations/messages_payloads_and_transactions.md#signedtransaction) is a core payload type -that is used to send value-based messages as -[Unspent Transaction Output (UTXO)](./../explanations/messages_payloads_and_transactions.md#unspent-transaction-output-utxo). -This core payload changes the _ledger state_ as it spends "old" outputs and replaces them with new outputs. - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/1.4/docs/explanations/address_key_space.md b/docs/build/iota.rs/1.4/docs/explanations/address_key_space.md deleted file mode 100644 index d89cf2d7369..00000000000 --- a/docs/build/iota.rs/1.4/docs/explanations/address_key_space.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -description: The BIP32 and BIP44 standards define a tree structure as a base for address and key space generation which is represented by a derivation path. -image: /img/libraries/address_generation.svg -keywords: - - explanation - - hierarchical deterministic wallet - - derivation path - - set of addresses - - account discovery - - accounts ---- - -# Address/Key Space - -## BIP32 - Tree Structure - -The [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) standard describes an approach to -_Hierarchical Deterministic Wallets_. The standard was improved -by [BIP44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki). - -This standard defines a tree structure as a base for address and key space generation which is represented by a -`derivation path`: - -```plaintext -m / purpose / coin_type / account / change / address_index -``` - -- `m`: A master node (seed). -- `purpose`: A constant which is {44}. -- `coin_type`: A constant set for each crypto currency. IOTA = 4218, for instance. -- `account`: Account index. Zero-based increasing `int`. This level splits the address/key space into independent - branches (ex. user identities) which each has own set of addresses/keys. -- `change`: Change index which is `{0, 1}`, also known as `wallet chain`. - - There are two independent chains of addresses or keys. `0` is reserved for public addresses (to receive coins) and `1` is - reserved for internal addresses (also known as change) to which transaction change is returned. IOTA allows address - reuse, and so it is, technically speaking, valid to return transaction change to the same originating address. It is - up to developers whether to leverage it or not. The `iota.rs` library and its sibling `wallet.rs` help with either - scenario. - -- `address_index`: Address index. Zero-based increasing `int` that indicates an address index. - -As outlined, there is quite a large address/key space that is secured by a single unique seed. - -And there are few additional interesting notes: - -- Each level defines a completely different subtree (subspace) of addresses/keys, and those are never mixed up. -- The hierarchy is ready to "absorb" addresses/keys for many coins at the same time (`coin_type`), and all those coins - are secured by the same seed. This means any BIP32/44-compliant wallet is potentially able to manage any \ - BIP32/44-compliant coin(s). -- There may be also other `purposes` in the future. However, consider a single purpose for now. The constant `44` stands - for BIP44. -- The standard was agreed upon by different crypto communities, although not all `derivation path` components are always in active use. For example, `account` is not always actively leveraged across the crypto space (if this is the case then `account=0` is usually used). -- Using different `accounts` may be useful to split addresses/keys into some independent spaces, and it is up to - developers to implement. \_Using different `accounts` may have a negative impact on a performance while you are on the - [account discovery](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki#account-discovery) phase. If you are - planning on using many multiple accounts then you may be interested in our stateful library - [wallet.rs](/wallet.rs/welcome) that incorporates all business logic needed to efficiently manage - independent accounts. - Our [exchange guide](/introduction/how_tos/exchange) - provides some useful tips on how different accounts may be leveraged. - -![address_generation](/img/libraries/address_generation.svg) - -In case of IOTA, the derivation path of address/key space is `[seed]/44/4218/{int}/{0,1}/{int}`. The levels `purpose` -and `coin_type` are given, the rest levels are up to developers to integrate. - -## Related Examples - -- [Generate Addresses](./../examples/generate_addresses.mdx) diff --git a/docs/build/iota.rs/1.4/docs/explanations/messages_payloads_and_transactions.md b/docs/build/iota.rs/1.4/docs/explanations/messages_payloads_and_transactions.md deleted file mode 100644 index 2f7ac32dfa4..00000000000 --- a/docs/build/iota.rs/1.4/docs/explanations/messages_payloads_and_transactions.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -description: The IOTA network is based on messages and payloads. A message is a data structure broadcast in the IOTA network and represents a node (vertex) in the Tangle graph, while a payload represents a layer of concern. -image: /img/libraries/messages_in_tangle.svg -keywords: - - explanation - - message - - payload - - ledger state - - outputs - - unspent transaction output - - UTXO ---- - -# Messages, Payloads, and Transactions - -The IOTA network is based on messages and payloads. This section will explain the relationship between messages and -payloads and how you can create value transactions. - -## Messages - -A message is a data structure broadcast in the IOTA network and represents a node (vertex) in -the [Tangle graph](https://explorer.iota.org/mainnet/visualizer/). It can refer to up to 8 previous messages, and once a -message is attached to the Tangle and approved by a milestone, the Tangle structure ensures the content of the message -will remain unaltered. Each message has a unique `message_id`, which is based on a hash algorithm of the binary content -of the message. A message is an atomic unit that is confirmed by the network as a whole. - -A message is broadcast using a binary format, has an arbitrary size of up to 35 kB, and can hold variable sets of -information called [payloads](#payloads). A message can encapsulate any number of payloads, and even a message without a -payload is perfectly valid. - -## Payloads - -A payload represents a layer of concern. Some payloads may change a state of the ledger (ex. `transactions`), and some -may provide extra features to some specific applications and business use cases (ex. `indexed data`). - -There are already implemented [core payloads](#core-payloads), such as `SignedTransaction`, `MilestonePayload` -and `IndexationPayload`. However, the message and payload definitions are generic enough to incorporate any future -payload(s) the community agrees upon. - -The IOTA network ensures the outer structure of any message is valid and aligned with a network consensus protocol. -However, the message’s inner structure is very flexible, future-proof, and offers an unmatched network extensibility. - -![messages_in_tangle](/img/libraries/messages_in_tangle.svg) - -### Core Payloads - -The current IOTA network incorporates the following core payloads: - -#### SignedTransaction - -A payload that describes [`UTXO` transactions](#unspent-transaction-output-utxo) that are the cornerstone of value-based -transfers in the IOTA network. You can use this payload to sign a message cryptographically. This payload changes the -ledger state as old `outputs` are spent (replaced) and new `outputs` are created. - -Example of a message with a `SignedTransaction` payload: - -```json -{ - "message": { - "networkId": "14379272398717627559", - "parentMessageIds": [ - "a59a5d11da0944c88b58f9f9c095c11ee4b8b7fd9da47bd25412d39f815bb804", - "c3d42c42eccd25bc3374a0552e3a4b21180facece14f31c36e5ac580e5496ccc", - "dae4a36cef9a3fd03caff5ddbc5c90bc5523477f4e4937837202bfe4bd5b98aa", - "fe188a4f57ecd6a135b05b31913d86617550d9397476ab5bb7445138f782ec34" - ], - "payload": { - "type": 0, - "essence": { - "type": 0, - "inputs": [ - { - "type": 0, - "transactionId": "b2b9723c9119f4fb49084472e72821e842ba4779df02e1038f03dd8b25d96730", - "transactionOutputIndex": 1 - } - ], - "outputs": [ - { - "type": 0, - "address": { - "type": 0, - "address": "43e80947ebd17637569ba7f90fd2541f50038de731467c45aa5c92d4429c9446" - }, - "amount": 1000 - }, - { - "type": 0, - "address": { - "type": 0, - "address": "b4d1e9abfbcf4d2d2f0e042f23301a7d23f6ac1bde0a1fed508de5afec884ba8" - }, - "amount": 8995995 - } - ], - "payload": null - }, - "unlockBlocks": [ - { - "type": 0, - "signature": { - "type": 0, - "publicKey": "27177dd41cc479ed379b8ad2535d66fa58480c119a8a15a7a296f055401ab958", - "signature": "8403dc1fb949365e960f14cdc19b6b3abb6b0a6bce83f1082a33e3857a30ddd2be1098074b6c261f442db8e59eb640002d24d9a577262fd8152c6fee2d076c0b" - } - } - ] - }, - "nonce": "156106" - }, - "messageId": "92f427d68c7008a81fde290b9cb99071373d9893d65718bfc22928273877e041" -} -``` - -Each `transaction` includes the following information: - -- `inputs`: A list of valid `outputs` that should be used to fund the given message. Those `outputs` will be spent and - once the message is confirmed, those outputs are not valid anymore. Outputs are uniquely referenced via `transaction_id` - and inner `index`. At least one output has to be given with enough balance to source all `outputs` of the given message. -- `outputs`: A list of IOTA address(es) and related amount(s) that the input `outputs` should be split among. Based on - this information, new `UTXO` entities (outputs) will be being created. -- `unlockBlocks`: Includes a transaction signature(s) (currently based on `Ed25519` scheme) that prooves token - ownership based on a valid seed. Only the valid seed owner is able to correctly sign the given transaction and proove - ownership of the tokens under the given output(s). Each input `output` has to have a corresponding `unblockBlocks` entry - in case more `outputs` are used to fund the operation, either using the given signature or as a reference to the - existing signature -- `payload`: Each `SignedTransaction`(payload type 0) can include additional payload(s) such as an `IndexationPayload` - (payload type 1) for example. This means any value-based messages can also contain arbitrary data and its key index. It - is also an example how individual payloads can be encapsulated on different levels of concern - -#### MilestonePayload - -A payload that is emitted by the Coordinator. - -#### IndexationPayload - -A payload that enables adding an index to the encapsulating message, as well as arbitrary data. You can use the -index to search for the message(s). - -### Unspent Transaction Output (UTXO) - -IOTA uses an `unspent transaction output` model called `UTXO`. `UTXO` is based on an idea to track the unspent amount of -tokens using a data structure called `output`. This model can be explained using a simple example: - -- There are 100 tokens recorded in the ledger as `Output A`, which belongs to Alice. So **initial state of - ledger**: `Output A` = 100 tokens. -- Alice sends 20 tokens to Paul, 30 tokens to Linda, and keeps 50 tokens at her disposal. -- Her 100 tokens are currently stored as `Output A`. This means she has to divide (spend) her tokens to create three new - outputs: - - `Output B` with 20 tokens that go to Paul. - - `Output C` with 30 tokens that go to Linda. - - `Output D` with the remaining 50 tokens that she keeps for herself. -- The **original `Output A`** was spent entirely and can not be used anymore. As it is spent, it **becomes irrelevant** - to the ledger state. The **new state of ledger** is: - - `Output B` = 20 tokens. - - `Output C` = 30 tokens. - - `Output D` = 50 tokens. -- The total supply remains the same. However, the number of outputs differs, and some were replaced by other outputs in - the process. - -![utxo](/img/libraries/utxo.svg) - -The key takeaway of the outlined process is that each unique `output` can **only be spent once**. Once an output is -spent, it can not be used anymore and is irrelevant regarding the ledger state. - -So even if Alice still wants to keep the remaining tokens at her fingertips, those tokens have to be moved to completely -new `output` that can still be tied to the same IOTA address Alice used before. - -Every `output` also stores information about an IOTA address it is coupled with. This means addresses and tokens are -indirectly coupled via outputs. So basically, the sum of outputs and their amounts under a given address is a balance of -the given address, i.e., the number of tokens the address can spend. And the sum of all unspent outputs and their -amounts is equal to the total supply. - -Outputs are encapsulated in a message as a part of the `SignedTransaction` payload. - -## Related Examples - -- [Simple Message](./../examples/simple_message.mdx) -- [Get Outputs](./../examples/get_outputs.mdx) -- [Get Message Data](./../examples/data_message.mdx) -- [Send a Signed Transaction](./../examples/transaction.mdx) diff --git a/docs/build/iota.rs/1.4/docs/explanations/seeds.mdx b/docs/build/iota.rs/1.4/docs/explanations/seeds.mdx deleted file mode 100644 index 9a1fe557bcf..00000000000 --- a/docs/build/iota.rs/1.4/docs/explanations/seeds.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -description: IOTA uses the `Ed25519` signature scheme and addresses are usually represented by Bech32 (checksummed base32) format string of 64 characters. -image: /img/libraries/messages_in_tangle.svg -keywords: - - explanation - - seeds - - ED2519 - - signature scheme - - random seed - - seed generator - - private key ---- - -import SeedMnemonics from '../_admonitions/_seed_mnemonics.md'; - -# Seeds - -Since the IOTA network is permission-less, anybody is able to use it and interact with it. No central authority is -required at any stage. So anybody is able to generate their own `seed` and then deterministically generate the -respective private keys/addresses. - -IOTA uses the `Ed25519` signature scheme and addresses are usually represented by Bech32 (checksummed base32) format -string of 64 characters. - -A root of the `Ed25519` signature scheme is basically a `32-byte (256-bit)` uniformly randomly generated seed on which -all private keys and corresponding addresses are generated. In the examples below, the seed is represented by a string -of 64 characters using the `[0-9a-f]` alphabet (32 bytes encoded in hexadecimal). - - - -## Related Examples - -- [Generate Seed](./../examples/generate_seed.mdx) diff --git a/docs/build/iota.rs/1.4/docs/getting_started/java/android_development.mdx b/docs/build/iota.rs/1.4/docs/getting_started/java/android_development.mdx deleted file mode 100644 index a906f853574..00000000000 --- a/docs/build/iota.rs/1.4/docs/getting_started/java/android_development.mdx +++ /dev/null @@ -1,230 +0,0 @@ ---- -description: Official IOTA Wallet Library Java API reference. -image: /img/logo/iota_mark_light.png -keywords: - - api - - Java - - android - - cross - - compile ---- - -import AndroidGradle from '../../_admonitions/_android_gradle.md'; -import CrossCompile from '../../_admonitions/_android_cross_compile.mdx'; -import UnnecessaryBuild from '../../_admonitions/_android_unnecessary_build.md'; -import AndroidAppExample from '../../_admonitions/_android_app_example.md'; - -# Android Development - -Android development requires a more specific environment setup. In this tutorial we will guide you through the various ways to build an APK with `iota.rs` capabilities. - -The first part of this tutorial shows you how to install the required tools for building an apk. Scroll [down](#using-pre-generated-binaries) for a guide using the precompiled binaries found on our release page [here](https://github.com/iotaledger/iota.rs/releases). The Java releases are tagged with `android-binding-vX.Y.Z`. - - - -## Setup by compiling - -Compiling an Android app comes with the added task of building for multiple different device architectures. -In this tutorial we mention the followint 2 variables: -`$ARCH` and `$TARGET`. - -These variables are used to generate correct binaries during cross compilation and linking. - -#### List of target Devices - -`$ARCH` and -> `$TARGET` related to each other in the following manner: - -- `armeabi-v7a` -> `armv7-linux-androideabi` -- `arm64-v8a` -> `aarch64-linux-android` -- `x86` -> `i686-linux-android` -- `x86_64` -> `x86_64-linux-android` - -When building an app, you as a developer must decide for how many architectures you make an APK for. Binaries need to be generated for each architecture. - -The android-app example has a [build.gradle](https://github.com/iotaledger/iota.rs/blob/production/bindings/java/examples/android-app/build.gradle) file that shows the enabled list in a variable called `archTriplets`. You can disable and enable them, as long as you have at least one. (This file will also automatically compile our binaries when we run gradle. Feel free to use it in your project!) - -We will use `archTriplets` for the enabled list of device targets during this tutorial. - -## Prerequisite - -- Dependencies indicated in the [Getting started](./getting_started.mdx) Prerequisite section -- Android NDK or Android Studio with NDK installed (If you extract make sure to make it executable `chmod -R +x android-ndk-VERSION` ) - -To cross compile the binaries for Android, we need the following target toolchains: (All of the enabled `archTriplets`) - -```bash -rustup target add \ - armv7-linux-androideabi \ - aarch64-linux-android \ - i686-linux-android \ - x86_64-linux-android -``` - -For this setup we use `$ANDROID_NDK_HOME` for the location of your NDK, wether you use Android studio or manual compilation. - -1. Set `ANDROID_NDK_HOME` environment variable - -Example: `export ANDROID_NDK_HOME=$ANDROID_HOME/ndk/{A_VERSION_NUMBER}` - -If you dont have `ANDROID_HOME`; Usually found at `/home/user/Android`. Make sure you have installed Android correctly. -Attempt to run `android` on your terminal. If this command does not open the Android SDK Manager, then your path is not configured correctly. - -## 1. Generating the Java Files - -### 1.1 Compiling a Binary - -To generate the Java source files; we need to run cargo manually once. - -This step will require you to run `cargo build --release` in `iota.rs/bindings/java`. - - - -### 1.2 Creating the Jar - -Afterwards, you need to run `./gradlew jar` in `iota.rs/bindings/java` in order to generate the jar file. - -The jar will be found at `iota.rs/bindings/java/native/build/libs/native.jar` - -## 2. Build the App - -Building the actual app can be done through two different ways. Using Android Studio and by manual linking. - -The following 2 Sections describe both methods. - - - -### 2.1 Android studio - -Load the project under the `iota.rs/bindings/java` folder in Android studio. - -Make sure you have an NDK and SDK: `file->Project Structure->SDK Location`. If the NDK location is marked grey, edit the `local.properties` like so: (This must be the location of `$ANDROID_NDK_HOME`, which still needs to be on your path) - -```bash -ndk.dir=I\:\\Path\\To\\AndroidSDK\\ndk\\VERSION -``` - -If youre on linux/wsl, just run the app. On other platforms see the `Setup/Cross compile note` before running. - -### 2.2 Manual linking - -#### Preparing your terminal/environment - -Add the standalone toolchain to the search path. - -Example: `export PATH=$PATH:$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/{OS}/bin` - -Replace `{OS}` with your OS name; on Linux this would be called `linux-x86_64`, windows `windows-x86_64` (`x86_64`depening on architecture type) - -These toolchains can alternatively be prepended to the cargo command as well, but we wont discuss that in this tutorial. - -#### Setting Cargo config - -To compile the binaries for the various Android targets, we need to specify the targets to rust. - -Create or update the following file: `~/.cargo/config`. -Replace each instance of `$ANDROID_NDK_HOME` with the actual location (variables do not work) and add the text below to the config file. - -```bash -[target.armv7-linux-androideabi] -linker = "$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin/armv7a-linux-androideabi21-clang" -ar = "$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin/arm-linux-androideabi-ar" - -[target.aarch64-linux-android] -linker = "$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin/aarch64-linux-android21-clang" -ar = "$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin/aarch64-linux-android-ar" - -[target.i686-linux-android] -linker = "$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin/i686-linux-android21-clang" -ar = "$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin/i686-linux-android-ar" - -[target.x86_64-linux-android] -linker = "$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin/x86_64-linux-android21-clang" -ar = "$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin/x86_64-linux-android-ar" -``` - -#### Generating the binaries - -Now we need to generate binaries for all the enabled targets inside your `build.gradle` `archTriplets`. -The easiest way is to use the gradle build system. Using the `build.gradle` inside `examples/android-app`, we automatically build all enabled targets after running the following: - -```bash -cd iota.rs/bindings/java -./gradlew build -``` - -Alternatively, you can also manually run the commands. - -1. Compile the binaries for the target - -Example: `cargo build --target aarch64-linux-android --release` - -2. Adding shared library - -> Copy `$ANDROID_NDK_HOME/sources/cxx-stl/llvm-libc++/libs/$ARCH/libc++_shared.so` to `src/main/libs/$ARCH/` - -Example: `cp $ANDROID_NDK_HOME/sources/cxx-stl/llvm-libc++/libs/arm64-v8a/libc++_shared.so examples/android-app/src/main/libs/arm64-v8a` - -#### Building your app - -Assemble your android app with gradle using: - -``` -cd iota.rs/bindings/java -./gradlew aR -``` - -#### Signing your app - -1. Prepare a signing keystore; we will call it `signed_ks.jks` - -> How to make: - -2. Sign the apk - -> `$ANDROID_HOME/build-tools/{VERSION}/apksigner sign --ks examples/android-app/signed_ks.jks --out examples/android-app/android-app-release-signed.apk -v examples/android-app/build/outputs/apk/release/android-app-release-unsigned.apk` - -3. Connect device - -> + - -For example: - -- `adb pair 192.168.0.x:x` -- `adb connect 192.168.0.x:x` -- `adb install -r --fastdeploy examples/android-app/android-app-release-signed.apk` -- `adb shell am monitor` - -## Using pre-generated binaries - -It is likely you do not want or need to compile by yourself. That is why we provide precompiled binaries found on our release page [here](https://github.com/iotaledger/iota.rs/releases). The Java releases are tagged with `android-binding-vX.Y.Z`. - -Install the files attached to the release so that you achieve the following directory structure: (extract the `jniLibs.zip` into `root_app/src/main/`) - -```plaintext -root_app/src/main/ - libs/ - native.jar - jniLibs/ - arm64-v8a/ - libc++_shared.so - libiota_client_java.so - armeabi-v7a/ - libc++_shared.so - libiota_client_java.so - x86/ - libc++_shared.so - libiota_client_java.so - x86_64/ - libc++_shared.so - libiota_client_java.so -``` - -### Android Studio - -Then using Android Studio, add the native.jar to your project by right clicking -> Add As Library... -> Select your Android app Module and press OK. - -### Manual - -Add the jar to your `build.gradle` dependencies section using; for example: `implementation files('src\\main\\libs\\native.jar')` - - diff --git a/docs/build/iota.rs/1.4/docs/getting_started/java/getting_started.mdx b/docs/build/iota.rs/1.4/docs/getting_started/java/getting_started.mdx deleted file mode 100644 index a1e7f7d627d..00000000000 --- a/docs/build/iota.rs/1.4/docs/getting_started/java/getting_started.mdx +++ /dev/null @@ -1,140 +0,0 @@ ---- -description: Getting started with the official IOTA Client Library Java binding. -image: /img/logo/iota_mark_light.png -keywords: - - Java - - Rust - - jar - - maven - - environment variable ---- - -import PasswordStorage from '../../_admonitions/_password_storage.md'; -import CompilingForAndroid from '../../_admonitions/_compiling_for_android.md'; - -# Getting Started - -## Prerequisites - -To use the library, we recommend you update Rust to the latest stable version [`$ rustup update stable`](https://github.com/rust-lang/rustup.rs#keeping-rust-up-to-date). Nightly should be fine but some changes might not be compatible. - -Ensure you have first installed the required dependencies for the library [here](https://github.com/iotaledger/iota.rs/blob/dev/README.md). Then also install the following programs: - -- Java & JDK (Make sure $JAVA_HOME env variable) is set -- [Gradle](https://gradle.org/install/) v4 or higher or [Maven](https://maven.apache.org/download.cgi) installe -- Cargo ndk (`cargo install cargo-ndk`) -- Cargo fmt (`rustup component add rustfmt`) - -Download or clone the `iota.rs` repository - -```bash -git clone https://github.com/iotaledger/iota.rs.git -``` - -## Security - - - -## Installation - -To build using the iota.rs Java bindings, you need the following two parts: - -1. JNI Native library linking `Rust` to `C`, and then `C` to java `native` methods (`.so` , `.dll` or `.dylib` depending on your system). -2. Java archive(Jar) containing `native` methods which call C code. (`.jar`). - -### Step 1: Creating the Native Library - -Build the iota.rs library (This generates the java source code and JNI library file) - -```bash -cd iota.rs/bindings/java -cargo build --release -``` - -Generated binaries can then be found at `iota.rs/bindings/java/target/release` - - - -### Step 2: Creating the Java archive - -#### Generating the source files and classes - -After step 1, Java source files will be generated under `iota.rs/bindings/java/native/src/main/java/org/iota/client`. - -If this step succeeded, we need to generate the jar file containing the newly generated Java source files. - -#### Generating the jar - -Generating the jar can be done with your tool of preference. We provide examples for Gradle and Maven in this guide - -##### Gradle - -Make `gradlew` executable (`chmod +x gradlew`) if needed, then run - -```bash -cd iota.rs/bindings/java -./gradlew jar -``` - -##### Maven - -```bash -cd iota.rs/bindings/java -mvn install -``` - -After running one of these commands, the jar can then be found at `iota.rs/bindings/java/native/build/libs/native.jar` - -## Usage - -You can find more information on using the `iota.rs` library's java binding in the [examples section](./../../examples/running_examples.mdx). - -### Gradle - -```bash -./gradlew examples:java-app:test --info -``` - -### Maven - -```bash -mvn exec:exec -``` - -## Initialisation - -This example fetches node information - -```java -private static void nodeInfo() { - String nodeUrl = "https://chrysalis-nodes.iota.cafe:443"; - Client iota = Client.Builder() - // Insert your node URL here - .withNode(nodeUrl) - // Choose pow mode - .withLocalPow(true) - //Then create the Client instance - .finish(); - NodeInfoWrapper info = iota.getInfo(); - System.out.println("Node url: " + info.url()); - System.out.println("Node Info: " + info.nodeInfo()); -} -``` - -## API Reference - -Java - -### Limitations - -Due to the fact that we are linking through C from Rust, there are a couple of limiting factors. - -- Classic builder patterns return a `clone` after each builder call since we can only pass back to C by reference in `Rust` - -```Java -Builder builder1 = new Builder(); -Builder builder2 = builder1.setValue(true); - -// These are different instances, thus builder1 wont have the value set -assertNotEquals(builder1, builder2); -``` diff --git a/docs/build/iota.rs/1.4/docs/getting_started/nodejs.md b/docs/build/iota.rs/1.4/docs/getting_started/nodejs.md deleted file mode 100644 index 25ce6795607..00000000000 --- a/docs/build/iota.rs/1.4/docs/getting_started/nodejs.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -description: Getting started with the official IOTA Client Library Node.js binding. -image: /img/logo/libraries.png -keywords: - - Node.js - - dotenv - - install - - npm - - yarn - - security - - how to ---- - -# Getting Started With Node.js - -## Requirements - -Before you can get started with the Node.js binding for the iota.rs client library, please make sure that you have -installed [Node](https://nodejs.org/en/), -[Rust and Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html), and [NPM](https://www.npmjs.com/) -or [Yarn](https://yarnpkg.com/). - -## Installing the Library - -### NPM - -If you are using NPM, you can install the binding in your project by running the following command: - -```bash -npm i @iota/client -``` - -### Yarn - -If you are using Yarn, you can install the binding in your project by running the following command: - -```bash -yarn add @iota/client -``` - -## Using the Library - -The following example shows you how to include the library and connect to a devnet node. - -```javascript -const { ClientBuilder } = require('@iota/client'); -const client = new ClientBuilder() - .node('https://api.lb-0.h.chrysalis-devnet.iota.cafe') - .build(); -client.getInfo().then(console.log).catch(console.error); -``` diff --git a/docs/build/iota.rs/1.4/docs/getting_started/python.mdx b/docs/build/iota.rs/1.4/docs/getting_started/python.mdx deleted file mode 100644 index f35f8fceca1..00000000000 --- a/docs/build/iota.rs/1.4/docs/getting_started/python.mdx +++ /dev/null @@ -1,105 +0,0 @@ ---- -description: Getting started with the official IOTA Client Library Python binding. -image: /img/logo/iota_mark_light.png -keywords: - - Python - - install - - pip - - unpack ---- - -import WarningPasswordStorage from '../_admonitions/_password_storage.md'; - -# Getting Started with IOTA Client Python Binding - -## Security - - - -## Requirements - -- [Python 3.x](https://www.python.org). -- [pip](https://pypi.org/project/pip). - -## Installation - -### Install prebuild libraries - -Easiest way how to get python binding up and running is to leverage pre-built python libraries for linux/macos/windows that can be installed to your python environment (3.6+) via `pip`. The binding is automagically generated using github [actions](https://github.com/iotaledger/iota.rs/actions/workflows/python-bindings-publish.yml?query=branch%3Aproduction). - -The latest artifacts for major python versions can be also grabbed using [nighly.link service](https://nightly.link/iotaledger/iota.rs/workflows/python-bindings-publish/production). Download zip file for the given os and pyversion, unpack wheel file (`.whl`) and install it via `pip`: - -```bash -pip install -``` - -### Install from source - -### Additional Requirements - -- [Rust and Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html). -- (for Linux only) `libudev`. You can install it with `apt install libudev-dev`. - -#### Clone the Repository - -You can clone the iota.rs client library by running the following command: - -```bash -git clone -b production https://github.com/iotaledger/iota.rs -``` - -#### Change to the Python Binding Directory - -After you have cloned the repository, you should change directory to iota.rs/bindings/python/native. You can do so by running the following command: - -```bash -cd iota.rs/bindings/python/native -``` - -#### Install the Required Dependencies and Build the Wheel - -Install and run maturin: - -```bash -pip3 install maturin -maturin develop -maturin build --manylinux off -``` - -The wheel file is now created in `bindings/python/native/target/wheels`. You can install it with: - -```bash -pip3 install [THE_BUILT_WHEEL_FILE] -``` - -Once it has been properly installed you can double check it using `pip`: - -```bash -pip list -``` - -You should see the similar output: - -```plaintext -Package Version --------------------------- ------- -iota-client-python 0.2.0a3 -``` - -Once installed in the given python environment you are all set and can start hacking using python binding! - -## Usage - -```python -import iota_client -print(iota_client.__doc__) -print(dir(iota_client)) - -client = iota_client.Client(nodes_name_password=[['https://api.lb-0.h.chrysalis-devnet.iota.cafe']]) - -print('get_health()') -print(f'health: {client.get_health()}') - -print('get_info()') -print(f'node_info: {client.get_info()}') -``` diff --git a/docs/build/iota.rs/1.4/docs/getting_started/required_prior_knowledge.md b/docs/build/iota.rs/1.4/docs/getting_started/required_prior_knowledge.md deleted file mode 100644 index 16ec4dd7b65..00000000000 --- a/docs/build/iota.rs/1.4/docs/getting_started/required_prior_knowledge.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -description: Choose your binding and get started with the IOTA Client Library. -image: /img/banner/banner_client_lib_getting_started.png -keywords: - - rust - - python - - node.js - - java - - javascript - - IDE - - WASM - - reference ---- - -# Getting Started - -![IOTA Client Library getting started](/img/banner/banner_client_lib_getting_started.png) - -## Required Prior Knowledge - -This wiki assumes that you already know the basics of your programming language of choice. Companies and communities -behind each language provide their documentation for beginners you can use as reference: - -- [Java](https://www.java.com/). -- [JavaScript](https://www.w3schools.com/js/). -- [Node.js](https://nodejs.org/en/docs/guides/). -- [Python](https://www.python.org/about/gettingstarted/). -- [Rust](https://www.rust-lang.org/learn/get-started). -- [Wasm](https://webassembly.org/). - -If you have little experience coding, you could start with any of those first or refer to these guides as you read -through our iota.rs documentation. If you have never programmed in your life, MIT has published an -open [introductory course to programming](https://ocw.mit.edu/courses/6-00sc-introduction-to-computer-science-and-programming-spring-2011/) which could help you -get started. - -## Choose Your Language - -To check out our examples and write and test your own code, you will need an IDE or a code editor of your choice and a -stable internet connection. You also need to set up your environment by following instructions for one of the -languages: - -- [Java](./java/getting_started.mdx). -- [Node.js](./nodejs.md). -- [Python](./python.mdx). -- [Rust](./rust.md). -- [Wasm](./wasm.md). diff --git a/docs/build/iota.rs/1.4/docs/getting_started/rust.md b/docs/build/iota.rs/1.4/docs/getting_started/rust.md deleted file mode 100644 index b829a13ff89..00000000000 --- a/docs/build/iota.rs/1.4/docs/getting_started/rust.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -description: Getting started with the official IOTA Client Library Rust library. -image: /img/logo/libraries.png -keywords: - - Rust - - install - - cargo - - system environment variables - - how to ---- - -# Getting Started With Rust - -## Requirements - -To use the library, you should update [Rust to the latest stable version](https://github.com/rust-lang/rustup.rs#keeping-rust-up-to-date). -You can update your Rust installation by running the following command: - -```bash -rustup update stable -``` - -The nightly version should also be fine, but some changes might not be compatible. - -`no_std` is not currently supported. We are working on it in [Bee](https://github.com/iotaledger/bee), and will provide -it as feature once the new implementation is ready. - -## Using the Library - -To use the iota.rs library, you will simply need to add it as dependency in your `Cargo.toml`: - -```bash -[dependencies] -iota-client = { git = "https://github.com/iotaledger/iota.rs", branch = "production" } -# asynchronous runtime -tokio = { version = "1.12.0", features = ["full"] } -``` - -After you have added it, you can use the library in your code with `use iota_client;`. - -### Initialisation - -You can use the following example to initialize the library and fetch node information. - -```rust -use iota_client::Client; - -#[tokio::main] -async fn main() { - let iota = Client::builder() // Create a client instance builder - .with_node("https://api.lb-0.h.chrysalis-devnet.iota.cafe") - .unwrap() - .finish() - .await - .unwrap(); - - let info = iota.get_info().await.unwrap(); - println!("Nodeinfo: {:?}", info); -} -``` diff --git a/docs/build/iota.rs/1.4/docs/getting_started/wasm.md b/docs/build/iota.rs/1.4/docs/getting_started/wasm.md deleted file mode 100644 index b3f20ac2d2e..00000000000 --- a/docs/build/iota.rs/1.4/docs/getting_started/wasm.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -description: Getting started with the official IOTA Client Library Wasm binding. -image: /img/logo/libraries.png -keywords: - - Rust - - install - - npm - - system environment variables ---- - -# Getting Started with Wasm - -## Install the library - -### NPM - -```bash -npm install @iota/client-wasm -``` - -### Yarn - -```bash -yarn add @iota/client-wasm -``` - -## Build - -Alternatively, you can build the bindings if you have Rust installed. If not, refer to [rustup.rs](https://rustup.rs) for installation instructions. Then install the necessary dependencies using: - -`npm install` - -and then build the bindings for `node.js` with - -`npm run build:nodejs` - -or for the `web` with - -`npm run build:web` - -## NodeJS Setup - -```js -const iota = require('@iota/client-wasm/node'); - -async function main() { - // Get the nodeinfo - let iota_client = await iota.Client.withNode( - 'https://api.lb-0.h.chrysalis-devnet.iota.cafe/', - ); - console.log('Nodeinfo: ', await iota_client.getInfo()); -} -main(); -``` - -## Web Setup - -The library loads the WASM file with an HTTP GET request, so the .wasm file must be copied to the root of the dist folder. - -### Rollup - -- Install `rollup-plugin-copy`: - -```bash -npm install rollup-plugin-copy --save-dev -// or using yarn -yarn add rollup-plugin-copy --dev -``` - -- Add the copy plugin usage to the `plugins` array under `rollup.config.js`: - -```js -// Include the copy plugin -import copy from 'rollup-plugin-copy'; - -// Add the copy plugin to the `plugins` array of your rollup config: -copy({ - targets: [ - { - src: 'node_modules/@iota/client-wasm/web/client_wasm_bg.wasm', - dest: 'public', - rename: 'client_wasm_bg.wasm', - }, - ], -}); -``` - -### Webpack - -- Install `copy-webpack-plugin`: - -```bash -npm install copy-webpack-plugin --save-dev -// or using yarn -yarn add copy-webpack-plugin --dev -``` - -```js -// Include the copy plugin -const CopyWebPlugin= require('copy-webpack-plugin'); - -// Add the copy plugin to the `plugins` array of your webpack config: - -new CopyWebPlugin({ - patterns: [ - { - from: 'node_modules/@iota/client-wasm/web/client_wasm_bg.wasm', - to: 'client_wasm_bg.wasm' - } - ] -}), -``` - -### Usage - -```js -import * as iota from '@iota/client-wasm/web'; - -iota.init().then(() => { - async function main() { - // Get the nodeinfo - let iota_client = await iota.Client.withNode( - 'https://api.lb-0.h.chrysalis-devnet.iota.cafe/', - ); - console.log('Nodeinfo: ', await iota_client.getInfo()); - } - main(); -}); - -// or - -(async () => { - await iota.init(); - // Get the nodeinfo - let iota_client = await iota.Client.withNode( - 'https://api.lb-0.h.chrysalis-devnet.iota.cafe/', - ); - console.log('Nodeinfo: ', await iota_client.getInfo()); -})(); - -// Default path is "client_wasm_bg.wasm", but you can override it like this -await iota.init('./static/client_wasm_bg.wasm'); -``` - -`iota.init().then()` or `await iota.init()` is required to load the wasm file (from the server if not available, because of that it will only be slow for the first time) diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/Address.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/Address.mdx deleted file mode 100644 index fb535b0c40d..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/Address.mdx +++ /dev/null @@ -1,20 +0,0 @@ -### tryFromBech32(addr): [Address](#address) - -Tries to create an `Address` from a Bech32 encoded string. - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| addr | String | | - -### toBech32(hrp): String - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| hrp | String | | - -### verify(msg, signature): void - -| Parameter | Type | Description | -| --------- | ----------------------------------- | ----------- | -| msg | byte[] | | -| signature | [SignatureUnlock](#signatureunlock) | | diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/AddressDto.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/AddressDto.mdx deleted file mode 100644 index d6e98a6bc06..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/AddressDto.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### kind(): short - -The kind of address - -### address(): String - -The address itself diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/AddressIndexRecorder.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/AddressIndexRecorder.mdx deleted file mode 100644 index aa596059280..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/AddressIndexRecorder.mdx +++ /dev/null @@ -1,29 +0,0 @@ -Structure for sorting of UnlockBlocks - -### accountIndex(): long - -Index of the account - -### input(): [Input](#input) - -The input used - -### output(): [OutputResponse](#outputresponse) - -The output information - -### addressIndex(): long - -index of this address on the seed - -### chain(): [Chain](#chain) - -The chain derived from seed - -### internal(): boolean - -Whether this is an internal address - -### bech32Address(): String - -The address diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/AddressPublicWrapper.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/AddressPublicWrapper.mdx deleted file mode 100644 index 71110cf0a70..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/AddressPublicWrapper.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### isPublic(): boolean - -If this is a public address - -### address(): [Address](#address) - -The address itself diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/AddressStringPublicWrapper.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/AddressStringPublicWrapper.mdx deleted file mode 100644 index 948a2f8792c..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/AddressStringPublicWrapper.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### isPublic(): boolean - -If this is a public address - -### address(): String - -The address itself diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/Api.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/Api.mdx deleted file mode 100644 index 15003b9964a..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/Api.mdx +++ /dev/null @@ -1,39 +0,0 @@ -### GET_HEALTH - -`get_health` API - -### GET_INFO - -`get_info`API - -### GET_PEERS - -`get_peers`API - -### GET_TIPS - -`get_tips` API - -### POST_MESSAGE - -`post_message` API - -### POST_MESSAGE_WITH_REMOTE_POW - -`post_message` API with remote pow - -### GET_OUTPUT - -`get_output` API - -### GET_MILESTONE - -`get_milestone` API - -### GET_MESSAGE - -`get_message` API - -### GET_BALANCE - -`get_balance` API diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/BalanceAddressResponse.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/BalanceAddressResponse.mdx deleted file mode 100644 index 8786c8a9e5c..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/BalanceAddressResponse.mdx +++ /dev/null @@ -1,17 +0,0 @@ -Response of an address balance request - -### addressType(): short - -The type of address - -### address(): String - -The address - -### balance(): long - -The balance of this address - -### dustAllowed(): boolean - -Wether or not this address allows dust diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/BrokerOptions.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/BrokerOptions.mdx deleted file mode 100644 index 343045fd441..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/BrokerOptions.mdx +++ /dev/null @@ -1,43 +0,0 @@ -The MQTT broker options. - -### BrokerOptions(): [BrokerOptions](#brokeroptions) - -### automaticDisconnect(disconnect): [BrokerOptions](#brokeroptions) - -Whether the MQTT broker should be automatically disconnected when all topics are unsubscribed or not. - -| Parameter | Type | Description | -| ---------- | ------- | ----------- | -| disconnect | boolean | | - -### timeout(timeout): [BrokerOptions](#brokeroptions) - -timeout of the mqtt broker. - -| Parameter | Type | Description | -| --------- | ----- | ---------------------- | -| timeout | float | The timeout in seconds | - -### useWs(use_ws): [BrokerOptions](#brokeroptions) - -Defines if websockets should be used (true) or TCP (false) - -| Parameter | Type | Description | -| --------- | ------- | ---------------------------- | -| use_ws | boolean | If we use web sockets or not | - -### port(port): [BrokerOptions](#brokeroptions) - -Defines the port to be used for the MQTT connection - -| Parameter | Type | Description | -| --------- | ---- | -------------------------- | -| port | int | The port we use to conenct | - -### maxReconnectionAttempts(max_reconnection_attempts): [BrokerOptions](#brokeroptions) - -Defines the maximum reconnection attempts before it returns an error - -| Parameter | Type | Description | -| ------------------------- | ---- | -------------------- | -| max_reconnection_attempts | long | The maximum attempts | diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/Chain.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/Chain.mdx deleted file mode 100644 index 1d7baba3161..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/Chain.mdx +++ /dev/null @@ -1 +0,0 @@ -slip10 chain diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/Client.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/Client.mdx deleted file mode 100644 index 7f46b813523..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/Client.mdx +++ /dev/null @@ -1,302 +0,0 @@ -The iota.rs client instance - -### Builder(): [ClientBuilder](#clientbuilder) - -Creates a new instance of the CLient builder - -### getHealth(): boolean - -GET /health endpoint - -### getNodeHealth(node): boolean - -GET /health endpoint for the passed node - -| Parameter | Type | Description | -| --------- | ------ | ----------------------------------------------------------------------------------------------- | -| node | String | the node url which you want to query speicifically for, in the case of multiple nodes in a pool | - -### getNode(): [Node](#node) - -### getNetworkId(): long - -Gets the network id of the node we're connecting to. - -### getPowProvider(): [ClientMiner](#clientminer) - -Gets the miner to use based on the PoW setting - -### getNetworkInfo(): [NetworkInfo](#networkinfo) - -Gets the network related information such as network_id and min_pow_score -and if it's the default one, sync it first. - -### getInfo(): [NodeInfoWrapper](#nodeinfowrapper) - -GET /api/v1/info endpoint - -### getPeers(): [PeerDto[]](#peerdto) - -GET /api/v1/peers endpoint - -### getTips(): String[] - -GET /api/v1/tips endpoint - -### getOutput(output_id): [OutputResponse](#outputresponse) - -GET /api/v1/outputs/{outputId} endpoint -Find an output by its transaction_id and corresponding output_index. - -| Parameter | Type | Description | -| --------- | ------ | -------------------- | -| output_id | String | The id of the output | - -### getAddress(): [GetAddressBuilder](#getaddressbuilder) - -GET /api/v1/addresses/{address} endpoint -Creates a new instance of the AddressBuilder - -### getAddressBalance(address): [BalanceAddressResponse](#balanceaddressresponse) - -Return the balance in iota for the given address; No seed needed to do this -since we are only checking and already know the address. - -| Parameter | Type | Description | -| --------- | ------ | ------------------------------------------ | -| address | String | The address we want to get the balance for | - -### getAddressesBalances(addresses): [BalanceAddressResponse[]](#balanceaddressresponse) - -since we are only checking and already know the addresses. - -| Parameter | Type | Description | -| --------- | -------- | -------------------------------------------- | -| addresses | String[] | The addresses we want to get the balance for | - -### findOutputs(output_ids, addresses): [OutputResponse[]](#outputresponse) - -Find all outputs based on the requests criteria. This method will try to query multiple nodes if -the request amount exceeds individual node limit. - -| Parameter | Type | Description | -| ---------- | -------- | ------------------------------------------- | -| output_ids | String[] | The optional output ids to check for | -| addresses | String[] | The optional list of addresses to check for | - -### getMilestone(index): [MilestoneResponse](#milestoneresponse) - -GET /api/v1/milestones/{index} endpoint -Get the milestone by the given index. - -| Parameter | Type | Description | -| --------- | ---- | ------------------- | -| index | long | the milestone index | - -### getMilestoneUtxoChanges(index): [MilestoneUtxoChangesResponse](#milestoneutxochangesresponse) - -GET /api/v1/milestones/{index}/utxo-changes endpoint -Gets the utxo changes by the given milestone index. - -| Parameter | Type | Description | -| --------- | ---- | ------------------- | -| index | long | the milestone index | - -### getReceipts(): [ReceiptDto[]](#receiptdto) - -GET /api/v1/receipts endpoint -Get all receipts. - -### getReceiptsMigratedAt(index): [ReceiptDto[]](#receiptdto) - -GET /api/v1/receipts/{migratedAt} endpoint -Get the receipts by the given milestone index. - -| Parameter | Type | Description | -| --------- | ---- | ------------------- | -| index | long | the milestone index | - -### getTreasury(): [TreasuryResponse](#treasuryresponse) - -GET /api/v1/treasury endpoint -Get the treasury output. - -### getIncludedMessage(transaction_id): [Message](#message) - -GET /api/v1/transactions/{transactionId}/included-message -Returns the included message of the transaction. - -| Parameter | Type | Description | -| -------------- | ------------------------------- | ------------------ | -| transaction_id | [TransactionId](#transactionid) | the transaction id | - -### postMessage(msg): [MessageId](#messageid) - -POST /api/v1/messages endpoint - -| Parameter | Type | Description | -| --------- | ------------------- | ---------------------------------------------------------- | -| msg | [Message](#message) | The message to post. Use `Client.message()` to create one. | - -### reattach(message_id): [MessageWrap](#messagewrap) - -Reattaches messages for provided message id. Messages can be reattached only if they are valid and haven't been -confirmed for a while. - -| Parameter | Type | Description | -| ---------- | ----------------------- | --------------------------------- | -| message_id | [MessageId](#messageid) | The id of the Message to reattach | - -### reattachUnchecked(message_id): [MessageWrap](#messagewrap) - -Reattach a message without checking if it should be reattached - -| Parameter | Type | Description | -| ---------- | ----------------------- | --------------------------------- | -| message_id | [MessageId](#messageid) | The id of the Message to reattach | - -### promote(message_id): [MessageWrap](#messagewrap) - -Promotes a message. The method should validate if a promotion is necessary through get_message. If not, the -method should error out and should not allow unnecessary promotions. - -| Parameter | Type | Description | -| ---------- | ----------------------- | -------------------------------- | -| message_id | [MessageId](#messageid) | The id of the Message to promote | - -### promoteUnchecked(message_id): [MessageWrap](#messagewrap) - -Promote a message without checking if it should be promoted - -| Parameter | Type | Description | -| ---------- | ----------------------- | -------------------------------- | -| message_id | [MessageId](#messageid) | The id of the Message to promote | - -### getBalance(seed): [GetBalanceBuilderApi](#getbalancebuilderapi) - -Return the balance for a provided seed -Addresses with balance must be consecutive, so this method will return once it encounters a zero -balance address. - -| Parameter | Type | Description | -| --------- | ------ | -------------------------------------------------------------------- | -| seed | String | the seed which contains the addressses you want to check balance for | - -### message(): [ClientMessageBuilder](#clientmessagebuilder) - -A generic send function for easily sending transaction or indexation messages. - -### getMessage(): [GetMessageBuilder](#getmessagebuilder) - -GET /api/v1/messages/{messageId} endpoint - -### getAddresses(seed): [GetAddressesBuilder](#getaddressesbuilder) - -Return a list of addresses from the seed regardless of their validity. - -| Parameter | Type | Description | -| --------- | ------ | ----------------------------------- | -| seed | String | ssed that will create the addresses | - -### retryUntilIncluded(message_id, interval, max_attempts): [MessageWrap[]](#messagewrap) - -Retries (promotes or reattaches) a message for provided message id until it's included (referenced by a -milestone). Default interval is 5 seconds and max attempts is 40. Returns reattached messages. Set to -1 for defaults. - -| Parameter | Type | Description | -| ------------ | ----------------------- | --------------------------------- | -| message_id | [MessageId](#messageid) | The id of the Message to include | -| interval | long | The interval in seconds to try | -| max_attempts | long | The maximum attempts for retrying | - -### subscriber(): [MqttManager](#mqttmanager) - -Returns a handle to the MQTT topics manager. - -### generateMnemonic(): String - -Generates a new mnemonic. - -### mnemonicToHexSeed(mnemonic): String - -Returns a hex encoded seed for a mnemonic. - -| Parameter | Type | Description | -| --------- | ------ | --------------------------------- | -| mnemonic | String | The mmnemonic to turn into a seed | - -### findInputs(addresses, amount): [UtxoInput[]](#utxoinput) - -Function to find inputs from addresses for a provided amount (useful for offline signing) - -| Parameter | Type | Description | -| --------- | -------- | ------------------------------------ | -| addresses | String[] | The addresses to obtain balance from | -| amount | long | the amount we need to find | - -### bech32ToHex(bech32): String - -Returns a parsed hex String from bech32. - -| Parameter | Type | Description | -| --------- | ------ | ------------------------- | -| bech32 | String | The address Bech32 string | - -### hexToBech32(hex, bech32_hrp): String - -Transforms a hex encoded address to a bech32 encoded address - -| Parameter | Type | Description | -| ---------- | ------ | ------------------------- | -| hex | String | The address Bech32 string | -| bech32_hrp | String | The Bech32 hrp string | - -### hexPublicKeyToBech32Address(hex, bech32_hrp): String - -Transforms a hex encoded public key to a bech32 encoded address - -| Parameter | Type | Description | -| ---------- | ------ | ---------------------- | -| hex | String | hex encoded public key | -| bech32_hrp | String | The Bech32 hrp string | - -### isAddressValid(address): boolean - -Checks if a str is a valid bech32 encoded address. - -| Parameter | Type | Description | -| --------- | ------ | ---------------------------- | -| address | String | The addresss string to check | - -### parseBech32Address(address): [Address](#address) - -Returns a valid Address parsed from a String. - -| Parameter | Type | Description | -| --------- | ------ | ---------------------------- | -| address | String | The addresss string to parse | - -### shouldMigrate(seed, account_index, address_index, pub_addr): boolean - -Temporarily method to check if your seed is made using the incorrect generation of the old JAVA seed input - -| Parameter | Type | Description | -| ------------- | ------- | -------------------------------------------------- | -| seed | String | The seed you used previously | -| account_index | long | The account index used, is 0 when you didnt use it | -| address_index | long | The address index you want to migrate | -| pub_addr | boolean | If it's a public or internal address | - -### migrate(seed, account_index, address_index, pub_addr, to_address): [Message](#message) - -Temporarily method in order to migrate wrongly generated seeds from JAVA to Rust -Migrates the balance of the address towards the provided to_address -And returns the message or an error - -| Parameter | Type | Description | -| ------------- | ------- | -------------------------------------------------- | -| seed | String | The seed you used previously | -| account_index | long | The account index used, is 0 when you didnt use it | -| address_index | long | The address index you want to migrate | -| pub_addr | boolean | If it's a public or internal address | -| to_address | String | The address we send the balance to | diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/ClientBuilder.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/ClientBuilder.mdx deleted file mode 100644 index b7fabf5396c..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/ClientBuilder.mdx +++ /dev/null @@ -1,173 +0,0 @@ -The options builder for a client connected to multiple nodes. - -### ClientBuilder(): [ClientBuilder](#clientbuilder) - -Create a new instance of the Client - -### withNode(node): [ClientBuilder](#clientbuilder) - -Adds an IOTA node by its URL. - -| Parameter | Type | Description | -| --------- | ------ | ------------ | -| node | String | The node URL | - -### withNodes(nodes): [ClientBuilder](#clientbuilder) - -Adds a list of IOTA nodes by their URLs. - -| Parameter | Type | Description | -| --------- | -------- | --------------------- | -| nodes | String[] | The list of node URLs | - -### withNodeAuth(node, jwt, username, password): [ClientBuilder](#clientbuilder) - -Adds an IOTA node by its URL with optional jwt and or basic authentication - -| Parameter | Type | Description | -| --------- | ------ | ------------------------------------------------------------------- | -| node | String | The node URL | -| jwt | String | The JWT, can be `null` | -| username | String | The username, can be `null` | -| password | String | The password, can be `null`. Only checked if username is not `null` | - -### withPrimaryNode(node, jwt, username, password): [ClientBuilder](#clientbuilder) - -Adds an IOTA node by its URL to be used as primary node, with optional jwt and or basic authentication - -| Parameter | Type | Description | -| --------- | ------ | ------------------------------------------------------------------- | -| node | String | The node URL | -| jwt | String | The JWT, can be `null` | -| username | String | The username, can be `null` | -| password | String | The password, can be `null`. Only checked if username is not `null` | - -### withPrimaryPowNode(node, jwt, username, password): [ClientBuilder](#clientbuilder) - -Adds an IOTA node by its URL to be used as primary PoW node (for remote PoW), with optional jwt and or basic -authentication - -| Parameter | Type | Description | -| --------- | ------ | ------------------------------------------------------------------- | -| node | String | The node URL | -| jwt | String | The JWT, can be `null` | -| username | String | The username, can be `null` | -| password | String | The password, can be `null`. Only checked if username is not `null` | - -### withPermanode(node, jwt, username, password): [ClientBuilder](#clientbuilder) - -Adds an IOTA permanode by its URL, with optional jwt and or basic authentication - -| Parameter | Type | Description | -| --------- | ------ | ------------------------------------------------------------------- | -| node | String | The node URL | -| jwt | String | The JWT, can be `null` | -| username | String | The username, can be `null` | -| password | String | The password, can be `null`. Only checked if username is not `null` | - -### withNodePoolUrls(node_pool_urls): [ClientBuilder](#clientbuilder) - -Get node list from the node_pool_urls - -| Parameter | Type | Description | -| -------------- | -------- | -------------------------------------------------- | -| node_pool_urls | String[] | node_pool_urls list of node URLs for the node pool | - -### withOfflineMode(): [ClientBuilder](#clientbuilder) - -Allows creating the client without nodes for offline address generation or signing - -### withNetwork(network): [ClientBuilder](#clientbuilder) - -Client connected to the default Network pool unless specified. - -``` -import org.iota.client.ClientBuilder; -Client clientOptions = new ClientBuilder().with_network("devnet").build(); -``` - -| Parameter | Type | Description | -| --------- | ------ | ------------------------- | -| network | String | The network we connect to | - -### withNodeSyncInterval(node_sync_interval): [ClientBuilder](#clientbuilder) - -Set the node sync interval - -| Parameter | Type | Description | -| ------------------ | ----- | ----------------------- | -| node_sync_interval | float | The interval in seconds | - -### withNodeSyncDisabled(): [ClientBuilder](#clientbuilder) - -Disables the node syncing process. -Every node will be considered healthy and ready to use. - -### withQuorum(quorum): [ClientBuilder](#clientbuilder) - -Set if quorum should be used or not - -| Parameter | Type | Description | -| --------- | ------- | ------------------------- | -| quorum | boolean | `true` if we use a quorum | - -### withQuorumSize(quorum_size): [ClientBuilder](#clientbuilder) - -Set amount of nodes which should be used for quorum - -| Parameter | Type | Description | -| ----------- | ---- | ------------------- | -| quorum_size | long | The amount of nodes | - -### withQuorumThreshold(threshold): [ClientBuilder](#clientbuilder) - -Set quorum threshold - -| Parameter | Type | Description | -| --------- | ---- | -------------------------------------------------- | -| threshold | long | The percentage of nodes that need to agree (0-100) | - -### withMqttBrokerOptions(options): [ClientBuilder](#clientbuilder) - -Sets the MQTT broker options. - -| Parameter | Type | Description | -| --------- | ------------------------------- | ---------------- | -| options | [BrokerOptions](#brokeroptions) | the MQTT options | - -### withLocalPow(local): [ClientBuilder](#clientbuilder) - -Sets whether the PoW should be done locally or remotely. - -| Parameter | Type | Description | -| --------- | ------- | ----------------------------- | -| local | boolean | Enables or disables local PoW | - -### withTipsInterval(tips): [ClientBuilder](#clientbuilder) - -Sets after how many seconds new tips will be requested during PoW - -| Parameter | Type | Description | -| --------- | ---- | ---------------- | -| tips | long | delay in seconds | - -### withRequestTimeout(timeout): [ClientBuilder](#clientbuilder) - -Sets the default request timeout in seconds. - -| Parameter | Type | Description | -| --------- | ----- | ------------------------------ | -| timeout | float | The request timeout in seconds | - -### withApiTimeout(api, timeout): [ClientBuilder](#clientbuilder) - -Sets the request timeout in seconds for a specific API usage. - -| Parameter | Type | Description | -| --------- | ----------- | ------------------------------ | -| api | [Api](#api) | The API we set the timeout for | -| timeout | float | The request timeout in seconds | - -### finish(): [Client](#client) - -Build the Client instance. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/ClientException.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/ClientException.mdx deleted file mode 100644 index e329b021382..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/ClientException.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### ClientException(): [ClientException](#clientexception) - -### ClientException(errorMessage): [ClientException](#clientexception) - -| Parameter | Type | Description | -| ------------ | ------ | ----------- | -| errorMessage | String | | diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/ClientMessageBuilder.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/ClientMessageBuilder.mdx deleted file mode 100644 index 71294442191..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/ClientMessageBuilder.mdx +++ /dev/null @@ -1,166 +0,0 @@ -### withSeed(seed): [ClientMessageBuilder](#clientmessagebuilder) - -Sets the seed. - -| Parameter | Type | Description | -| --------- | ------ | --------------- | -| seed | String | The seed to use | - -### withAccountIndex(account_index): [ClientMessageBuilder](#clientmessagebuilder) - -Sets the account index. - -| Parameter | Type | Description | -| ------------- | ---- | ---------------- | -| account_index | long | The index to set | - -### withInitialAddressIndex(initial_address_index): [ClientMessageBuilder](#clientmessagebuilder) - -Sets the index of the address to start looking for balance. - -| Parameter | Type | Description | -| --------------------- | ---- | ---------------------------------------------- | -| initial_address_index | long | The initial index to start address search from | - -### withInput(input): [ClientMessageBuilder](#clientmessagebuilder) - -Set a custom input(transaction output) - -| Parameter | Type | Description | -| --------- | ----------------------- | ---------------- | -| input | [UtxoInput](#utxoinput) | The custom input | - -### withInputRange(low, high): [ClientMessageBuilder](#clientmessagebuilder) - -Set a custom range in which to search for addresses for custom inputs. Default: 0..100 - -| Parameter | Type | Description | -| --------- | ---- | ------------------------------ | -| low | long | Low end of input range (0) | -| high | long | Upper end of input range (100) | - -### withOutput(address, amount): [ClientMessageBuilder](#clientmessagebuilder) - -Insert the output address and amount to spent. The amount cannot be zero. - -| Parameter | Type | Description | -| --------- | ------ | ------------------------ | -| address | String | The address we send to | -| amount | long | The amount to send (> 0) | - -### withDustAllowanceOutput(address, amount): [ClientMessageBuilder](#clientmessagebuilder) - -Set a dust allowance transfer to the builder, address needs to be Bech32 encoded - -| Parameter | Type | Description | -| --------- | ------ | ------------------------------------- | -| address | String | The Bech32 encoded address we send to | -| amount | long | The amount to send (> 0) | - -### withOutputHex(address, amount): [ClientMessageBuilder](#clientmessagebuilder) - -Set a transfer to the builder, address needs to be hex encoded - -| Parameter | Type | Description | -| --------- | ------ | ---------------------------------- | -| address | String | The hex encoded address we send to | -| amount | long | The amount to send (> 0) | - -### withIndexVec(index): [ClientMessageBuilder](#clientmessagebuilder) - -Set indexation to the builder - -| Parameter | Type | Description | -| --------- | ------ | ---------------- | -| index | byte[] | The index to use | - -### withIndexString(index): [ClientMessageBuilder](#clientmessagebuilder) - -Set indexation to the builder - -| Parameter | Type | Description | -| --------- | ------ | ---------------- | -| index | String | The index to use | - -### withData(data): [ClientMessageBuilder](#clientmessagebuilder) - -Set data to the builder - -| Parameter | Type | Description | -| --------- | ------ | --------------- | -| data | byte[] | The data to use | - -### withDataString(data): [ClientMessageBuilder](#clientmessagebuilder) - -Set data to the builder - -| Parameter | Type | Description | -| --------- | ------ | --------------- | -| data | String | The data to use | - -### prepareTransaction(): [PreparedTransactionData](#preparedtransactiondata) - -Prepare a transaction. Used as parameter for `signTransaction` - -### signTransaction(prepared_transaction_data, seed, inputs_range_low, inputs_range_high): [MessagePayload](#messagepayload) - -Sign the transaction. inputsRangeLow and high to 0 for not using an input range - -| Parameter | Type | Description | -| ------------------------- | --------------------------------------------------- | ---------------------------------------------------- | -| prepared_transaction_data | [PreparedTransactionData](#preparedtransactiondata) | The completely prepared transaction | -| seed | String | The seed used to prepare the transaction | -| inputs_range_low | long | Lower input used for getting adresses (default: 0) | -| inputs_range_high | long | Upper input used for getting adresses (default: 100) | - -### finish(payload): [Message](#message) - -Consume the builder and return the message made with the specific payload - -| Parameter | Type | Description | -| --------- | --------------------------------- | ------------------------------------ | -| payload | [MessagePayload](#messagepayload) | A prepared and signed MessagePayload | - -### finishTransaction(payload): [Message](#message) - -Consume the builder and return the message made with the specific payload - -| Parameter | Type | Description | -| --------- | ----------------------------------------- | ---------------------------------------- | -| payload | [TransactionPayload](#transactionpayload) | A prepared and signed TransactionPayload | - -### finishMilestone(payload): [Message](#message) - -Consume the builder and return the message made with the specific payload - -| Parameter | Type | Description | -| --------- | ------------------------------------- | -------------------------------------- | -| payload | [MilestonePayload](#milestonepayload) | A prepared and signed MilestonePayload | - -### finishIndex(payload): [Message](#message) - -Consume the builder and return the message made with the specific payload - -| Parameter | Type | Description | -| --------- | --------------------------------------- | --------------------------------------- | -| payload | [IndexationPayload](#indexationpayload) | A prepared and signed IndexationPayload | - -### finishReceipt(payload): [Message](#message) - -Consume the builder and return the message made with the specific payload - -| Parameter | Type | Description | -| --------- | --------------------------------- | ------------------------------------ | -| payload | [ReceiptPayload](#receiptpayload) | A prepared and signed ReceiptPayload | - -### finishTreasury(payload): [Message](#message) - -Consume the builder and return the message made with the specific payload - -| Parameter | Type | Description | -| --------- | ----------------------------------- | ------------------------------------- | -| payload | [TreasuryPayload](#treasurypayload) | A prepared and signed TreasuryPayload | - -### finish(): [Message](#message) - -Consume the builder and return the message diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/ClientMiner.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/ClientMiner.mdx deleted file mode 100644 index fc9abd0c81c..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/ClientMiner.mdx +++ /dev/null @@ -1 +0,0 @@ -Client miner, used as diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/Essence.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/Essence.mdx deleted file mode 100644 index 12ebd04760f..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/Essence.mdx +++ /dev/null @@ -1 +0,0 @@ -### asRegular(): [RegularEssence](#regularessence) diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/GetAddressBuilder.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/GetAddressBuilder.mdx deleted file mode 100644 index 2639a6d77fc..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/GetAddressBuilder.mdx +++ /dev/null @@ -1,22 +0,0 @@ -Builder of GET /api/v1/address/{address} endpoint - -### balance(address): [BalanceAddressResponse](#balanceaddressresponse) - -Consume the builder and get the balance of a given Bech32 encoded address. -If count equals maxResults, then there might be more outputs available but those were skipped for performance -reasons. User should sweep the address to reduce the amount of outputs. - -| Parameter | Type | Description | -| --------- | ------ | ---------------------------------- | -| address | String | The address to get the balance for | - -### outputs(address, options): [UtxoInput[]](#utxoinput) - -Consume the builder and get all outputs that use a given address. -If count equals maxResults, then there might be more outputs available but those were skipped for performance -reasons. User should sweep the address to reduce the amount of outputs. - -| Parameter | Type | Description | -| --------- | --------------------------------- | ---------------------------------- | -| address | String | The address to get the balance for | -| options | [OutputsOptions](#outputsoptions) | The options for finding outputs | diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/GetAddressesBuilder.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/GetAddressesBuilder.mdx deleted file mode 100644 index 0a27487aa9d..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/GetAddressesBuilder.mdx +++ /dev/null @@ -1,58 +0,0 @@ -### from(seed): [GetAddressesBuilder](#getaddressesbuilder) - -Construct a new addressbuilder with a seed. Invalid seeds throw an error - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| seed | String | | - -### fromOld(seed): [GetAddressesBuilder](#getaddressesbuilder) - -DEBUG DO NOT USE - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| seed | String | | - -### withAccountIndex(account_index): [GetAddressesBuilder](#getaddressesbuilder) - -Set the account index - -| Parameter | Type | Description | -| ------------- | ---- | ----------- | -| account_index | long | | - -### withRange(start, end): [GetAddressesBuilder](#getaddressesbuilder) - -Set range to the builder - -| Parameter | Type | Description | -| --------- | ---- | ----------- | -| start | long | | -| end | long | | - -### withBech32Hrp(bech32_hrp): [GetAddressesBuilder](#getaddressesbuilder) - -Set bech32 human readable part (hrp) - -| Parameter | Type | Description | -| ---------- | ------ | ----------- | -| bech32_hrp | String | | - -### withClient(client): [GetAddressesBuilder](#getaddressesbuilder) - -Set client to the builder - -| Parameter | Type | Description | -| --------- | ----------------- | ----------- | -| client | [Client](#client) | | - -### finish(): String[] - -Consume the builder and get a vector of public addresses bech32 encoded - -### getAll(): [AddressStringPublicWrapper[]](#addressstringpublicwrapper) - -### getAllRaw(): [AddressPublicWrapper[]](#addresspublicwrapper) - -Consume the builder and get the vector of public and internal addresses diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/GetBalanceBuilderApi.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/GetBalanceBuilderApi.mdx deleted file mode 100644 index 51a01a503ef..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/GetBalanceBuilderApi.mdx +++ /dev/null @@ -1,28 +0,0 @@ -### withAccountIndex(account_index): [GetBalanceBuilderApi](#getbalancebuilderapi) - -Sets the account index. - -| Parameter | Type | Description | -| ------------- | ---- | ------------------------------------- | -| account_index | long | The account index to use (Default: 0) | - -### withInitialAddressIndex(initial_address_index): [GetBalanceBuilderApi](#getbalancebuilderapi) - -Sets the index of the address to start looking for balance. - -| Parameter | Type | Description | -| --------------------- | ---- | -------------------------------------------------------------- | -| initial_address_index | long | The starting index to use for searching addresses (Default: 0) | - -### withGapLimit(gap_limit): [GetBalanceBuilderApi](#getbalancebuilderapi) - -Sets the gap limit to specify how many addresses will be checked each round. -If gap_limit amount of addresses in a row have no balance the function will return. - -| Parameter | Type | Description | -| --------- | ---- | --------------------------- | -| gap_limit | long | The gap limit (Default: 20) | - -### finish(): long - -Consume the builder and get the API result diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/GetMessageBuilder.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/GetMessageBuilder.mdx deleted file mode 100644 index baa92d494cc..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/GetMessageBuilder.mdx +++ /dev/null @@ -1,53 +0,0 @@ -### indexString(index): [MessageId[]](#messageid) - -GET /api/v1/messages?index={Index} endpoint -Consume the builder and search for messages matching the index - -| Parameter | Type | Description | -| --------- | ------ | ---------------- | -| index | String | the index string | - -### indexVec(index): [MessageId[]](#messageid) - -GET /api/v1/messages?index={Index} endpoint -Consume the builder and search for messages matching the index - -| Parameter | Type | Description | -| --------- | ------ | ------------------ | -| index | byte[] | the index in bytes | - -### data(message_id): [Message](#message) - -GET /api/v1/messages/{messageID} endpoint -Consume the builder and find a message by its identifer. This method returns the given message object. - -| Parameter | Type | Description | -| ---------- | ----------------------- | ----------------------------- | -| message_id | [MessageId](#messageid) | The id of the message to find | - -### metadata(message_id): [MessageMetadata](#messagemetadata) - -GET /api/v1/messages/{messageID}/metadata endpoint -Consume the builder and find a message by its identifer. This method returns the given message metadata. - -| Parameter | Type | Description | -| ---------- | ----------------------- | ----------------------------- | -| message_id | [MessageId](#messageid) | The id of the message to find | - -### raw(message_id): String - -GET /api/v1/messages/{messageID}/raw endpoint -Consume the builder and find a message by its identifer. This method returns the given message raw data. - -| Parameter | Type | Description | -| ---------- | ----------------------- | ----------------------------- | -| message_id | [MessageId](#messageid) | The id of the message to find | - -### children(message_id): [MessageId[]](#messageid) - -GET /api/v1/messages/{messageID}/children endpoint -Consume the builder and returns the list of message IDs that reference a message by its identifier. - -| Parameter | Type | Description | -| ---------- | ----------------------- | ----------------------------- | -| message_id | [MessageId](#messageid) | The id of the message to find | diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/GossipDto.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/GossipDto.mdx deleted file mode 100644 index 5a9d25d6cf1..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/GossipDto.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### heartbeat(): [HeartbeatDto](#heartbeatdto) - -The hearthbeat information - -### metrics(): [MetricsDto](#metricsdto) - -The metrics information diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/HeartbeatDto.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/HeartbeatDto.mdx deleted file mode 100644 index 5b72b285b21..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/HeartbeatDto.mdx +++ /dev/null @@ -1,19 +0,0 @@ -### solidMilestoneIndex(): long - -The solid milestone index - -### prunedMilestoneIndex(): long - -The pruend milestone index - -### latestMilestoneIndex(): long - -The latest milestone index - -### connectedNeighbors(): short - -The amount of connected neighbors - -### syncedNeighbors(): short - -The amount of synced neighbors diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/IndexPublicDto.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/IndexPublicDto.mdx deleted file mode 100644 index c555b1a1a5b..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/IndexPublicDto.mdx +++ /dev/null @@ -1,3 +0,0 @@ -### index(): long - -### isPublic(): boolean diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/IndexationPayload.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/IndexationPayload.mdx deleted file mode 100644 index d4598b959e5..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/IndexationPayload.mdx +++ /dev/null @@ -1,33 +0,0 @@ -### fromBytes(index, data): [IndexationPayload](#indexationpayload) - -Creates a new `IndexationPayload`. - -| Parameter | Type | Description | -| --------- | ------ | ----------------------------- | -| index | byte[] | The index | -| data | byte[] | The data linked ot this index | - -### fromStrings(index, data): [IndexationPayload](#indexationpayload) - -Creates a new `IndexationPayload` from strings - -| Parameter | Type | Description | -| --------- | ------ | ----------------------------- | -| index | String | The index | -| data | String | The data linked ot this index | - -### index(): byte[] - -Returns the index of an `IndexationPayload`. - -### indexString(): String - -Returns the index of an `IndexationPayload`. - -### data(): byte[] - -Returns the data of an `IndexationPayload`. - -### dataString(): String - -Returns the data of an `IndexationPayload`. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/InfoResponse.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/InfoResponse.mdx deleted file mode 100644 index 610f201eddc..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/InfoResponse.mdx +++ /dev/null @@ -1,54 +0,0 @@ -Response of GET /api/v1/info. -Returns general information about the node. - -### name(): String - -The name of the node - -### version(): String - -The node software version - -### networkId(): String - -The network id the node is connected to - -### bech32Hrp(): String - -The bech32 HRP which is accepted by this node - -### messagesPerSecond(): double - -The messages per second this node is receiving - -### referencedMessagesPerSecond(): double - -The referenced messages per second this node is receiving - -### referencedRate(): double - -The reference rate - -### latestMilestoneTimestamp(): long - -The timestamp of the latest received milestone - -### minPowScore(): double - -The minimum required PoW for a message to be accepted - -### latestMilestoneIndex(): long - -The index of the latest seen milestone - -### confirmedMilestoneIndex(): long - -The index of the latest confirmed milestone - -### pruningIndex(): long - -The milestone index this node is pruning from - -### features(): String[] - -List of features running on this node diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/Input.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/Input.mdx deleted file mode 100644 index 47c8fffd655..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/Input.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### kind(): [InputKind](#inputkind) - -### asUtxo(): [UtxoInput](#utxoinput) - -### asTreasury(): [TreasuryInput](#treasuryinput) diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/InputKind.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/InputKind.mdx deleted file mode 100644 index 7aac49186c5..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/InputKind.mdx +++ /dev/null @@ -1,3 +0,0 @@ -### UTXO - -### TREASURY diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/LedgerInclusionStateDto.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/LedgerInclusionStateDto.mdx deleted file mode 100644 index 08e4d603443..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/LedgerInclusionStateDto.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### CONFLICTING - -### INCLUDED - -### NO_TRANSACTION diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/Message.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/Message.mdx deleted file mode 100644 index 15041e420c0..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/Message.mdx +++ /dev/null @@ -1,25 +0,0 @@ -Represent the object that nodes gossip around the network. - -### builder(): [MessageBuilder](#messagebuilder) - -Creates a new `MessageBuilder` to construct an instance of a `Message`. - -### networkId(): long - -Returns the network id of a `Message`. - -### id(): [MessageId](#messageid) - -Computes the identifier of the message. - -### nonce(): long - -Returns the nonce of a `Message`. - -### parents(): [MessageId[]](#messageid) - -Returns the parents of a `Message`. - -### payload(): Optional<[MessagePayload](#messagepayload)> - -Returns the optional payload of a `Message`. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/MessageBuilder.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/MessageBuilder.mdx deleted file mode 100644 index 01854b2d2b7..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/MessageBuilder.mdx +++ /dev/null @@ -1,42 +0,0 @@ -A builder to build a `Message`. - -### MessageBuilder(): [MessageBuilder](#messagebuilder) - -Creates a new `MessageBuilder`. - -### networkId(network_id): [MessageBuilder](#messagebuilder) - -Adds a network id to a `MessageBuilder`. - -| Parameter | Type | Description | -| ---------- | ---- | -------------- | -| network_id | long | The network id | - -### parents(parents): [MessageBuilder](#messagebuilder) - -Adds parents to a `MessageBuilder`. - -| Parameter | Type | Description | -| --------- | ------------------------- | ------------------------ | -| parents | [MessageId[]](#messageid) | A list of parents to set | - -### payload(payload): [MessageBuilder](#messagebuilder) - -Adds a payload to a `MessageBuilder`. - -| Parameter | Type | Description | -| --------- | --------------------------------- | ------------------------- | -| payload | [MessagePayload](#messagepayload) | the MessagePayload to set | - -### nonceProvider(provider, target_score): [MessageBuilder](#messagebuilder) - -Sets a provider for the nonce. Can currently only be obtained from Client.getPowProvider - -| Parameter | Type | Description | -| ------------ | --------------------------- | --------------------------------------------- | -| provider | [ClientMiner](#clientminer) | Sets the nonce provider | -| target_score | double | Target score for the nonce, Recommended: 4000 | - -### finish(): [Message](#message) - -Finish the MessageBuilder diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/MessageId.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/MessageId.mdx deleted file mode 100644 index 44893c4b48d..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/MessageId.mdx +++ /dev/null @@ -1,9 +0,0 @@ -### MessageId(): [MessageId](#messageid) - -### fromString(str_rep): [MessageId](#messageid) - -Create a MessageId from string - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| str_rep | String | | diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/MessageMetadata.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/MessageMetadata.mdx deleted file mode 100644 index 8bcfe020b95..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/MessageMetadata.mdx +++ /dev/null @@ -1,38 +0,0 @@ -Response of GET /api/v1/messages/{message_id}/metadata. -Returns the metadata of a message. - -### messageId(): String - -The message id of this message - -### parentMessageIds(): String[] - -The ids of the parents of this message - -### isSolid(): boolean - -IF this message is solid - -### referencedByMilestoneIndex(): long - -The optional milestone index if this message is referenced - -### milestoneIndex(): long - -The optional milestone index this was included in - -### ledgerInclusionState(): Optional<[LedgerInclusionStateDto](#ledgerinclusionstatedto)> - -The ledger state - -### conflictReason(): int - -The optional reason of conflict - -### shouldPromote(): Optional<Boolean> - -Optional; if the message needs to be promoted - -### shouldReattach(): Optional<Boolean> - -Optional; if the message needs to be reattached diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/MessagePayload.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/MessagePayload.mdx deleted file mode 100644 index fe70b135796..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/MessagePayload.mdx +++ /dev/null @@ -1,27 +0,0 @@ -Message payload wrapper - -### deserialize(serialised_data): [MessagePayload](#messagepayload) - -Turns a serialized message payload string back into its class - -| Parameter | Type | Description | -| --------------- | ------ | ----------- | -| serialised_data | String | | - -### payloadType(): [MessagePayloadType](#messagepayloadtype) - -Get the type of message this contains (used to select the correct getter) - -### asIndexation(): [IndexationPayload](#indexationpayload) - -### asMilestone(): [MilestonePayload](#milestonepayload) - -### asTransaction(): [TransactionPayload](#transactionpayload) - -### asReceipt(): [ReceiptPayload](#receiptpayload) - -### asTreasury(): [TreasuryPayload](#treasurypayload) - -### serialize(): String - -Serializes the message payload into a json string diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/MessagePayloadType.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/MessagePayloadType.mdx deleted file mode 100644 index a3c82243116..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/MessagePayloadType.mdx +++ /dev/null @@ -1,9 +0,0 @@ -### TRANSACTION - -### MILESTONE - -### INDEXATION - -### RECEIPT - -### TREASURY_TRANSACTION diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/MessageWrap.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/MessageWrap.mdx deleted file mode 100644 index 7b6d0b87c11..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/MessageWrap.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### message_id(): [MessageId](#messageid) - -The ID of this message - -### message(): [Message](#message) - -The message diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/MetricsDto.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/MetricsDto.mdx deleted file mode 100644 index 283ee3ee2fb..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/MetricsDto.mdx +++ /dev/null @@ -1,43 +0,0 @@ -### newMessages(): long - -The amount of new messages received - -### receivedMessages(): long - -The amount of received messages - -### knownMessages(): long - -The amount of received known messages - -### receivedMessageRequests(): long - -The amount of received requested messages - -### receivedMilestoneRequests(): long - -The amount of received requested milestones - -### receivedHeartbeats(): long - -The amount of received heartbeats - -### sentMessages(): long - -The amount of sent messages - -### sentMessageRequests(): long - -The amount of sent messages requests - -### sentMilestoneRequests(): long - -The amount of sent milestone requests - -### sentHeartbeats(): long - -The amount of sent heartbeats - -### droppedPackets(): long - -The amount of dropped packets diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/MigratedFundsEntry.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/MigratedFundsEntry.mdx deleted file mode 100644 index e4999419b08..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/MigratedFundsEntry.mdx +++ /dev/null @@ -1,16 +0,0 @@ -### from(hash, output): [MigratedFundsEntry](#migratedfundsentry) - -Creates a new `MigratedFundsEntry`. - -| Parameter | Type | Description | -| --------- | ----------------------------------------------------------- | ------------------------------------------------------- | -| hash | String | The hash from the transaction used to receive the funds | -| output | [SignatureLockedSingleOutput](#signaturelockedsingleoutput) | the output related to this transaction | - -### tailTransactionHash(): String - -Returns the tail transaction hash of a `MigratedFundsEntry`. - -### output(): [SignatureLockedSingleOutput](#signaturelockedsingleoutput) - -Returns the output of a `MigratedFundsEntry`. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/MigratedFundsEntryDto.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/MigratedFundsEntryDto.mdx deleted file mode 100644 index 94ce5acc94f..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/MigratedFundsEntryDto.mdx +++ /dev/null @@ -1,11 +0,0 @@ -### tailTransactionHash(): String - -The tail transaction hash - -### address(): [AddressDto](#addressdto) - -The address this was deposited to - -### deposit(): long - -The amount that was deposited diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/MilestoneId.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/MilestoneId.mdx deleted file mode 100644 index 57ee3d0f20a..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/MilestoneId.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### fromString(str_rep): [MilestoneId](#milestoneid) - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| str_rep | String | | diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/MilestonePayload.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/MilestonePayload.mdx deleted file mode 100644 index 0e9f4c04d22..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/MilestonePayload.mdx +++ /dev/null @@ -1,22 +0,0 @@ -A payload which defines the inclusion set of other messages in the Tangle. - -### essence(): [MilestonePayloadEssence](#milestonepayloadessence) - -Returns the essence of a `MilestonePayload`. - -### signatures(): [MilestoneSignature[]](#milestonesignature) - -Returns the signatures of a `MilestonePayload`. - -### validate(applicable_public_keys, min_threshold): void - -Semantically validate a `MilestonePayload`. - -| Parameter | Type | Description | -| ---------------------- | -------- | --------------------------------------------------- | -| applicable_public_keys | String[] | The public keys to use to validate | -| min_threshold | long | THe minimum threshold for this to succeed (0...100) | - -### id(): String - -Computes the identifier of a `MilestonePayload`. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/MilestonePayloadEssence.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/MilestonePayloadEssence.mdx deleted file mode 100644 index 9b1cfb8f616..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/MilestonePayloadEssence.mdx +++ /dev/null @@ -1,35 +0,0 @@ -### index(): long - -Returns the index of a `MilestonePayloadEssence`. - -### timestamp(): long - -Returns the timestamp of a `MilestonePayloadEssence`. - -### parents(): [MessageId[]](#messageid) - -Returns the parents of a `MilestonePayloadEssence`. - -### merkleProof(): byte[] - -Returns the merkle proof of a `MilestonePayloadEssence`. - -### nextPowScore(): long - -Returns the next proof of work score of a `MilestonePayloadEssence`. - -### nextPowScoreMilestone(): long - -Returns the next proof of work index of a `MilestonePayloadEssence`. - -### publicKeys(): [PublicKey[]](#publickey) - -Returns the public keys of a `MilestonePayloadEssence`. - -### receipt(): Optional<[ReceiptPayload](#receiptpayload)> - -Returns the optional receipt of a `MilestonePayloadEssence`. - -### hash(): byte[] - -Hashes the `MilestonePayloadEssence to be signed.` diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/MilestoneResponse.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/MilestoneResponse.mdx deleted file mode 100644 index 741a766e2c5..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/MilestoneResponse.mdx +++ /dev/null @@ -1,11 +0,0 @@ -### index(): long - -Milestone index. - -### messageId(): [MessageId](#messageid) - -Milestone message id - -### timestamp(): long - -Milestone timestamp. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/MilestoneSignature.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/MilestoneSignature.mdx deleted file mode 100644 index 2fcd24f606b..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/MilestoneSignature.mdx +++ /dev/null @@ -1,3 +0,0 @@ -### getSignature(): byte[] - -Gets the signature of the milestone diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/MilestoneUtxoChangesResponse.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/MilestoneUtxoChangesResponse.mdx deleted file mode 100644 index d0cb3754efa..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/MilestoneUtxoChangesResponse.mdx +++ /dev/null @@ -1,11 +0,0 @@ -### index(): long - -Milestone index. - -### createdOutputs(): String[] - -Milestone message id - -### consumedOutputs(): String[] - -Milestone timestamp. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/MqttEvent.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/MqttEvent.mdx deleted file mode 100644 index d970a32f028..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/MqttEvent.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### CONNECTED - -Client was connected. - -### DISCONNECTED - -Client was disconnected. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/MqttListener.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/MqttListener.mdx deleted file mode 100644 index 0cd25b4f884..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/MqttListener.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### onEvent(event): void - -| Parameter | Type | Description | -| --------- | ------------------------- | ----------- | -| event | [TopicEvent](#topicevent) | | diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/MqttManager.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/MqttManager.mdx deleted file mode 100644 index e872ede401a..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/MqttManager.mdx +++ /dev/null @@ -1,24 +0,0 @@ -### withTopic(topic): [MqttTopicManager](#mqtttopicmanager) - -Add a new topic to the list. - -| Parameter | Type | Description | -| --------- | --------------- | ----------- | -| topic | [Topic](#topic) | | - -### withTopics(topics): [MqttTopicManager](#mqtttopicmanager) - -Add a collection of topics to the list. - -| Parameter | Type | Description | -| --------- | ----------------- | ----------- | -| topics | [Topic[]](#topic) | | - -### unsubscribe(): void - -Unsubscribes from all subscriptions. - -### disconnect(): void - -Disconnects the broker. -This will clear the stored topic handlers and close the MQTT connection. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/MqttTopicManager.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/MqttTopicManager.mdx deleted file mode 100644 index bd4b42ec03b..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/MqttTopicManager.mdx +++ /dev/null @@ -1,20 +0,0 @@ -### withTopic(topic): [MqttTopicManager](#mqtttopicmanager) - -Add a new topic to the list. - -| Parameter | Type | Description | -| --------- | --------------- | ----------- | -| topic | [Topic](#topic) | | - -### withTopics(topics): [MqttTopicManager](#mqtttopicmanager) - -Add a collection of topics to the list. - -| Parameter | Type | Description | -| --------- | ----------------- | ----------- | -| topics | [Topic[]](#topic) | | - -### unsubscribe(): void - -Unsubscribe from the given topics. -If no topics were provided, the function will unsubscribe from every subscribed topic. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/NativeAPI.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/NativeAPI.mdx deleted file mode 100644 index 0a71cc98dea..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/NativeAPI.mdx +++ /dev/null @@ -1,3 +0,0 @@ -The NativeAPI class, which houses all entrypoints to the shared library. - -### verifyLink(): void diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/NetworkInfo.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/NetworkInfo.mdx deleted file mode 100644 index 449ebd39732..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/NetworkInfo.mdx +++ /dev/null @@ -1,15 +0,0 @@ -Struct containing network and PoW related information - -### network(): Optional<String> - -### networkId(): long - -### bech32Hrp(): String - -### minPowScore(): double - -### localPow(): boolean - -### fallbackToLocalPow(): boolean - -### tipsInterval(): long diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/Node.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/Node.mdx deleted file mode 100644 index 3c9a49093f5..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/Node.mdx +++ /dev/null @@ -1,9 +0,0 @@ -Node struct - -### url(): String - -node url - -### jwt(): Optional<String> - -node jwt diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/NodeInfoWrapper.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/NodeInfoWrapper.mdx deleted file mode 100644 index 1cfde7fe8df..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/NodeInfoWrapper.mdx +++ /dev/null @@ -1,9 +0,0 @@ -Wrapper for node information - -### url(): String - -Get the URL from which this info is derived - -### nodeInfo(): [InfoResponse](#inforesponse) - -Get the information diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/Output.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/Output.mdx deleted file mode 100644 index 5b1fe93a442..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/Output.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### kind(): [OutputKind](#outputkind) - -### asSignatureLockedSingleOutput(): [SignatureLockedSingleOutput](#signaturelockedsingleoutput) - -### asSignatureLockedDustAllowanceOutput(): [SignatureLockedDustAllowanceOutput](#signaturelockeddustallowanceoutput) - -### asTreasuryOutput(): [TreasuryOutput](#treasuryoutput) diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/OutputDto.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/OutputDto.mdx deleted file mode 100644 index 1e86156c500..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/OutputDto.mdx +++ /dev/null @@ -1,9 +0,0 @@ -Wrapper for different output types - -### kind(): [OutputKind](#outputkind) - -### asSignatureLockedSingleOutputDto(): [SignatureLockedSingleOutputDto](#signaturelockedsingleoutputdto) - -### asSignatureLockedDustAllowanceOutputDto(): [SignatureLockedDustAllowanceOutputDto](#signaturelockeddustallowanceoutputdto) - -### asTreasuryOutput(): [TreasuryOutputDto](#treasuryoutputdto) diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/OutputKind.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/OutputKind.mdx deleted file mode 100644 index ab00964b277..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/OutputKind.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### SIGNATURE_LOCKED_SINGLE - -### SIGNATURE_LOCKED_DUST_ALLOWANCE - -### TREASURY diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/OutputResponse.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/OutputResponse.mdx deleted file mode 100644 index b4385f47612..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/OutputResponse.mdx +++ /dev/null @@ -1,22 +0,0 @@ -Response of GET /api/v1/outputs/{output_id}. -Returns all information about a specific output. - -### messageId(): String - -The message id this output is related to - -### transactionId(): String - -The transaction id this output is related to - -### outputIndex(): int - -The output index - -### isSpent(): boolean - -`true` if this output was spent. Otherwise `false` - -### output(): [OutputDto](#outputdto) - -Get the output object which can be turned into its specific output type diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/OutputsOptions.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/OutputsOptions.mdx deleted file mode 100644 index 12e878647c2..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/OutputsOptions.mdx +++ /dev/null @@ -1,19 +0,0 @@ -### OutputsOptions(): [OutputsOptions](#outputsoptions) - -Creates a new instance of output options with default values - -### includeSpent(include_spent): void - -Whether the query should include spent outputs or not. - -| Parameter | Type | Description | -| ------------- | ------- | ----------- | -| include_spent | boolean | | - -### outputType(output_type): void - -The output type filter. - -| Parameter | Type | Description | -| ----------- | ------------------------- | ----------- | -| output_type | [OutputKind](#outputkind) | | diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/PeerDto.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/PeerDto.mdx deleted file mode 100644 index a91eb724c95..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/PeerDto.mdx +++ /dev/null @@ -1,25 +0,0 @@ -Describes a peer. - -### id(): String - -The id of the peer - -### multiAddresses(): String[] - -multi addresses - -### alias(): Optional<String> - -The alias of the peer - -### relation(): [Relation](#relation) - -The type of peer - -### connected(): boolean - -`true` if this peer is connected - -### gossip(): Optional<[GossipDto](#gossipdto)> - -The gossip information of this peer diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/PreparedTransactionData.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/PreparedTransactionData.mdx deleted file mode 100644 index 4022772c2c1..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/PreparedTransactionData.mdx +++ /dev/null @@ -1,21 +0,0 @@ -Helper struct for offline signing - -### deserialize(serialised_data): [PreparedTransactionData](#preparedtransactiondata) - -Turns a serialized preparedTransactionData string back into its class - -| Parameter | Type | Description | -| --------------- | ------ | ------------------------------- | -| serialised_data | String | The serialised transaction data | - -### essence(): [Essence](#essence) - -Transaction essence - -### addressIndexRecorders(): [AddressIndexRecorder[]](#addressindexrecorder) - -Required address information for signing - -### serialize(): String - -Serializes the prepared data into a json string diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/PublicKey.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/PublicKey.mdx deleted file mode 100644 index e51fc8b1f47..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/PublicKey.mdx +++ /dev/null @@ -1,20 +0,0 @@ -### verify(sig, bytes): boolean - -Verify the signature and bytes against this public key - -| Parameter | Type | Description | -| --------- | ----------------------- | ----------------------- | -| sig | [Signature](#signature) | The signature to verify | -| bytes | byte[] | The bytes to verify | - -### toBytes(): byte[] - -Turns ths public key into bytes - -### tryFromBytes(bytes): [PublicKey](#publickey) - -Attempt to create a public key from the provided bytes - -| Parameter | Type | Description | -| --------- | ------ | -------------------------------- | -| bytes | byte[] | The bytes to create the key from | diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/ReceiptDto.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/ReceiptDto.mdx deleted file mode 100644 index 5073e299f0b..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/ReceiptDto.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### receipt(): [ReceiptPayloadDto](#receiptpayloaddto) - -Get the receipt payload - -### milestoneIndex(): long - -Get the milestone index this receipt is related to diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/ReceiptPayload.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/ReceiptPayload.mdx deleted file mode 100644 index 5bceadb7fc4..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/ReceiptPayload.mdx +++ /dev/null @@ -1,30 +0,0 @@ -### from(migrated_at, last, funds, transaction): [ReceiptPayload](#receiptpayload) - -Creates a new `ReceiptPayload`. - -| Parameter | Type | Description | -| ----------- | ------------------------------------------- | ----------- | -| migrated_at | long | | -| last | boolean | | -| funds | [MigratedFundsEntry[]](#migratedfundsentry) | | -| transaction | [MessagePayload](#messagepayload) | | - -### migratedAt(): long - -Returns the milestone index at which the funds of a `ReceiptPayload` were migrated at in the legacy network. - -### last(): boolean - -Returns whether a `ReceiptPayload` is the final one for a given migrated at index. - -### funds(): [MigratedFundsEntry[]](#migratedfundsentry) - -The funds which were migrated with a `ReceiptPayload`. - -### transaction(): [TreasuryPayload](#treasurypayload) - -The `TreasuryTransaction` used to fund the funds of a `ReceiptPayload`. - -### amount(): long - -Returns the sum of all `MigratedFundsEntry` items within a `ReceiptPayload`. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/ReceiptPayloadDto.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/ReceiptPayloadDto.mdx deleted file mode 100644 index ec7bfb20b2f..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/ReceiptPayloadDto.mdx +++ /dev/null @@ -1,15 +0,0 @@ -### kind(): long - -The type of receipt - -### migratedAt(): long - -The milestone index at which the funds of a `ReceiptPayload` were migrated - -### funds(): [MigratedFundsEntryDto[]](#migratedfundsentrydto) - -The funds which are migrated - -### last(): boolean - -Whether a `ReceiptPayload` is the final one for a given migrated at index. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/ReferenceUnlock.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/ReferenceUnlock.mdx deleted file mode 100644 index f22fba82f3b..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/ReferenceUnlock.mdx +++ /dev/null @@ -1,11 +0,0 @@ -### from(index): [ReferenceUnlock](#referenceunlock) - -Creates a new `ReferenceUnlock`. - -| Parameter | Type | Description | -| --------- | ---- | ------------------------------------------- | -| index | int | The unlock block index we use for signature | - -### index(): int - -Return the index of a `ReferenceUnlock`. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/RegularEssence.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/RegularEssence.mdx deleted file mode 100644 index 2f10198a77e..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/RegularEssence.mdx +++ /dev/null @@ -1,9 +0,0 @@ -### inputs(): [Input[]](#input) - -Gets the transaction inputs. - -### outputs(): [Output[]](#output) - -Gets the transaction outputs. - -### payload(): Optional<[MessagePayload](#messagepayload)> diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/Relation.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/Relation.mdx deleted file mode 100644 index d5a1623eec7..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/Relation.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### KNOWN - -### UNKNOWN - -### AUTOPEERED diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/RustHex.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/RustHex.mdx deleted file mode 100644 index c2c0fa39473..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/RustHex.mdx +++ /dev/null @@ -1,23 +0,0 @@ -### encode(a0): String - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| a0 | String | | - -### encode(a0): String - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| a0 | byte[] | | - -### decode(s): byte[] - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| s | String | | - -### decode(s): byte[] - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| s | byte[] | | diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/RustLogging.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/RustLogging.mdx deleted file mode 100644 index 58b4b1a31ae..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/RustLogging.mdx +++ /dev/null @@ -1 +0,0 @@ -### init(): void diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/SecretKey.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/SecretKey.mdx deleted file mode 100644 index 7227cbf0017..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/SecretKey.mdx +++ /dev/null @@ -1,27 +0,0 @@ -### generate(): [SecretKey](#secretkey) - -Generate a new secret key - -### fromBytes(bytes): [SecretKey](#secretkey) - -Create a new secret key from the bytes - -| Parameter | Type | Description | -| --------- | ------ | -------------------------------- | -| bytes | byte[] | The bytes to create the key from | - -### publicKey(): [PublicKey](#publickey) - -Derive a public key from the secret key - -### toBytes(): byte[] - -Turn this Secret key into bytes - -### sign(bytes): [Signature](#signature) - -Sign the bytes using this key - -| Parameter | Type | Description | -| --------- | ------ | ----------------- | -| bytes | byte[] | the Bytes to sign | diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/Signature.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/Signature.mdx deleted file mode 100644 index 8e01a06ae82..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/Signature.mdx +++ /dev/null @@ -1,11 +0,0 @@ -### toBytes(): byte[] - -Turn the signature into bytes - -### fromBytes(bs): [Signature](#signature) - -Turns bytes into a signature - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| bs | byte[] | | diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/SignatureLockedDustAllowanceOutput.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/SignatureLockedDustAllowanceOutput.mdx deleted file mode 100644 index e6b858f8886..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/SignatureLockedDustAllowanceOutput.mdx +++ /dev/null @@ -1,19 +0,0 @@ -Output type for deposits that enables an address to receive dust outputs. It can be consumed as an input like a -regular SigLockedSingleOutput. - -### from(address, amount): [SignatureLockedDustAllowanceOutput](#signaturelockeddustallowanceoutput) - -Creates a new `SignatureLockedDustAllowanceOutput`. - -| Parameter | Type | Description | -| --------- | ------------------- | ------------------ | -| address | [Address](#address) | The address to set | -| amount | long | The amount to set | - -### amount(): long - -Returns the amount of a `SignatureLockedDustAllowanceOutput`. - -### address(): [Address](#address) - -Returns the address of a `SignatureLockedDustAllowanceOutput`. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/SignatureLockedDustAllowanceOutputDto.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/SignatureLockedDustAllowanceOutputDto.mdx deleted file mode 100644 index 7fd607db6b3..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/SignatureLockedDustAllowanceOutputDto.mdx +++ /dev/null @@ -1,10 +0,0 @@ -Output type for deposits that enables an address to receive dust outputs. It can be consumed as an input like a -regular SigLockedSingleOutput. - -### amount(): long - -Returns the amount of a `SignatureLockedDustAllowanceOutputDto`. - -### address(): [AddressDto](#addressdto) - -Returns the address of a `SignatureLockedDustAllowanceOutputDto`. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/SignatureLockedSingleOutput.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/SignatureLockedSingleOutput.mdx deleted file mode 100644 index 9d7e9729f5d..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/SignatureLockedSingleOutput.mdx +++ /dev/null @@ -1,18 +0,0 @@ -Describes a deposit to a single address which is unlocked via a signature. - -### from(address, amount): [SignatureLockedSingleOutput](#signaturelockedsingleoutput) - -Creates a new `SignatureLockedSingleOutput`. - -| Parameter | Type | Description | -| --------- | ------------------- | ------------------ | -| address | [Address](#address) | The address to set | -| amount | long | The amount to set | - -### amount(): long - -Returns the amount of a `SignatureLockedSingleOutput`. - -### address(): [Address](#address) - -Returns the address of a `SignatureLockedSingleOutput`. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/SignatureLockedSingleOutputDto.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/SignatureLockedSingleOutputDto.mdx deleted file mode 100644 index 27f02a17053..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/SignatureLockedSingleOutputDto.mdx +++ /dev/null @@ -1,9 +0,0 @@ -Describes a deposit to a single address which is unlocked via a signature. - -### amount(): long - -Returns the amount of a `SignatureLockedSingleOutputDto`. - -### address(): [AddressDto](#addressdto) - -Returns the address of a `SignatureLockedSingleOutputDto`. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/SignatureUnlock.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/SignatureUnlock.mdx deleted file mode 100644 index ae77deecf56..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/SignatureUnlock.mdx +++ /dev/null @@ -1,8 +0,0 @@ -### SignatureUnlock(public_key, signature): [SignatureUnlock](#signatureunlock) - -Create a new Signature inlock block - -| Parameter | Type | Description | -| ---------- | ------ | -------------------------------------------- | -| public_key | byte[] | The public ket used for this signature block | -| signature | byte[] | The signature created for this unlock block | diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/Topic.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/Topic.mdx deleted file mode 100644 index a0d63132ff3..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/Topic.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### from(topic): [Topic](#topic) - -Creates a new topic and checks if it's valid. - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| topic | String | | diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/TopicEvent.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/TopicEvent.mdx deleted file mode 100644 index 7af4ea15939..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/TopicEvent.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### topic(): String - -the MQTT topic. - -### payload(): String - -The MQTT event payload. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/TransactionId.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/TransactionId.mdx deleted file mode 100644 index ad44b7cfb13..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/TransactionId.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### fromString(str_rep): [TransactionId](#transactionid) - -Create a TransactionId from string - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| str_rep | String | | diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/TransactionPayload.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/TransactionPayload.mdx deleted file mode 100644 index d795aed6fa1..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/TransactionPayload.mdx +++ /dev/null @@ -1,15 +0,0 @@ -### builder(): [TransactionPayloadBuilder](#transactionpayloadbuilder) - -Return a new `TransactionPayloadBuilder` to build a `TransactionPayload`. - -### essence(): [Essence](#essence) - -Return the essence of a `TransactionPayload`. - -### id(): [TransactionId](#transactionid) - -Computes the identifier of a `TransactionPayload`. - -### unlockBlocks(): [UnlockBlock[]](#unlockblock) - -Return unlock blocks of a `TransactionPayload`. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/TransactionPayloadBuilder.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/TransactionPayloadBuilder.mdx deleted file mode 100644 index 4d16986eed9..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/TransactionPayloadBuilder.mdx +++ /dev/null @@ -1,23 +0,0 @@ -### TransactionPayloadBuilder(): [TransactionPayloadBuilder](#transactionpayloadbuilder) - -Creates a new `TransactionPayloadBuilder`. - -### withEssence(essence): [TransactionPayloadBuilder](#transactionpayloadbuilder) - -Adds an essence to a `TransactionPayloadBuilder`. - -| Parameter | Type | Description | -| --------- | ------------------- | ----------- | -| essence | [Essence](#essence) | | - -### withUnlockBlocks(unlock_blocks): [TransactionPayloadBuilder](#transactionpayloadbuilder) - -Adds unlock blocks to a `TransactionPayloadBuilder`. - -| Parameter | Type | Description | -| ------------- | ----------------------------- | ----------- | -| unlock_blocks | [UnlockBlocks](#unlockblocks) | | - -### finish(): [TransactionPayload](#transactionpayload) - -Finishes a `TransactionPayloadBuilder` into a `TransactionPayload`. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/TreasuryInput.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/TreasuryInput.mdx deleted file mode 100644 index 4f998c30d30..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/TreasuryInput.mdx +++ /dev/null @@ -1,13 +0,0 @@ -`TreasuryInput` is an input which references a milestone which generated a `TreasuryOutput`. - -### TreasuryInput(id): [TreasuryInput](#treasuryinput) - -Create a new TreasuryInput - -| Parameter | Type | Description | -| --------- | --------------------------- | -------------------------------------------------- | -| id | [MilestoneId](#milestoneid) | The MilestoneId which Generated a `TreasuryOutput` | - -### milestoneId(): [MilestoneId](#milestoneid) - -Returns the milestones id of a `TreasuryInput`. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/TreasuryOutput.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/TreasuryOutput.mdx deleted file mode 100644 index 3ead4ae9270..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/TreasuryOutput.mdx +++ /dev/null @@ -1,13 +0,0 @@ -Trasury output. - -### from(amount): [TreasuryOutput](#treasuryoutput) - -Creates a new TreasuryOutput with the amount supplied - -| Parameter | Type | Description | -| --------- | ---- | ----------------- | -| amount | long | The amount to set | - -### amount(): long - -Returns the amount of a `TreasuryOutput`. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/TreasuryOutputDto.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/TreasuryOutputDto.mdx deleted file mode 100644 index 13fa689374f..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/TreasuryOutputDto.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### kind(): short - -The type of Treasury DTO - -### amount(): long - -The amount in the treasury diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/TreasuryPayload.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/TreasuryPayload.mdx deleted file mode 100644 index a769b041cf2..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/TreasuryPayload.mdx +++ /dev/null @@ -1,10 +0,0 @@ -### TreasuryPayload(input, output): [TreasuryPayload](#treasurypayload) - -| Parameter | Type | Description | -| --------- | --------------------------------- | ----------- | -| input | [TreasuryInput](#treasuryinput) | | -| output | [TreasuryOutput](#treasuryoutput) | | - -### output(): [TreasuryOutput](#treasuryoutput) - -### input(): [TreasuryInput](#treasuryinput) diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/TreasuryResponse.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/TreasuryResponse.mdx deleted file mode 100644 index 95c4ba2aa70..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/TreasuryResponse.mdx +++ /dev/null @@ -1,10 +0,0 @@ -Response of GET /api/v1/treasury. -Returns all information about the treasury. - -### amount(): long - -The amount in the treasury - -### milestoneId(): String - -The milestone ID this reponse relates to diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/UnlockBlock.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/UnlockBlock.mdx deleted file mode 100644 index 44f44637118..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/UnlockBlock.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### kind(): [UnlockBlockKind](#unlockblockkind) - -### asReference(): [ReferenceUnlock](#referenceunlock) - -### asSignature(): [SignatureUnlock](#signatureunlock) diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/UnlockBlockKind.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/UnlockBlockKind.mdx deleted file mode 100644 index fba94f0f65c..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/UnlockBlockKind.mdx +++ /dev/null @@ -1,3 +0,0 @@ -### ED25519 - -### REFERENCE diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/UnlockBlocks.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/UnlockBlocks.mdx deleted file mode 100644 index bd9ce0d9b5b..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/UnlockBlocks.mdx +++ /dev/null @@ -1,14 +0,0 @@ -### from(unlock_blocks): [UnlockBlocks](#unlockblocks) - -| Parameter | Type | Description | -| ------------- | ----------------------------- | ----------- | -| unlock_blocks | [UnlockBlock[]](#unlockblock) | | - -### get(index): Optional<[UnlockBlock](#unlockblock)> - -Gets a clone of an `UnlockBlock` from `UnlockBlocks`. -Returns the referenced unlock block if the requested unlock block was a reference. - -| Parameter | Type | Description | -| --------- | ---- | ----------- | -| index | long | | diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/Util.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/Util.mdx deleted file mode 100644 index 56c7f34a194..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/Util.mdx +++ /dev/null @@ -1,25 +0,0 @@ -### consolidateFunds(client, seed, account_index, address_range_low, address_range_high): String - -Function to consolidate all funds from a range of addresses to the address with the lowest index in that range -Returns the address to which the funds got consolidated, if any were available - -| Parameter | Type | Description | -| ------------------ | ----------------- | ----------- | -| client | [Client](#client) | | -| seed | String | | -| account_index | long | | -| address_range_low | long | | -| address_range_high | long | | - -### searchAddress(seed, bech32_hrp, account_index, range_low, range_high, address): [IndexPublicDto](#indexpublicdto) - -Function to find the index and public or internal type of an Bech32 encoded address - -| Parameter | Type | Description | -| ------------- | ------------------- | ----------- | -| seed | String | | -| bech32_hrp | String | | -| account_index | long | | -| range_low | long | | -| range_high | long | | -| address | [Address](#address) | | diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api/UtxoInput.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/api/UtxoInput.mdx deleted file mode 100644 index 58bafa9e529..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api/UtxoInput.mdx +++ /dev/null @@ -1,18 +0,0 @@ -Represents an input referencing an output. - -### from(id, index): [UtxoInput](#utxoinput) - -Create a new `UtxoInput` - -| Parameter | Type | Description | -| --------- | ------------------------------- | ---------------- | -| id | [TransactionId](#transactionid) | The ouput Id | -| index | int | The output Index | - -### transactionId(): [TransactionId](#transactionid) - -Returns the `TransactionId` of the Output. - -### index(): int - -Returns the index of the Output. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/api_reference.md b/docs/build/iota.rs/1.4/docs/libraries/java/api_reference.md deleted file mode 100644 index e97cba85ec7..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/api_reference.md +++ /dev/null @@ -1,458 +0,0 @@ ---- -title: API Reference -description: Official IOTA Client Library Java API reference. -image: /img/logo/libraries.png -keywords: - - api - - Java - - param - - type - - endpoint - - builder ---- - -import Address from './api/Address.mdx' -import AddressDto from './api/AddressDto.mdx' -import AddressIndexRecorder from './api/AddressIndexRecorder.mdx' -import AddressPublicWrapper from './api/AddressPublicWrapper.mdx' -import AddressStringPublicWrapper from './api/AddressStringPublicWrapper.mdx' -import Api from './api/Api.mdx' -import BalanceAddressResponse from './api/BalanceAddressResponse.mdx' -import BrokerOptions from './api/BrokerOptions.mdx' -import Chain from './api/Chain.mdx' -import Client from './api/Client.mdx' -import ClientBuilder from './api/ClientBuilder.mdx' -import ClientException from './api/ClientException.mdx' -import ClientMessageBuilder from './api/ClientMessageBuilder.mdx' -import ClientMiner from './api/ClientMiner.mdx' -import Essence from './api/Essence.mdx' -import GetAddressBuilder from './api/GetAddressBuilder.mdx' -import GetAddressesBuilder from './api/GetAddressesBuilder.mdx' -import GetBalanceBuilderApi from './api/GetBalanceBuilderApi.mdx' -import GetMessageBuilder from './api/GetMessageBuilder.mdx' -import GossipDto from './api/GossipDto.mdx' -import HeartbeatDto from './api/HeartbeatDto.mdx' -import IndexPublicDto from './api/IndexPublicDto.mdx' -import IndexationPayload from './api/IndexationPayload.mdx' -import InfoResponse from './api/InfoResponse.mdx' -import Input from './api/Input.mdx' -import InputKind from './api/InputKind.mdx' -import LedgerInclusionStateDto from './api/LedgerInclusionStateDto.mdx' -import Message from './api/Message.mdx' -import MessageBuilder from './api/MessageBuilder.mdx' -import MessageId from './api/MessageId.mdx' -import MessageMetadata from './api/MessageMetadata.mdx' -import MessagePayload from './api/MessagePayload.mdx' -import MessagePayloadType from './api/MessagePayloadType.mdx' -import MessageWrap from './api/MessageWrap.mdx' -import MetricsDto from './api/MetricsDto.mdx' -import MigratedFundsEntry from './api/MigratedFundsEntry.mdx' -import MigratedFundsEntryDto from './api/MigratedFundsEntryDto.mdx' -import MilestoneId from './api/MilestoneId.mdx' -import MilestonePayload from './api/MilestonePayload.mdx' -import MilestonePayloadEssence from './api/MilestonePayloadEssence.mdx' -import MilestoneResponse from './api/MilestoneResponse.mdx' -import MilestoneSignature from './api/MilestoneSignature.mdx' -import MilestoneUtxoChangesResponse from './api/MilestoneUtxoChangesResponse.mdx' -import MqttEvent from './api/MqttEvent.mdx' -import MqttListener from './api/MqttListener.mdx' -import MqttManager from './api/MqttManager.mdx' -import MqttTopicManager from './api/MqttTopicManager.mdx' -import NativeAPI from './api/NativeAPI.mdx' -import NetworkInfo from './api/NetworkInfo.mdx' -import Node from './api/Node.mdx' -import NodeInfoWrapper from './api/NodeInfoWrapper.mdx' -import Output from './api/Output.mdx' -import OutputDto from './api/OutputDto.mdx' -import OutputKind from './api/OutputKind.mdx' -import OutputResponse from './api/OutputResponse.mdx' -import OutputsOptions from './api/OutputsOptions.mdx' -import PeerDto from './api/PeerDto.mdx' -import PreparedTransactionData from './api/PreparedTransactionData.mdx' -import PublicKey from './api/PublicKey.mdx' -import ReceiptDto from './api/ReceiptDto.mdx' -import ReceiptPayload from './api/ReceiptPayload.mdx' -import ReceiptPayloadDto from './api/ReceiptPayloadDto.mdx' -import ReferenceUnlock from './api/ReferenceUnlock.mdx' -import RegularEssence from './api/RegularEssence.mdx' -import Relation from './api/Relation.mdx' -import RustHex from './api/RustHex.mdx' -import RustLogging from './api/RustLogging.mdx' -import SecretKey from './api/SecretKey.mdx' -import Signature from './api/Signature.mdx' -import SignatureLockedDustAllowanceOutput from './api/SignatureLockedDustAllowanceOutput.mdx' -import SignatureLockedDustAllowanceOutputDto from './api/SignatureLockedDustAllowanceOutputDto.mdx' -import SignatureLockedSingleOutput from './api/SignatureLockedSingleOutput.mdx' -import SignatureLockedSingleOutputDto from './api/SignatureLockedSingleOutputDto.mdx' -import SignatureUnlock from './api/SignatureUnlock.mdx' -import Topic from './api/Topic.mdx' -import TopicEvent from './api/TopicEvent.mdx' -import TransactionId from './api/TransactionId.mdx' -import TransactionPayload from './api/TransactionPayload.mdx' -import TransactionPayloadBuilder from './api/TransactionPayloadBuilder.mdx' -import TreasuryInput from './api/TreasuryInput.mdx' -import TreasuryOutput from './api/TreasuryOutput.mdx' -import TreasuryOutputDto from './api/TreasuryOutputDto.mdx' -import TreasuryPayload from './api/TreasuryPayload.mdx' -import TreasuryResponse from './api/TreasuryResponse.mdx' -import UnlockBlock from './api/UnlockBlock.mdx' -import UnlockBlockKind from './api/UnlockBlockKind.mdx' -import UnlockBlocks from './api/UnlockBlocks.mdx' -import Util from './api/Util.mdx' -import UtxoInput from './api/UtxoInput.mdx' - -## Address - -

- -## AddressDto - - - -## AddressIndexRecorder - - - -## AddressPublicWrapper - - - -## AddressStringPublicWrapper - - - -## Api - - - -## BalanceAddressResponse - - - -## BrokerOptions - - - -## Chain - - - -## Client - - - -## ClientBuilder - - - -## ClientException - - - -## ClientMessageBuilder - - - -## ClientMiner - - - -## Essence - - - -## GetAddressBuilder - - - -## GetAddressesBuilder - - - -## GetBalanceBuilderApi - - - -## GetMessageBuilder - - - -## GossipDto - - - -## HeartbeatDto - - - -## IndexPublicDto - - - -## IndexationPayload - - - -## InfoResponse - - - -## Input - - - -## InputKind - - - -## LedgerInclusionStateDto - - - -## Message - - - -## MessageBuilder - - - -## MessageId - - - -## MessageMetadata - - - -## MessagePayload - - - -## MessagePayloadType - - - -## MessageWrap - - - -## MetricsDto - - - -## MigratedFundsEntry - - - -## MigratedFundsEntryDto - - - -## MilestoneId - - - -## MilestonePayload - - - -## MilestonePayloadEssence - - - -## MilestoneResponse - - - -## MilestoneSignature - - - -## MilestoneUtxoChangesResponse - - - -## MqttEvent - - - -## MqttListener - - - -## MqttManager - - - -## MqttTopicManager - - - -## NativeAPI - - - -## NetworkInfo - - - -## Node - - - -## NodeInfoWrapper - - - -## Output - - - -## OutputDto - - - -## OutputKind - - - -## OutputResponse - - - -## OutputsOptions - - - -## PeerDto - - - -## PreparedTransactionData - - - -## PublicKey - - - -## ReceiptDto - - - -## ReceiptPayload - - - -## ReceiptPayloadDto - - - -## ReferenceUnlock - - - -## RegularEssence - - - -## Relation - - - -## RustHex - - - -## RustLogging - - - -## SecretKey - - - -## Signature - - - -## SignatureLockedDustAllowanceOutput - - - -## SignatureLockedDustAllowanceOutputDto - - - -## SignatureLockedSingleOutput - - - -## SignatureLockedSingleOutputDto - - - -## SignatureUnlock - - - -## Topic - - - -## TopicEvent - - - -## TransactionId - - - -## TransactionPayload - - - -## TransactionPayloadBuilder - - - -## TreasuryInput - - - -## TreasuryOutput - - - -## TreasuryOutputDto - - - -## TreasuryPayload - - - -## TreasuryResponse - - - -## UnlockBlock - - - -## UnlockBlockKind - - - -## UnlockBlocks - - - -## Util - - - -## UtxoInput - - diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/examples/_01_get_info.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/examples/_01_get_info.mdx deleted file mode 100644 index d205f1baf26..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/examples/_01_get_info.mdx +++ /dev/null @@ -1,34 +0,0 @@ -import LoadBalancerHealthChecks from '../../../_admonitions/_load_balancer_health_checks.md'; -import GetInfoOutput from '../../../_partials/examples/01_get_info/outputs/snake_case.md'; -import ClientBuilder from '../../../_partials/examples/01_get_info/_client_builder.md'; - -```java reference -https://github.com/iotaledger/iota.rs/blob/production/bindings/java/examples/java-app/src/main/java/org/iota/client/example/ExampleApp.java#L49-L61 -``` - -**Output example** of the [`getInfo()`](./../api_reference.md#getinfo-nodeinfowrapper) function of the -[`Client`](./../api_reference.md#client) instance: - - - - - - - -The most common ones are: - -- `.withNetwork(string)`: Can be either `devnet` or `mainnet`. It instructs - the library whether to automatically select devnet nodes or mainnet nodes. -- `.withNode(string)`: Specify address of actual running IOTA node that should be used - to communicate with in the format `https://node:port`). For example: `https://api.lb-0.h.chrysalis-devnet.iota.cafe:443`. -- `.withNodePoolUrls(String[])`: The library also supports managing a pool of - nodes. You can provide a list of nodes and the library manages the access to them automatically by selecting them based - on their sync status. If you provide `.withNodePoolUrls(String[])`, then the library periodically will periodically - check - whether node is in sync or - not by calling `.withNodeSyncInterval(float)`. -- `.withLocalPow(boolean)`: If `.localPow (True)` a Proof-of-work will be done - locally and not remotely. -- `.withNodeSyncDisabled()`: When called, the library will use nodes that - are **not** in sync with network. This parameter is usually useful if you would like to interact with a local test node - that is not fully synced. **This parameter should not be used in production**. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/examples/_02_generate_seed.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/examples/_02_generate_seed.mdx deleted file mode 100644 index 7cd0d930a23..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/examples/_02_generate_seed.mdx +++ /dev/null @@ -1,6 +0,0 @@ -You can generate a seed, for example, using the SHA256 algorithm on some random input generated by a cryptographically -secure pseudo-random generator, such as `SecretKey.generate()`: - -```java reference -https://github.com/iotaledger/iota.rs/blob/production/bindings/java/examples/java-app/src/main/java/org/iota/client/example/ExampleApp.java#L63-L70 -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/examples/_03_generate_addresses.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/examples/_03_generate_addresses.mdx deleted file mode 100644 index eb3569e229a..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/examples/_03_generate_addresses.mdx +++ /dev/null @@ -1,37 +0,0 @@ -You can generate an IOTA address using the -[`GetAddressesBuilder`](./../api_reference.md#getaddressesbuilder) helper class and calling the `GetAddressesBuilder::from(seed: &str)` function -and respective chaining calls that will return a list of tuples with the generated addresses. You can find more information -on the parameters in the [Address/Key Space section](../../../explanations/address_key_space.md). - -The whole process is deterministic. This means the output is the same as long as the seed is the same: - -```java reference -https://github.com/iotaledger/iota.rs/blob/production/bindings/java/examples/java-app/src/main/java/org/iota/client/example/ExampleApp.java#L72-L82 -``` - -**Output example**: - -```string -[ - 'atoi1qz6dr6dtl0856tf0pczz7gesrf7j8a4vr00q58ld2zx7ttlv3p96snpym9z', - 'atoi1qpp7sz28a0ghvd6knwnljr7j2s04qquduuc5vlz94fwf94zznj2yv5ew2c4', - 'atoi1qzje6zhg5vu456eg3z84ekcfn3laxqyczche5eeqhcdh3w9yr5sqvr4z4td', - 'atoi1qqwhxjmcvmatpedeedapgx0vwyupfwx9k5n4w0lnc5l6vmz78aavwhs55v0', - 'atoi1qzg63t9880jtfysvpq7rrynz0rqt3kd2fw8r4934ezraz9dpwvzxkw2dtmh' -] -``` - -IOTA addresses are represented by a checksumed base-32 string (Bech32). You can find a detailed explanation in the -[Chrysalis documentations](/introduction/reference/details#iota-15-address-anatomym), but here are -parts relevant to this example: - -- If an address starts with `atoi` then it means it is related to `devnet`. `iota` stands for `mainnet`. -- Number `1` at the 5th position is just a separator. -- The last 6 characters are reserved for a checksum. - -Addresses can be also represented in a hex format using the -[`Client.bech32ToHex(bech32)`](./../api_reference.md#bech32tohexbech32-string) function. - -If you want to quickly validate any IOTA address, you can use the -[`Client.isAddressValid()`](./../api_reference.md#isaddressvalidaddress-boolean) function that returns a `bool` value. You should -perform a sanity check on address before using it. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/examples/_04_get_balance.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/examples/_04_get_balance.mdx deleted file mode 100644 index fd743a002dd..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/examples/_04_get_balance.mdx +++ /dev/null @@ -1,45 +0,0 @@ -## [`Client.getBalance(seed: String)`](./../api_reference.md#getbalanceseed-getbalancebuilderapi) - -Combines [`Client.getAddresses()`](./../api_reference.md#getaddressesseed-getaddressesbuilder) and -`Client.getAddressBalance()` api calls. It returns a combined balance for the provided `seed`. - -## [`Client.getAddressBalance(address: String)`](./../api_reference.md#getaddressbalanceaddress-balanceaddressresponse) - -Expects a single address in Bech32 format and returns `dict` with a balance for the address. - -## [`Client.getAddressBalances(addresses: String[])`](./../api_reference.md#getaddressesbalancesaddresses-balanceaddressresponse) - -A convenient function that expects `list` of addresses in Bech32 format and returns list of `dict` with balances for all -given addresses. - -## [`Client.getAddress().balance(address: String)`](./../api_reference.md#balanceaddress-balanceaddressresponse) - -You can use the [`GetAdressBuilder`](./../api_reference.md#getaddressesbuilder) on a `Client` instance and -query for and addresses' balances by chaining a call to the `balance(address: String)` function. - -## [`Client.getAddress().outputs(address: String, options: OutputOptions)`](./../api_reference.md#outputsaddress-options-balanceaddressresponse) - -You can use the [`GetAdressBuilder`](./../api_reference.md#getaddressesbuilde) on a `Client` instance and -query for and addresses' balances by chaining a call to the `outputs(address: String)` function. - -```java reference -https://github.com/iotaledger/iota.rs/blob/production/bindings/java/examples/java-app/src/main/java/org/iota/client/example/ExampleApp.java#L84-L103 -``` - -Example output: - -```json -Account balance: 1096055332i - -The balance of "atoi1qzt0nhsf38nh6rs4p6zs5knqp6psgha9wsv74uajqgjmwc75ugupx3y7x0r" is 451055332i - -The outputs of address "atoi1qzt0nhsf38nh6rs4p6zs5knqp6psgha9wsv74uajqgjmwc75ugupx3y7x0r" are: [ - UtxoInput(741673db85f78ebd95d04b572d1bf32e9207bbd265d90dbbe499a6d32f2b25470000), - UtxoInput(ed33089c623c67eb06dbc1c10b0c1c0424b0ace04a2e44070702668b3de440c80000), - UtxoInput(0af84c860dc461730064e7c4c88152ed8bea1ae72b1d6f5e4ab0c3e51ed185b70100), - ...] -``` - -- `dustAllowed` indicates whether the given address is allowed to accept a dust. You can learn more about dust - protection in the - [Chrysalis documentation](/introduction/explanations/faq#what-is-dust-protection-and-how-does-it-work). diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/examples/_05_get_outputs.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/examples/_05_get_outputs.mdx deleted file mode 100644 index 61f82b91c55..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/examples/_05_get_outputs.mdx +++ /dev/null @@ -1,33 +0,0 @@ -- [`Client.get_address().outputs(address: String, options: OutputOptions)`](#clientget_addressoutputsaddress-string-options-outputoptions) -- [`Client.getOutput(str)`](#clientgetoutputoutput_id-string) -- [`Client.findOutputs(output_ids, addresses)`](#clientfindoutputsoutput_idsstring-addressesstring): - -## Client.get_address().outputs(address: String, options: OutputOptions) - -This [`Client.get_address().outputs(address: String, options: OutputOptions)`](./../api_reference.md#outputsaddress-options-balanceaddressresponse) -expects an address in Bech32 format and will get all outputs that use a given address. You can use [OutputOptions](./../api_reference.md#outputsoptions) to limit the returned results. - -```java reference -https://github.com/iotaledger/iota.rs/blob/production/bindings/java/examples/java-app/src/main/java/org/iota/client/example/ExampleApp.java#L105-L116 -``` - -**Output example**: - -```json -[ - "0f2d5d2651f8061a9f5417d0658009f32b2e3f77f9706b0be3b4b3f466171f360000", - "7614ba900a90b130707766a660a454942ac7cc4adea3fb9ad0cdca90114417c20000", - "768c20c15a290e02a43b83263a98501b9d7eb0b57da40a9247289c672de63ea60000" -] -``` - -## Client.getOutput(output_id: String) - -The [`Client.getOutput(output_id: String)`](./../api_reference.md#getoutputoutput_id-outputresponse) function to get metadata about the an `output_id`: - -## Client.findOutputs(output_ids:String[], addresses:String[]) - -The -[`Client.findOutputs(output_ids:String[], addresses:String[])`](./../api_reference.md#findoutputsoutput_ids-addresses-outputresponse) -function expects an array of Strings representing the output ids to look up, as well as an array of Strings representing -the addresses to look up. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/examples/_06_simple_message.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/examples/_06_simple_message.mdx deleted file mode 100644 index cffeb006d14..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/examples/_06_simple_message.mdx +++ /dev/null @@ -1,29 +0,0 @@ -You can use the [`Client.message()`](./../api_reference.md#message-clientmessagebuilder) to easily send any -message over the network. Alternatively, there is a convenient -[MessageSender](./../api_reference.md#messagebuilder) helper class with chaining calls that prepares a message -instance and broadcasts it over the network. - -```java reference -https://github.com/iotaledger/iota.rs/blob/production/bindings/java/examples/java-app/src/main/java/org/iota/client/example/ExampleApp.java#L118-L128 -``` - -**Output example**: - -```string -{ - message: { - networkId: '14379272398717627559', - parentMessageIds: [ - '03ddc83fad172a322fb00fb4e449436e9d1117ff390879100647c650a30c2d52', - '252798210fa9816f6fd40f1b19095da9f2dc88ae06fc4c0523a928a29d0d782e', - 'a8e4f4cd49227068424ead8da187a48fdaa7ce8ffc4b9ac0ee2d5d3f2fcd7e70', - 'dbbc8044bc624b3378e1dda83ab95f9be468b06a6a9806c76a70353182028cf9' - ], - payload: null, - nonce: '9223372036854784215' - }, - messageId: '10dbee9cf3c58507725861b34ac711058dc13f709be1a6d21f1dc0af17b06379' -} -``` - -- `messageId` is a unique id that refers to the given message in the network. diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/examples/_07_get_message_data.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/examples/_07_get_message_data.mdx deleted file mode 100644 index 952078d185f..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/examples/_07_get_message_data.mdx +++ /dev/null @@ -1,52 +0,0 @@ -Once a [message](../../../explanations/messages_payloads_and_transactions.md) is broadcast, you can use the -[`GetMessageBuilder`](./../api_reference.md#getmessagebuilder) helper class that you can instantiate using -the [`Client.getMessage()`](./../api_reference.md#getmessage-getmessagebuilder) function to retrieve it from -the network. The `GetMessageBuilder` provides helper functions related to the message, such as -[`Client.getMessage().data(str)`](./../api_reference.md#datamessage_id-message) and -[`Client.getMessage().metadata(str)`](./../api_reference.md#metadatamessage_id-messagemetadata): - -```java reference -https://github.com/iotaledger/iota.rs/blob/production/bindings/java/examples/java-app/src/main/java/org/iota/client/example/ExampleApp.java#L130-L141 -``` - -**Output example**: - -```json -Message meta data: -{ - "messageId":"e52b631bc7500366b90c6e11eb7fd6abaa7527f9bb5b4b512b0b9112bb9e7be8", - "parentMessageIds": [ - "26d72339ed262c1ec29d6c91de6be26d067b3327191f5e47606df53cc40e334e", - "6289ea0aecf3830e5e8d9925959bb6e804e324bb6db23c5701f7a538d12831f6", - "fdbf2d02603235fdff99f0ceb57705ead95041d62de386387f2922e5d9f6c502", - "ffa26139ca7f9d4849e118ff369fb3a387c8fefd8d15232b8353d4acf334324c" - ], - "isSolid":true, - "shouldPromote":false, - "shouldReattach":false -} - -Message data: -{ - "message": { - "networkId":"14379272398717627559", - "parentMessageIds": [ - "27782707e4cbf84ca26b3db881bbf39b6429f9ee736a0cbe5a1c177d7a52b05d", - "61cdf92c64a3304bbbabaf9fbfb0ea7ef9624e1eedea68efbe08595ccdf853e1", - "a222d13e3ee51b56b0b0e38140a5f7f813b6d9e29b752d7e1e2424099455080d", - "ab6bca20091b58dcbb0906438a7e47bfb11621c4a37b8d118b565f7f138a40d6" - ], - "payload": { - "type":2, - "index":"484f524e4554205370616d6d6572", - "data":"42696e61727920697320746865206675747572652e0a436f756e743a2031333936393530390a54696d657374616d703a20323032312d30352d33315431353a33363a30392b30323a30300a54697073656c656374696f6e3a203337c2b573" - }, - "nonce":"246736" - }, - "messageId":"30d87fa9917602e5685638e37802bde11b260bd2379f6c850704d7babd365b44" -} -``` - -- `Client.getMessage().metadata()` provides information on how the given message fits to network structures, such as - `ledger_inclusion_state`, etc. -- `Client.getMessage().data()` provides all the data that relates to the given message and its payload(s). diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/examples/_08_data_message.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/examples/_08_data_message.mdx deleted file mode 100644 index ad97f50cb87..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/examples/_08_data_message.mdx +++ /dev/null @@ -1,30 +0,0 @@ -You can use the -[ClientMessageBuilder.withDataString(data: String)](./../api_reference.md#withdatastringdata-clientmessagebuilder) function -function to attach data to a message. - -```java reference -https://github.com/iotaledger/iota.rs/blob/production/bindings/java/examples/java-app/src/main/java/org/iota/client/example/ExampleApp.java#L143-L152 -``` - -**Output example**: - -```json -{ - "message": { - "networkId": "14379272398717627559", - "parentMessageIds": [ - "1a383abbe5f6a6b0899d718975c3119643aa784a68d04075f4e986fd7a0c0e4b", - "6098f889e31911833df7b7839e8b222d701ab496f7dfa1a719087edf4fa7ae52", - "a98b47db4e8254eccc738c968bd35b08a5491e56d6c1a18af298c42bbd8c3a46", - "da6796c0842c08de832c7948fffedc0d5adce372e50a108f26a128dba6096d31" - ], - "payload": { - "type": 2, - "index": "494f54412e52532042494e44494e47202d204e4f44452e4a53", - "data": "736f6d65207574662062617365642064617461" - }, - "nonce": "13835058055282176519" - }, - "messageId": "10f59c101cec669b0a0ba163bc777184c7f63455f5e771d42f910a1ba2ad20ff" -} -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/examples/_09_transaction.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/examples/_09_transaction.mdx deleted file mode 100644 index 39373a07c98..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/examples/_09_transaction.mdx +++ /dev/null @@ -1,12 +0,0 @@ -Sending value-based messages is a very straightforward process if you use the -[`ClientMessageBuilder`](./../api_reference.md#clientmessagebuilder) helper class. You will only need to -provide a valid seed by chaining a call to -[`.withSeed(seed: String)`](./../api_reference.md#withseedseed-clientmessagebuilder), and output addresses -and amount by chaining a call to -[`withOutput(address: String, amount: long):`](./../api_reference.md#withoutputaddress-amount-clientmessagebuilder). -The method will find valid output(s) that can be used to fund the given amount(s) and the unspent amount will be sent to -the same address. - -```java reference -https://github.com/iotaledger/iota.rs/blob/production/bindings/java/examples/java-app/src/main/java/org/iota/client/example/ExampleApp.java#L154-L169 -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/examples/_10_mqtt.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/examples/_10_mqtt.mdx deleted file mode 100644 index ef2041e0997..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/examples/_10_mqtt.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/iota.rs/blob/production/bindings/java/examples/java-app/src/main/java/org/iota/client/example/ExampleApp.java#L171-L183 -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/java/examples/_running_examples.mdx b/docs/build/iota.rs/1.4/docs/libraries/java/examples/_running_examples.mdx deleted file mode 100644 index a2c21a403dd..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/java/examples/_running_examples.mdx +++ /dev/null @@ -1,27 +0,0 @@ -## Prequisites - -Before you can run the examples, please refer to the -[Java Getting Started guide](./../../../getting_started/java/getting_started.mdx) to install the library. - -## Running the Java Examples - -### Gradle - -``` -./gradlew examples:java-app:test --info -``` - -### Maven - -``` -mvn exec:exec -``` - -## Running the Android Examples - -The Android app needs further compilation instructions which you can find in the -[Getting Started With Java - Android Development](./../../../getting_started/java/android_development.mdx) section. - -## Example for an External Project - -You can find a project skeleton can in [this repository](https://github.com/kwek20/iota-rs-java). diff --git a/docs/build/iota.rs/1.4/docs/libraries/nodejs/api_reference.md b/docs/build/iota.rs/1.4/docs/libraries/nodejs/api_reference.md deleted file mode 100644 index faccda711bb..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/nodejs/api_reference.md +++ /dev/null @@ -1,1151 +0,0 @@ ---- -description: Official IOTA Client Library Node.js API reference. -image: /img/logo/libraries.png -keywords: - - api - - nodejs - - param - - type - - client builder ---- - -# API Reference - IOTA Client Library - Node.js binding - -Node.js binding to the IOTA client library. - -## Installation - -- Using NPM: - -```bash -npm i @iota/client -``` - -- Using yarn: - -```bash -yarn add @iota/client -``` - -## Requirements - -One of the following Node.js version: '12.x', '14.x', '16.x' - -If there is no prebuilt binary available for your system you need `Rust` and `Cargo`, to build it yourself. Install them [here](https://doc.rust-lang.org/cargo/getting-started/installation.html). - -## Getting Started - -After you linked the library, you can create a `Client` instance and interface with it. - -```javascript -const { ClientBuilder } = require('@iota/client'); -const client = new ClientBuilder() - .node('https://api.lb-0.h.chrysalis-devnet.iota.cafe') - .build(); -client.getInfo().then(console.log).catch(console.error); -``` - -Connecting to a MQTT broker using raw ip doesn't work with TCP. This is a limitation of rustls. - -## API Reference - -### ClientBuilder - -#### node(url): ClientBuilder - -Adds an IOTA node to the client pool. - -| Param | Type | Description | -| ----- | -------- | ----------- | -| url | `string` | A node URL | - -**Returns** the client builder instance for chained calls. - -#### nodeAuth(url, authOptions): ClientBuilder - -Adds an IOTA node with authentication to the client pool. - -| Param | Type | Description | -| ----------- | ------------------------------------- | ------------------------------- | -| url | `string` | A node URL | -| authOptions | `[NodeAuthOptions](#nodeauthoptions)` | Options for node authentication | - -**Returns** the client builder instance for chained calls. - -#### primaryNode(url, [, authOptions]): ClientBuilder - -Add a node to always connect first to with optional authentication. - -| Param | Type | Description | -| ----------- | ------------------------------------- | ------------------------------- | -| url | `string` | A node URL | -| authOptions | `[NodeAuthOptions](#nodeauthoptions)` | Options for node authentication | - -**Returns** the client builder instance for chained calls. - -#### primaryPowNode(url, [, authOptions]): ClientBuilder - -Add a node to always connect first to when using remote PoW with optional authentication. Will overwrite the primary node for this case. - -| Param | Type | Description | -| ----------- | ------------------------------------- | ------------------------------- | -| url | `string` | A node URL | -| authOptions | `[NodeAuthOptions](#nodeauthoptions)` | Options for node authentication | - -**Returns** the client builder instance for chained calls. - -#### permanode(url, [, authOptions]): ClientBuilder - -Add a permanode. - -| Param | Type | Description | -| ----------- | ------------------------------------- | ------------------------------- | -| url | `string` | A node URL | -| authOptions | `[NodeAuthOptions](#nodeauthoptions)` | Options for node authentication | - -**Returns** the client builder instance for chained calls. - -#### nodes(urls): ClientBuilder - -Adds a list of IOTA nodes to the client pool. - -| Param | Type | Description | -| ----- | ---------- | --------------------- | -| url | `string[]` | An array of node URLs | - -**Returns** the client builder instance for chained calls. - -#### nodePoolUrls(urls): ClientBuilder - -Adds a list of IOTA nodes from node pool URLs to the client pool. - -| Param | Type | Description | -| ----- | ---------- | -------------------------- | -| url | `string[]` | An array of node pool URLs | - -**Returns** the client builder instance for chained calls. - -#### network(networkName): ClientBuilder - -Set a network to get default nodes for it. Can be "testnet" or "mainnet". -Nodes that don't belong to this network are ignored. - -| Param | Type | Description | -| ----------- | -------- | ----------- | -| networkName | `string` | The network | - -**Returns** the client builder instance for chained calls. - -#### quorum(enabled): ClientBuilder - -Defines how many of nodes will be queried at the same time to check for quorum. - -| Param | Type | Description | -| ------- | --------- | -------------------------------------- | -| enabled | `boolean` | Define if quourm should be used or not | - -**Returns** the client builder instance for chained calls. - -#### quorumSize(size): ClientBuilder - -Defines how many of nodes will be queried at the same time to check for quorum. - -| Param | Type | Description | -| ----- | -------- | ---------------------------------------- | -| size | `number` | The number of nodes that will be queried | - -**Returns** the client builder instance for chained calls. - -#### quorumThreshold(threshold): ClientBuilder - -Defines the minimum amount of nodes from the quorum pool that need to agree if we want to consider the result true. - -| Param | Type | Description | -| --------- | -------- | ----------------------- | -| threshold | `number` | Minimum amount of nodes | - -**Returns** the client builder instance for chained calls. - -#### brokerOptions(options): ClientBuilder - -Sets the options for the MQTT connection with the node. - -| Param | Type | Description | -| ------- | --------------------------------- | ----------------------- | -| options | `[BrokerOptions](#brokeroptions)` | The MQTT broker options | - -**Returns** the client builder instance for chained calls. - -#### nodeSyncInterval(interval): ClientBuilder - -Sets the node syncing interval. - -| Param | Type | Description | -| -------- | -------- | ----------------------------------------- | -| interval | `number` | The interval for the node syncing process | - -**Returns** the client builder instance for chained calls. - -#### disableNodeSync(): ClientBuilder - -Disables the node syncing process. Every node will be considered healthy and ready to use. - -**Returns** the client builder instance for chained calls. - -#### requestTimeout(timeoutMs): ClientBuilder - -Sets the default HTTP request timeout. - -| Param | Type | Description | -| ------- | -------- | --------------------------- | -| timeout | `number` | The timeout in milliseconds | - -**Returns** the client builder instance for chained calls. - -#### apiTimeout(api, timeoutMs): ClientBuilder - -Sets the HTTP request timeout for the specified API. - -| Param | Type | Description | -| ------- | --------------------------------------------------------------------------------------- | ---------------------------------- | -| api | `GetHealth` \| `GetInfo` \| `GetTips` \| `PostMessage` \| `GetOutput` \| `GetMilestone` | The API to set the request timeout | -| timeout | `number` | The timeout in milliseconds | - -**Returns** the client builder instance for chained calls. - -#### localPow(local): ClientBuilder - -Sets the PoW type. - -| Param | Type | Description | -| ----- | --------- | ---------------------------------------------------------- | -| local | `boolean` | Flag determining if PoW should be done locally or remotely | - -**Returns** the client builder instance for chained calls. - -#### build(): Client - -Builds the client instance. - -**Returns** a [Client](#client) instance. - -### Client - -#### networkInfo(): NetworkInfo - -Gets the cached network info. - -**Returns** a [NetworkInfo](#networkinfo) instance. - -#### subscriber(): TopicSubscriber - -Gets a handle to the MQTT topic subscriber. - -**Returns** a [TopicSubscriber](#topicsubscriber) instance. - -#### message(): MessageSender - -Initiates the builder to send messages. - -**Returns** a [MessageSender](#messagesender) instance. - -#### getUnspentAddress(seed): UnspentAddressGetter - -Get a valid unspent address. - -| Param | Type | Description | -| ----- | -------- | ------------------------------ | -| seed | `string` | The hex-encoded seed to search | - -**Returns** a [UnspentAddressGetter](#unspentaddressgetter) instance. - -#### getAddresses(seed): AddressGetter - -Find addresses from the seed regardless of their validity. - -| Param | Type | Description | -| ----- | -------- | ------------------------------ | -| seed | `string` | The hex-encoded seed to search | - -**Returns** a [AddressGetter](#addressgetter) instance. - -#### findMessages(indexationKeys, messageIds): Promise - -Finds all messages associated with the given indexation keys and message ids. - -| Param | Type | Description | -| -------------- | ---------- | --------------------------------------- | -| indexationKeys | `string[]` | The list of indexations keys too search | -| messageIds | `string[]` | The list of message ids to search | - -**Returns** a promise resolving to the list of the found messages. - -#### getBalance(seed: string): BalanceGetter - -Get balance on a given seed - -| Param | Type | Description | -| ----- | -------- | ------------------------------ | -| seed | `string` | The hex-encoded seed to search | - -**Returns** a [BalanceGetter](#balancegetter) instance. - -#### getAddressBalances(addresses): Promise - -Get the balance in iotas for the given addresses. - -| Param | Type | Description | -| --------- | ---------- | ------------------------------- | -| addresses | `string[]` | The list of addresses to search | - -**Returns** A promise resolving to the list of `{ address, balance }` pairs. - -#### generateMnemonic() - -Returns a random generated Bip39 mnemonic with the English word list. - -**Returns** A String - -#### mnemonicToHexSeed(mnemonic) - -Returns the seed hex encoded. - -| Param | Type | Description | -| -------- | -------- | ----------------------------------------------------- | -| mnemonic | `string` | Bip39 mnemonic with words from the English word list. | - -**Returns** A String - -#### bech32ToHex(bech32) - -Returns a parsed hex String from bech32. - -| Param | Type | Description | -| ------ | -------- | ------------------------- | -| bech32 | `string` | The address Bech32 string | - -**Returns** A String - -#### hexToBech32(hex, bech32_hrp (optional)) - -Returns a parsed bech32 String from hex. - -| Param | Type | Description | -| ---------- | -------- | ------------------------- | -| bech32 | `string` | The address Bech32 string | -| bech32_hrp | `string` | The Bech32 hrp string | - -**Returns** A String - -#### isAddressValid(address: string): boolean - -Checks if a given address is valid. - -| Param | Type | Description | -| ------- | -------- | ------------------------- | -| address | `string` | The address Bech32 string | - -**Returns** A boolean. - -#### getMessageId(message: string): boolean - -Returns the message id from a message. - -| Param | Type | Description | -| ------- | -------- | -------------- | -| message | `string` | The message id | - -**Returns** the message id. - -#### retry(messageId: string): Promise - -Retries (promotes or reattaches) the message associated with the given id. - -| Param | Type | Description | -| --------- | -------- | ------------------------------ | -| messageId | `string` | The id of the message to retry | - -**Returns** A promise resolving to the new [Message](#message) instance. - -#### retryUntilIncluded(messageId: string[, interval: int, maxAttempts: int]): Promise - -Retries (promotes or reattaches) the message associated with the given id until it's included in the Tangle. -Default interval is 5 seconds and max_attempts is 10. - -| Param | Type | Description | -| --------------------- | -------- | ------------------------------------------------------ | -| messageId | `string` | The id of the message to retry | -| [options.interval] | `int` | The interval in seconds in which we retry the message. | -| [options.maxAttempts] | `int` | The maximum of attempts we retry the message. | - -**Returns** the message ids and [Message](#message) of reattached messages. - -#### consolidateFunds(seed: string, accountIndex: int, startIndex: int, endIndex: int): Promise - -Function to consolidate all funds from a range of addresses to the address with the lowest index in that range - -| Param | Type | Description | -| ------------ | -------- | --------------------------------------------------------------------- | -| seed | `string` | The seed | -| accountIndex | `int` | The account index. | -| startIndex | `int` | The lowest address index, funds will be consolidated to this address. | -| endIndex | `int` | The address index until which funds will be consolidated | - -**Returns** the address to which the funds got consolidated, if any were available. - -#### getInfo(): Promise - -Gets information about the node. - -**Returns** a promise resolving to the [NodeInfoWrapper](#nodeinfowrapper) object. - -#### getTips(): Promise<[string, string]> - -Gets two non-lazy tips. - -**Returns** a promise resolving to an array of length 2 containing the message ids of the tips. - -#### postMessage(message): Promise - -Submits a message. - -| Param | Type | Description | -| ------- | --------------------------- | --------------------- | -| message | `[MessageDto](#messagedto)` | The message to submit | - -**Returns** the message identifier. - -#### getMessage(): MessageFinder - -Gets a message from its identifier. - -**Returns** an instance of the [MessageFinder](#messagefinder) for choices of response. - -#### getOutput(outputId): Promise - -Gets the UTXO outputs associated with the given output id. - -| Param | Type | Description | -| -------- | -------- | ------------------------------ | -| outputId | `string` | The id of the output to search | - -**Returns** a promise resolving to the associated [OutputMetadata](#outputmetadata). - -#### findOutputs(outputIds, addresses): Promise - -Gets the UTXO outputs associated with the given output ids and addresses. - -| Param | Type | Description | -| --------- | ---------- | -------------------------------- | -| addresses | `string[]` | The list of addresses to search | -| outputIds | `string[]` | The list of output ids to search | - -**Returns** a promise resolving to a list of [OutputMetadata](#outputmetadata). - -#### getAddressOutputs(address[, options]): Promise - -Gets the UTXO outputs associated with the given address. - -| Param | Type | Description | -| ---------------------- | --------------------------------------------------------- | ----------------------------------------------------- | -| address | `string` | The address Bech32 string | -| [options.includeSpent] | `boolean` | Whether the query should include spent outputs or not | -| [options.outputType] | `SignatureLockedSingle` \| `SignatureLockedDustAllowance` | The output type filter | - -**Returns** a promise resolving to a list of output ids. - -#### getAddressBalance(address): Promise - -Gets the balance of the given address. - -| Param | Type | Description | -| ------- | -------- | ------------------------- | -| address | `string` | The address Bech32 string | - -#### getMilestone(index): Promise - -Gets the milestone by the given index. - -| Param | Type | Description | -| ----- | -------- | -------------------------- | -| index | `number` | The index of the milestone | - -**Returns** a promise resolving to the [MilestoneMetadata](#milestonemetadata). - -#### getMilestoneUtxoChanges(index): Promise - -Gets the utxo changes by the given milestone index. - -| Param | Type | Description | -| ----- | -------- | -------------------------- | -| index | `number` | The index of the milestone | - -**Returns** a promise resolving to the [MilestoneUTXOChanges](#milestoneutxochanges). - -#### getReceipts(): Promise - -Get all receipts. - -**Returns** a promise resolving to the [Receipts](#receipts). - -#### getReceiptsMigratedAt(index): Promise - -Get all receipts for a given milestone index - -| Param | Type | Description | -| ----- | -------- | -------------------------- | -| index | `number` | The index of the milestone | - -**Returns** a promise resolving to the [Receipts](#receipts). - -#### getTreasury(): Promise - -Get the treasury amount. - -**Returns** a promise resolving to the [Treasury](#treasury). - -#### getIncludedMessage(): Promise - -Get the included message of a transaction. - -| Param | Type | Description | -| ----- | -------- | ------------------------- | -| index | `string` | The id of the transaction | - -**Returns** A promise resolving to the new [Message](#message) instance. - -#### reattach(messageId): Promise - -Reattaches the message associated with the given id. - -| Param | Type | Description | -| --------- | -------- | --------------------------------- | -| messageId | `string` | The id of the message to reattach | - -**Returns** A promise resolving to the new [Message](#message) instance. - -#### promote(messageId): Promise - -Promotes the message associated with the given id. - -| Param | Type | Description | -| --------- | -------- | -------------------------------- | -| messageId | `string` | The id of the message to promote | - -**Returns** A promise resolving to the new [Message](#message) instance. - -### NetworkInfo - -| Field | Type | Description | -| ----------- | --------- | ------------------------------------- | -| network | `string` | The network | -| networkId | `number` | The network hashed | -| bech32HRP | `string` | Bech32 HRP for this network | -| minPoWScore | `number` | The network's minimum score for PoW | -| localPow | `boolean` | Whether we are using local PoW or not | - -### TopicSubscriber - -Possible topics: - -```bash -milestones/latest -milestones/confirmed - -messages -messages/referenced -messages/indexation/{index} -messages/{messageId}/metadata -transactions/{transactionId}/included-message - -outputs/{outputId} - -addresses/{address}/outputs -addresses/ed25519/{address}/outputs -``` - -#### topic(topic): TopicSubscriber - -Adds a topic to this manager instance. - -| Param | Type | Description | -| ----- | -------- | ------------ | -| topic | `string` | A MQTT topic | - -**Returns** the topic subscriber instance for chained calls. - -#### topics(topic): TopicSubscriber - -Adds a list of topics to this manager instance. - -| Param | Type | Description | -| ------ | ---------- | ----------------------- | -| topics | `string[]` | An array of MQTT topics | - -**Returns** the topic subscriber instance for chained calls. - -#### subscribe(cb): TopicSubscriber - -Subscribe to the provided topics. - -| Param | Type | Description | -| ----- | ---------- | ---------------------------------------------------------------- | -| cb | `function` | The topic handler callback in the form of `(err, message) => {}` | - -**Returns** the topic subscriber instance for chained calls. - -#### unsubscribe(cb: Callback): TopicSubscriber - -Unsubscribes from the provided topics. - -| Param | Type | Description | -| ----- | ---------- | ------------------------------------------------------------------------------------------ | -| cb | `function` | A callback executed when the unsubscribe is finished in the form of `(err, message) => {}` | - -**Returns** the topic subscriber instance for chained calls. - -### MessageSender - -Builder to create and submit messages to the Tangle. - -#### index(index): MessageSender - -Sets the message indexation. This field is required for indexation payloads. - -| Param | Type | Description | -| ----- | -------------------------------------- | -------------- | -| index | `string` \| `number[]` \| `Uint8Array` | The indexation | - -**Returns** the message submit instance for chained calls. - -#### data(data): MessageSender - -Sets the indexation data. - -| Param | Type | Description | -| ----- | ------------------------ | ------------------ | -| data | `string` \| `Uint8Array` | The message's data | - -**Returns** the message submit instance for chained calls. - -#### seed(seed): MessageSender - -Sets the transaction account seed. This field is required for transaction payloads. - -| Param | Type | Description | -| ----- | -------- | -------------------------------------------- | -| seed | `string` | The hex-encoded seed of the account to spend | - -**Returns** the message submit instance for chained calls. - -#### parents(messageId): MessageSender - -Sets 1-8 custom parent message ids. - -| Param | Type | Description | -| --------- | ---------- | ----------------------- | -| messageId | `string[]` | The parents message ids | - -**Returns** the message submit instance for chained calls. - -#### accountIndex(index): MessageSender - -Sets the account index. This field is required for transactions. - -| Param | Type | Description | -| ----- | -------- | ----------------- | -| index | `number` | The account index | - -**Returns** the message submit instance for chained calls. - -#### input(transactionId, index): MessageSender - -Adds an output to the transaction. - -| Param | Type | Description | -| ------------- | -------- | ------------------ | -| transactionId | `string` | The transaction id | -| index | `number` | The input index | - -**Returns** the message submit instance for chained calls. - -#### inputRange(start, end): MessageSender - -Defines the range in which to search for addresses fro custom inputs. - -| Param | Type | Description | -| ----- | -------- | --------------- | -| start | `number` | The start index | -| end | `number` | The end index | - -**Returns** the message submit instance for chained calls. - -#### output(address, amount): MessageSender - -Adds an output to the transaction. - -| Param | Type | Description | -| ------- | -------- | ------------------ | -| address | `string` | The output address | -| amount | `number` | The output amount | - -**Returns** the message submit instance for chained calls. - -#### dustAllowanceOutput(address, amount): MessageSender - -Adds a dust allowance output to the transaction. - -| Param | Type | Description | -| ------- | -------- | ------------------ | -| address | `string` | The output address | -| amount | `number` | The output amount | - -**Returns** the message submit instance for chained calls. - -#### initialAddressIndex(index): MessageSender - -Sets the initial address index to search for balance. Defaults to 0 if the function isn't called. - -| Param | Type | Description | -| ----- | -------- | ------------------------- | -| index | `number` | The initial address index | - -**Returns** the message submit instance for chained calls. - -#### submit(): Promise - -Submits the message. - -**Returns** a promise resolving to the message identifier. - -### UnspentAddressGetter - -Gets a valid unspent address associated with the seed. - -#### accountIndex(index): UnspentAddressGetter - -Sets the account index. This field is required. - -| Param | Type | Description | -| ----- | -------- | ----------------- | -| index | `number` | The account index | - -**Returns** the address getter instance for chained calls. - -#### initialAddressIndex(index): UnspentAddressGetter - -Sets the initial address index. Defaults to 0 if the function isn't called. - -| Param | Type | Description | -| ----- | -------- | ------------------------- | -| index | `number` | The initial address index | - -**Returns** the address getter instance for chained calls. - -#### get(): Promise<[Address, number]> - -Performs the operation. - -**Returns** a promise resolving to the [Address](#address) instance and its index. - -### AddressGetter - -Generates addresses with a given seed. - -#### accountIndex(index): AddressGetter - -Sets the account index. This field is required. - -| Param | Type | Description | -| ----- | -------- | ----------------- | -| index | `number` | The account index | - -**Returns** the address finder instance for chained calls. - -#### range(start, end): AddressGetter - -Defines the range of addresses to get. Defaults to `0..20` if the function isn't called. - -| Param | Type | Description | -| ----- | -------- | ----------------------- | -| start | `number` | The first address index | -| end | `number` | The last address index | - -**Returns** the address finder instance for chained calls. - -#### includeInternal(): AddressGetter - -Defines that public and internal address will be returned instead of only public addresses. - -**Returns** the address finder instance for chained calls. - -#### bech32Hrp(bech32Hrp): AddressGetter - -Defines the bech32Hrp for the bech32 encoded addresses, required when generating addresses offline(with disableNodeSync()). - -| Param | Type | Description | -| --------- | -------- | ------------------------------- | -| bech32Hrp | `string` | The bech32Hrp for the addresses | - -**Returns** the address finder instance for chained calls. - -#### get(): Address[] | [Address, bool][] - -Performs the operation. - -**Returns** an array of public [Address](#address) instances or an array of arrays with an Address and a bool, -where the bool defines whether it's an internal address or not. - -### BalanceGetter - -Gets balance on a given seed. - -#### accountIndex(index): BalanceGetter - -Sets the account index. This field is required. - -| Param | Type | Description | -| ----- | -------- | ----------------- | -| index | `number` | The account index | - -**Returns** the balance getter instance for chained calls. - -#### initialAddressIndex(index): BalanceGetter - -Sets the initial address index. Defaults to 0 if the function isn't called. - -| Param | Type | Description | -| ----- | -------- | ------------------------- | -| index | `number` | The initial address index | - -**Returns** the balance getter instance for chained calls. - -#### gapLimit(amount): BalanceGetter - -Sets the gapLimit to specify how many addresses will be checked each round. -If gapLimit amount of addresses in a row have no balance the BalanceGetter will return. Defaults to 20 if the function isn't called. - -| Param | Type | Description | -| -------- | -------- | ------------------------- | -| gapLimit | `number` | The initial address index | - -**Returns** the balance getter instance for chained calls. - -#### get(): Promise - -Performs the operation. - -**Returns** a promise resolving to the account balance. - -### MessageFinder - -Gets a message by indexation key or identifier. - -#### initialAddressIndex(index): Promise - -| Param | Type | Description | -| ----- | -------- | ------------------ | -| index | `string` | The indexation key | - -Gets a list of message identifiers associated with the given indexation key. - -**Returns** a promise resolving to the list of associated ids. - -#### data(id): Promise - -Gets the message object associated with the given identifier. - -| Param | Type | Description | -| ----- | -------- | ---------------------- | -| id | `string` | The message identifier | - -**Returns** a [Message](#message) object. - -#### raw(id): Promise - -Gets the message raw data. - -| Param | Type | Description | -| ----- | -------- | ---------------------- | -| id | `string` | The message identifier | - -**Returns** the message raw data as string. - -#### children(id): Promise - -Gets the children of the given message. - -| Param | Type | Description | -| ----- | -------- | ---------------------- | -| id | `string` | The message identifier | - -**Returns** the list of message ids of the message children. - -#### metadata(id): Promise - -Gets the metadata of the given message. - -| Param | Type | Description | -| ----- | -------- | ---------------------- | -| id | `string` | The message identifier | - -**Returns** a [MessageMetadata](#messagemetadata) object. - -### BrokerOptions - -All fields are optional. - -| Field | Type | Description | -| ----------------------- | --------- | ----------------------------------------------------------------------------------------------------- | -| automaticDisconnect | `boolean` | Whether the MQTT broker should be automatically disconnected when all topics are unsubscribed or not. | -| timeout | `number` | MQTT connection timeout in secods | -| useWs | `boolean` | Defines if websockets should be used (true) or TCP (false) | -| maxReconnectionAttempts | `number` | Defines the maximum reconnection attempts before it returns an error | -| port | `number` | Defines the port to be used for the MQTT connection | - -### NodeAuthOptions - -| Field | Type | Description | -| ----------------- | -------- | ------------------------------------------ | -| jwt | `string` | Optional JSON Web Token. | -| basicAuthName | `string` | Optional name for basic authentication | -| basicAuthPassword | `string` | Optional password for basic authentication | - -### Address - -| Field | Type | Description | -| ----- | -------- | -------------------------- | -| data | `string` | Address as a Bech32 string | - -### Message - -| Field | Type | Description | -| --------- | --------------------- | ------------------------------------- | -| networkId | `number` | Network identifier | -| parents | `string[]` | Message ids of the message references | -| payload | `[Payload](#payload)` | Message payload | -| nonce | `number` | Message nonce | - -### MessageWrapper - -| Field | Type | Description | -| --------- | --------- | -------------- | -| message | `Message` | Message | -| messageId | `string` | The message id | - -#### Payload - -| Field | Type | Description | -| ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | -| data | `{ type: 'Transaction', data: TransactionPayload }` \| `{ type: 'Indexation', data: IndexationPayload }` \| `{ type: 'Milestone', data: MilestonePayload}` | Payload data | - -##### TransactionPayload - -| Field | Type | Description | -| ------------- | --------------------------- | ------------------- | -| essence | `TransactionPayloadEssence` | Transaction essence | -| unlock_blocks | `UnlockBlock[]` | Unlock blocks | - -- TransactionPayloadEssence - -| Field | Type | Description | -| ------- | ------------------------ | -------------------- | -| inputs | `Input[]` | Inputs | -| outputs | `Output[]` | Outputs | -| payload | `Payload` \| `undefined` | Payload for chaining | - -- Input - -| Field | Type | Description | -| ----- | -------- | ------------------------ | -| type | `'UTXO'` | Input type identifier | -| data | `string` | The associated output id | - -- Output - -| Field | Type | Description | -| ----- | ------------------------------------- | ---------------------- | -| type | `SignatureLockedSingle` | Output type identifier | -| data | `{ address: string, amount: number }` | The output definition | - -- UnlockBlock - -| Field | Type | Description | -| ----- | ----------------------------------------- | ----------------------------------------------------- | -| type | `'Signature' \| 'Reference'` | Unlock block type identifier | -| data | `Ed25519SignatureUnlockBlock` \| `number` | Unlock block data (signature type or reference index) | - -- Ed25519SignatureUnlockBlock - -| Field | Type | Description | -| ---------- | ---------- | ------------------ | -| public_key | `number[]` | Ed25519 public key | -| signature | `number[]` | Ed25519 signature | - -##### IndexationPayload - -| Field | Type | Description | -| ----- | ---------- | ----------------------------- | -| index | `string` | Indexation key | -| data | `number[]` | Indexation data as byte array | - -##### MilestonePayload - -| Field | Type | Description | -| ---------- | ------------------ | -------------------- | -| essence | `MilestoneEssence` | Milestone essence | -| signatures | `number[][]` | Milestone signatures | - -- MilestoneEssence - -| Field | Type | Description | -| -------------------------- | ------------ | ------------------------------------------------------ | -| index | `number` | Milestone index | -| timestamp | `number` | Timestamp | -| parents | `string[]` | Message ids of the messages the milestone references | -| merkleProof | `number[]` | Merkle proof | -| nextPoWScore | `number` | Next PoW score | -| nextPoWScoreMilestoneIndex | `number` | Milestone index at which the nextPoWScore will be used | -| publicKeys | `number[][]` | public keys | - -### MessageDto - -| Field | Type | Description | -| ------- | --------------------------- | ----------------------------------------------------------------------- | -| parents | `string[]` \| `undefined` | Message ids of the messages it references. `getTips` is used by default | -| payload | `[PayloadDto](#payloaddto)` | Message payload | - -#### PayloadDto - -| Field | Type | Description | -| ----- | ------------------------------------------------- | ------------ | -| data | `TransactionPayloadDto` \| `IndexationPayloadDto` | Payload data | - -##### TransactionPayloadDto - -| Field | Type | Description | -| ------------ | ------------------------------ | ------------------- | -| essence | `TransactionPayloadEssenceDto` | Transaction essence | -| unlockBlocks | `UnlockBlockDto[]` | Unlock blocks | - -- TransactionPayloadEssenceDto - -| Field | Type | Description | -| ------- | --------------------------- | -------------------- | -| inputs | `string[]` | Inputs | -| outputs | `Output[]` | Outputs | -| payload | `PayloadDto` \| `undefined` | Payload for chaining | - -- OutputDto - -| Field | Type | Description | -| ------- | -------- | -------------- | -| address | `string` | Output address | -| amount | `amount` | Output amount | - -- UnlockBlockDto - -| Field | Type | Description | -| ----- | -------------------------------------------- | ----------------------------------------------------- | -| data | `Ed25519SignatureUnlockBlockDto` \| `number` | Unlock block data (signature type or reference index) | - -- Ed25519SignatureUnlockBlockDto - -| Field | Type | Description | -| --------- | ---------- | ------------------ | -| publicKey | `number[]` | Ed25519 public key | -| signature | `number[]` | Ed25519 signature | - -##### IndexationPayloadDto - -| Field | Type | Description | -| ----- | ------------ | --------------- | -| index | `string` | Indexation key | -| data | `Uint8Array` | Indexation data | - -##### AddressBalance - -| Field | Type | Description | -| ----------- | --------- | ---------------------- | -| address | `string` | Bech32 encoded address | -| balance | `number` | Address balance | -| dustAllowed | `boolean` | Dust allowed | - -### MessageMetadata - -| Field | Type | Description | -| -------------------------- | ------------------------ | --------------------------------------------------------- | -| messageId | `string` | Message identifier | -| parents | `string[]` | Message id of the messages it references | -| isSolid | `boolean` | Message solid state | -| shouldPromote | `boolean` \| `undefined` | Indicates whether the message should be promoted or not | -| shouldReattach | `boolean` \| `undefined` | Indicates whether the message should be reattached or not | -| referencedByMilestoneIndex | `number` \| `undefined` | Index of the milestone that references this message | -| ledgerInclusionState | `string` \| `undefined` | Ledger inclusion state | - -### NodeInfoWrapper - -| Field | Type | Description | -| -------- | ---------- | ----------- | -| url | `string` | Node url | -| nodeinfo | `NodeInfo` | NodeInfo | - -### NodeInfo - -| Field | Type | Description | -| --------------------------- | ---------- | ------------------------------------------------- | -| name | `string` | Node name | -| version | `string` | Node version | -| isHealthy | `boolean` | Node health status | -| networkId | `string` | Node network identifier | -| bech32HRP | `string` | Bech32 HRP for this network | -| minPoWScore | `number` | Min PoW score | -| messagesPerSecond | `number` | Network stats: Messages per second in the network | -| referencedMessagesPerSecond | `number` | Network stats: Referenced messages per second | -| referencedRate | `number` | Network stats: referenced rate | -| latestMilestoneTimestamp | `number` | Timestamp of the latest milestone | -| latestMilestoneIndex | `number` | Index of the latest milestone | -| confirmedMilestoneIndex | `number` | Index of the confirmed milestone | -| pruningIndex | `number` | Pruning index | -| features | `string[]` | List of node features | - -### OutputMetadata - -| Field | Type | Description | -| ------------- | --------- | ------------------------------------------------ | -| messageId | `string` | Id of the message associated with the output | -| transactionId | `string` | Id of the transaction associated with the output | -| outputIndex | `number` | Output index | -| isSpent | `boolean` | Output spent state | -| address | `string` | Output address | -| amount | `number` | Output amount | - -### MilestoneMetadata - -| Field | Type | Description | -| -------------- | -------- | ----------------------------------------------- | -| milestoneIndex | `number` | Milestone index | -| messageId | `string` | Id of the message associated with the milestone | -| timestamp | `number` | Milestone timestamp | - -### MilestoneUTXOChanges - -| Field | Type | Description | -| --------------- | ---------- | ---------------------------------- | -| index | `number` | Milestone index | -| createdOutputs | `string[]` | OutputIds from new created outputs | -| consumedOutputs | `string[]` | OutputIds from consumed outputs | - -### Receipts - -| Field | Type | Description | -| -------------- | --------- | --------------- | -| receipt | `receipt` | Receipt | -| milestoneIndex | `number` | Milestone index | - -### Treasury - -| Field | Type | Description | -| ----------- | -------- | ------------ | -| milestoneId | `string` | Milestone id | -| amount | `number` | Amount | diff --git a/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_01_get_info.mdx b/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_01_get_info.mdx deleted file mode 100644 index 4ede6a2db12..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_01_get_info.mdx +++ /dev/null @@ -1,37 +0,0 @@ -import LoadBalancerHealthChecks from '../../../_admonitions/_load_balancer_health_checks.md'; -import GetInfoOutput from '../../../_partials/examples/01_get_info/outputs/snake_case.md'; -import ClientBuilder from '../../../_partials/examples/01_get_info/_client_builder.md'; - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/nodejs/examples/01_get_info.js -``` - -**Output example** of the `getInfo()` function of the `Client` instance: - - - - - - - -The most common ones are: - -- `.network(str)`: Can be either `devnet` or `mainnet`. It instructs - the library whether to automatically select devnet nodes or mainnet nodes. -- `.node(url)`: Specify address of actual running IOTA node that should be used - to communicate with in the format `https://node:port`). For example: `https://api.lb-0.h.chrysalis-devnet.iota.cafe:443`. -- `.nodePoolUrls(urls)`: The library also supports managing a pool of - nodes. You can provide a list of nodes and the library manages the access to them automatically by selecting them based - on their sync status. If you provide `.nodePoolUrls(urls)`, then the library periodically will periodically check whether node is in sync or - not by calling `.nodeSyncInterval(interval)`. -- `.localPow(bool)`: If `.localPow (True)` a Proof-of-work will be done - locally and not remotely. -- `.disableNodeSync()`: When called, the library will use nodes that - are **not** in sync with network. This parameter is usually useful if you would like to interact with a local test node - that is not fully synced. **This parameter should not be used in production**. - -The following example uses additional initialization chaining calls, such as leveraging a custom node: - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/nodejs/examples/01b_get_info.js -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_02_generate_seed.mdx b/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_02_generate_seed.mdx deleted file mode 100644 index e42d587fc4d..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_02_generate_seed.mdx +++ /dev/null @@ -1,14 +0,0 @@ -You can generate a seed, for example, using the SHA256 algorithm on some random input generated by a cryptographically -secure pseudo-random generator, such as `crypto.randomBytes()`: - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/nodejs/examples/02_generate_seed.js -``` - -**Output example**: - -```plaintext -39bccf7b88a8017e6a96e6f31e34f138829c574dc6061523e84c5f2e53f5ca36 -pass phrase weapon yellow diary scissors gift drive strategy antique scheme make surround aerobic mystery coral hope lock walnut become exclude only glove syrup -eff5c97c96ddab55d6fe78f914508750152eaab1b9692236bc79268895ecfd168e91eedd2489ed6c51fc44156b9a2e6c967e4edcfb649ff33d41581be4627347 -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_03_generate_addresses.mdx b/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_03_generate_addresses.mdx deleted file mode 100644 index baba23b50c7..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_03_generate_addresses.mdx +++ /dev/null @@ -1,38 +0,0 @@ -You can generate an IOTA address using the [`AddressGetter`](../api_reference.md#addressgetter) helper -class and calling the [`Client.getAddresses()`](../api_reference.md#getaddressesseed-addressgetter) -function and respective chaining calls that will return a list of tuples with the generated addresses. You can find -more information on the parameters in the [Address/Key Space section](../../../explanations/address_key_space.md). - -The whole process is deterministic. This means the output is the same as long as the seed is the same: - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/nodejs/examples/03_generate_addresses.js -``` - -**Output example**: - -```string -[ - 'atoi1qz6dr6dtl0856tf0pczz7gesrf7j8a4vr00q58ld2zx7ttlv3p96snpym9z', - 'atoi1qpp7sz28a0ghvd6knwnljr7j2s04qquduuc5vlz94fwf94zznj2yv5ew2c4', - 'atoi1qzje6zhg5vu456eg3z84ekcfn3laxqyczche5eeqhcdh3w9yr5sqvr4z4td', - 'atoi1qqwhxjmcvmatpedeedapgx0vwyupfwx9k5n4w0lnc5l6vmz78aavwhs55v0', - 'atoi1qzg63t9880jtfysvpq7rrynz0rqt3kd2fw8r4934ezraz9dpwvzxkw2dtmh' -] -``` - -IOTA addresses are represented by a checksumed base-32 string (Bech32). You can find a detailed explanation in the -[Chrysalis documentations](/introduction/reference/details#iota-15-address-anatomym), but here are -parts relevant to this example: - -- If an address starts with `atoi` then it means it is related to `devnet`. `iota` stands for `mainnet`. -- Number `1` at the 5th positvion is just a separator. -- The last 6 characters are reserved for a checksum. - -Addresses can be also represented in a hex format and `iota.rs` provides some convenient functions to convert addresses: -[`Client.bech32ToHex(bech32)`](../api_reference.md#bech32tohexbech32) and -[`Client.hexToBech32(hex, bech32_hrp (optional))`](../api_reference.md#hextobech32hex-bech32_hrp-optional). - -If you want to quickly validate any IOTA address, you can use the -[`Client.isAddressValid()`](../api_reference.md#isaddressvalidaddress-string-boolean) function that -returns a `bool` value. You should perform a sanity check on address before using it. diff --git a/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_04_get_balance.mdx b/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_04_get_balance.mdx deleted file mode 100644 index 1c8b74f3bd2..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_04_get_balance.mdx +++ /dev/null @@ -1,44 +0,0 @@ -There are three common API calls you can use to get a balance: - -## [`Client.getAddressBalance(address: string)`](./../api_reference.md#getaddressbalanceaddress-promise) - -It expects a single address in Bech32 format and returns `dict` with a balance for the address. - -## [`Client.getAddressBalances(AddressBalance[]: string[])`](./../api_reference.md#getaddressbalancesaddresses-promiseaddressbalance) - -A convenient function that expects `list` of addresses in Bech32 format and returns list of `dict` with balances for all -given addresses. - -## [`Client.getBalance(seed: string)`](./../api_reference.md#getbalanceseed-string-balancegetter) - -A convenient helper [`BalanceGetter`](./../api_reference.md#balancegetter) class that combines -[`Client.getAddresses()`](./../api_reference.md#getaddressesseed-addressgetter) and -`Client.getAddressBalance()` api calls. It returns a combined balance for the provided `seed` and optional chaining -calls [`.accountIndex(index: number)`](./../api_reference.md#accountindexindex-balancegetter), -[`.initialAddressIndex(index: number)`](./../api_reference.md#initialaddressindexindex-balancegetter) and -[`.gapLimit(amount: number)`](./../api_reference.md#gaplimitamount-balancegetter). - -`Client.getBalance(seed)` performs several tasks under the hood. It starts by generating addresses for the provided -`seed` and `.accountIndex` from `.initialAddressIndex(index)`, and checks for a balance of each of the generated -addresses. Since it does not know how many addresses are used in fact, there is a condition set by the -`.gapLimit(amount)` argument to know when to stop searching. If the `.gapLimit` amount of addresses in a row have no -balance, the function returns results and searching does not continue. - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/nodejs/examples/04_get_balance.js -``` - -Example of output: - -```json -{ - "address":"atoi1qp9427varyc05py79ajku89xarfgkj74tpel5egr9y7xu3wpfc4lkpx0l86", - "balance":10000000, - "dustAllowed":false -} -Account balance: 0 -``` - -- `dustAllowed` indicates whether the given address is allowed to accept a dust. You can learn more about dust - protection in the - [Chrysalis documentation](/introduction/explanations/faq#what-is-dust-protection-and-how-does-it-work). diff --git a/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_05_get_outputs.mdx b/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_05_get_outputs.mdx deleted file mode 100644 index 03734fd9158..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_05_get_outputs.mdx +++ /dev/null @@ -1,91 +0,0 @@ -- [`Client.getAddressOutputs(str)`](#clientgetoutputstr) -- [`Client.getOutput(str)`](#clientgetoutputstr) -- [`Client.findOutputs(output_ids (optional), addresses (optional))`](#clientfindoutputsoutput_ids-optional-addresses-optional): - -## Client.getAddressOutputs(str) - -This [`Client.getAddressOutputs(str)`](./../api_reference.md#getaddressoutputsaddress-options-promisestring) expects an address in Bech32 format and returns a `str[]` of `output_ids`. - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/nodejs/examples/05a_get_address_outputs.js -``` - -**Output example**: - -```json -[ - "0f2d5d2651f8061a9f5417d0658009f32b2e3f77f9706b0be3b4b3f466171f360000", - "7614ba900a90b130707766a660a454942ac7cc4adea3fb9ad0cdca90114417c20000", - "768c20c15a290e02a43b83263a98501b9d7eb0b57da40a9247289c672de63ea60000" -] -``` - -## Client.getOutput(str) - -You can use the [`Client.getOutput(str)`](./../api_reference.md#getoutputoutputid-promise) function to get metadata about the an `output_id`: - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/nodejs/examples/05b_get_output.js -``` - -**Output example**: - -```json -{ - "messageId": "f303bc90a5ed3ef15af5fc6aa81a739978c59458a71e68ce8e380f1f534da1e6", - "transactionId": "0f2d5d2651f8061a9f5417d0658009f32b2e3f77f9706b0be3b4b3f466171f36", - "outputIndex": 0, - "isSpent": false, - "address": "atoi1qzt0nhsf38nh6rs4p6zs5knqp6psgha9wsv74uajqgjmwc75ugupx3y7x0r", - "amount": 1000000 -} -``` - -## Client.findOutputs(output_ids (optional), addresses (optional)) - -The function [`Client.findOutputs()`](./../api_reference.md#findoutputsoutputids-addresses-promiseoutputmetadata) is a convenient shortcut combining both `Client.getAddressOutputs(str)` and -`Client.getOutput(str)` methods in a single call. It supports two arguments, a list of `output_ids` or a list of -`addresses`. - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/nodejs/examples/05c_find_outputs.js -``` - -**Output example**: - -```json -[ - { - "messageId": "f303bc90a5ed3ef15af5fc6aa81a739978c59458a71e68ce8e380f1f534da1e6", - "transactionId": "0f2d5d2651f8061a9f5417d0658009f32b2e3f77f9706b0be3b4b3f466171f36", - "outputIndex": 0, - "isSpent": false, - "address": "atoi1qzt0nhsf38nh6rs4p6zs5knqp6psgha9wsv74uajqgjmwc75ugupx3y7x0r", - "amount": 1000000 - }, - { - "messageId": "825266a79c0ffb6001ed263eb150357863b7d0052627c5766e8ef5acd6fed533", - "transactionId": "768c20c15a290e02a43b83263a98501b9d7eb0b57da40a9247289c672de63ea6", - "outputIndex": 0, - "isSpent": false, - "address": "atoi1qzt0nhsf38nh6rs4p6zs5knqp6psgha9wsv74uajqgjmwc75ugupx3y7x0r", - "amount": 1000000 - } -] -``` - -- `messageId`: Refers to the encapsulating message in which the transaction was sent. -- `transactionId`, `outputIndex`: Refers to the output within the `SignedTransaction` payload. There may be several - `outputs` involved in a single transaction, so the `transactionId` by itself would not be enough. -- `output`: This section provides details about the iota address to which the given - [unspent transaction output](../../../explanations/messages_payloads_and_transactions.md#unspent-transaction-output-utxo) is coupled with. -- `amount`: States an amount of tokens related to the `output`. -- `isSpent`: Indicates whether the given `output` is a part of the actual _ledger state_ or not. As mentioned in the - [Messages, Payloads, and Transactions section](../../../explanations/messages_payloads_and_transactions.md#unspent-transaction-output-utxo), - if an output was already spent it is not part of the ledger state any more and is replaced by some other `output(s)` - in the process. - -Notice that the `outputId` that was used in a function call to get output details is the same as a combination of the -`transactionId` and `outputIndex`. This way a transaction is tightly coupled with `outputs` since the -`SignedTransaction` payload is a main vehicle to create and spend `outputs`, and everything is encapsulated in a -[message](../../../explanations/messages_payloads_and_transactions.md#Messages). diff --git a/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_06_simple_message.mdx b/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_06_simple_message.mdx deleted file mode 100644 index b1063b78f3a..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_06_simple_message.mdx +++ /dev/null @@ -1,28 +0,0 @@ -You can use the function [`Client.postMessage(message)`](./../api_reference.md#postmessagemessage-promise) to send a message instance over a network. Alternatively, you can -use the [`MessageSender`](./../api_reference.md#messagesender) helper class with chaining calls that prepares a message instance and broadcasts it over the -network. - -```js reference -https://github.com/iotaledger/iota.rs/blob/production/bindings/nodejs/examples/06_simple_message.js -``` - -**Output example**: - -```string -{ - message: { - networkId: '14379272398717627559', - parentMessageIds: [ - '03ddc83fad172a322fb00fb4e449436e9d1117ff390879100647c650a30c2d52', - '252798210fa9816f6fd40f1b19095da9f2dc88ae06fc4c0523a928a29d0d782e', - 'a8e4f4cd49227068424ead8da187a48fdaa7ce8ffc4b9ac0ee2d5d3f2fcd7e70', - 'dbbc8044bc624b3378e1dda83ab95f9be468b06a6a9806c76a70353182028cf9' - ], - payload: null, - nonce: '9223372036854784215' - }, - messageId: '10dbee9cf3c58507725861b34ac711058dc13f709be1a6d21f1dc0af17b06379' -} -``` - -- `messageId` is a unique id that refers to the given message in the network. diff --git a/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_07_get_message_data.mdx b/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_07_get_message_data.mdx deleted file mode 100644 index 0313da6a8ac..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_07_get_message_data.mdx +++ /dev/null @@ -1,51 +0,0 @@ -Once a [message](../../../explanations/messages_payloads_and_transactions.md) is broadcast, you can use the -[`MessageFinder`](./../api_reference.md#messagefinder) helper class that you can instantiate using the -[`Client.getMessage()`](./../api_reference.md#getmessage-messagefinder) function to retrieve it from the -network. The `MessageFinder` provides helper functions related to the message, such as [`Client.getMessage().data(id: str)`](./../api_reference.md#dataid-promise) -and [`Client.getMessage().metadata(str)`](./../api_reference.md#metadataid-promise): - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/nodejs/examples/07_get_message_data.js -``` - -**Output example**: - -```json -Message meta data: -{ - "messageId":"e52b631bc7500366b90c6e11eb7fd6abaa7527f9bb5b4b512b0b9112bb9e7be8", - "parentMessageIds": [ - "26d72339ed262c1ec29d6c91de6be26d067b3327191f5e47606df53cc40e334e", - "6289ea0aecf3830e5e8d9925959bb6e804e324bb6db23c5701f7a538d12831f6", - "fdbf2d02603235fdff99f0ceb57705ead95041d62de386387f2922e5d9f6c502", - "ffa26139ca7f9d4849e118ff369fb3a387c8fefd8d15232b8353d4acf334324c" - ], - "isSolid":true, - "shouldPromote":false, - "shouldReattach":false -} - -Message data: -{ - "message": { - "networkId":"14379272398717627559", - "parentMessageIds": [ - "27782707e4cbf84ca26b3db881bbf39b6429f9ee736a0cbe5a1c177d7a52b05d", - "61cdf92c64a3304bbbabaf9fbfb0ea7ef9624e1eedea68efbe08595ccdf853e1", - "a222d13e3ee51b56b0b0e38140a5f7f813b6d9e29b752d7e1e2424099455080d", - "ab6bca20091b58dcbb0906438a7e47bfb11621c4a37b8d118b565f7f138a40d6" - ], - "payload": { - "type":2, - "index":"484f524e4554205370616d6d6572", - "data":"42696e61727920697320746865206675747572652e0a436f756e743a2031333936393530390a54696d657374616d703a20323032312d30352d33315431353a33363a30392b30323a30300a54697073656c656374696f6e3a203337c2b573" - }, - "nonce":"246736" - }, - "messageId":"30d87fa9917602e5685638e37802bde11b260bd2379f6c850704d7babd365b44" -} -``` - -- `Client.getMessage().metadata()` provides information on how the given message fits to network structures, such as - `ledger_inclusion_state`, etc. -- `Client.getMessage().data()` provides all the data that relates to the given message and its payload(s). diff --git a/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_08_data_message.mdx b/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_08_data_message.mdx deleted file mode 100644 index c1a89e1134e..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_08_data_message.mdx +++ /dev/null @@ -1,30 +0,0 @@ -You can use the -[MessageSender.data(data: string | Uint8Arra)](./../api_reference.md#datadata-messagesender) function -function to attach data to a message. - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/nodejs/examples/08_data_message.js -``` - -**Output example**: - -```json -{ - "message": { - "networkId": "14379272398717627559", - "parentMessageIds": [ - "1a383abbe5f6a6b0899d718975c3119643aa784a68d04075f4e986fd7a0c0e4b", - "6098f889e31911833df7b7839e8b222d701ab496f7dfa1a719087edf4fa7ae52", - "a98b47db4e8254eccc738c968bd35b08a5491e56d6c1a18af298c42bbd8c3a46", - "da6796c0842c08de832c7948fffedc0d5adce372e50a108f26a128dba6096d31" - ], - "payload": { - "type": 2, - "index": "494f54412e52532042494e44494e47202d204e4f44452e4a53", - "data": "736f6d65207574662062617365642064617461" - }, - "nonce": "13835058055282176519" - }, - "messageId": "10f59c101cec669b0a0ba163bc777184c7f63455f5e771d42f910a1ba2ad20ff" -} -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_09_transaction.mdx b/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_09_transaction.mdx deleted file mode 100644 index 4e404afa30a..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_09_transaction.mdx +++ /dev/null @@ -1,11 +0,0 @@ -Sending value-based messages is a very straightforward process if you use the -[`MessageSender`](./../api_reference.md#messagesender) helper class. You will only need to provide a valid -seed by chaining a call to [`.seed(seed: string)`](./../api_reference.md#seedseed-messagesender), and an -output address and amount by chaining a call to -[`.output(address: string, amount: string)`](./../api_reference.md#outputaddress-amount-messagesender). The -method will find valid output(s) that can be used to fund the given amount(s) and the unspent amount will be sent to the -same address. - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/nodejs/examples/09_transaction.js -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_10_mqtt.mdx b/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_10_mqtt.mdx deleted file mode 100644 index c54f2b16854..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_10_mqtt.mdx +++ /dev/null @@ -1,16 +0,0 @@ -You can reach the listener using an instance of a -[`Client.TopicSubscriber`](./../api_reference.md#topicsubscriber) object that is returned from the -[`Client.subscriber()`](./../api_reference.md#subscriber-topicsubscriber) function. It offers several -chaining calls: - -- [`.topic(str)`](./../api_reference.md#topictopic-topicsubscriber) / - [`.topics(str[])`](./../api_reference.md#topicstopic-topicsubscriber): A topic or list of topics that - should trigger a provided callback. -- [`.subscribe(cb)`](./../api_reference.md#subscribecb-topicsubscriber): Subscribes the listener to a callback function that is being triggered every time the given topic(s) - is noticed. -- [`.unsubscribe(cb)`](./../api_reference.md#unsubscribecb-callback-topicsubscriber): Unsubscribes the listener from the given topics. Once unsubscribed, the given callback function is - executed in the form `(err, message) => {}`. - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/nodejs/examples/10_mqtt.js -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_running_examples.mdx b/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_running_examples.mdx deleted file mode 100644 index 6eaa8945c76..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/nodejs/examples/_running_examples.mdx +++ /dev/null @@ -1,14 +0,0 @@ -## Prequisites - -Before you can run the examples, please refer to the [Node.js Getting Started guide](./../../../getting_started/nodejs.md) to install -the library. - -## Run the Examples - -To run any Node.js example, you need to select any of the -[Node.js examples](https://github.com/iotaledger/iota.rs/tree/dev/bindings/nodejs/examples) and run it with your local -Node.js interpreter. The following snippet runs `01_get_info.js` from the project root: - -```bash -node bindings/nodejs/examples/01_get_info.js -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/python/api_reference.md b/docs/build/iota.rs/1.4/docs/libraries/python/api_reference.md deleted file mode 100644 index 5b65a636d65..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/python/api_reference.md +++ /dev/null @@ -1,966 +0,0 @@ ---- -description: Official IOTA Client Library Python API reference. -image: /img/logo/libraries.png -keywords: - - api - - python - - param - - type - - run ---- - -# IOTA Client Python Library API Reference - -Note that in the following APIs, the corresponding exception will be returned if an error occurs. -Also for all the optional values, the default values are the same as the ones in the Rust version. - -### Client - -#### constructor(network (optional), storage (optional), password (optional), polling_interval (optional)): [AccountManager](#accountmanager) - -Creates a new instance of the Client. - -| Param | Type | Default | Description | -| ------------------------------------ | --------------------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [network] | `str` | `undefined` | The network | -| [primary_node_jwt_name_password] | `list[str]` | `undefined` | An array of array with node URLs and optional JWT and basic auth name and password (length 1 is only the url, length 2 is url with JWT, length 3 is url with basic auth name and password and length 4 is url with JWT and basic auth name and password) | -| [primary_pow_node_jwt_name_password] | `list[str]` | `undefined` | An array of array with node URLs and optional JWT and basic auth name and password (length 1 is only the url, length 2 is url with JWT, length 3 is url with basic auth name and password and length 4 is url with JWT and basic auth name and password) | -| [nodes_name_password] | `list[]list[str]` | `undefined` | An array of array with node URLs and optional JWT and basic auth name and password (length 1 is only the url, length 2 is url with JWT, length 3 is url with basic auth name and password and length 4 is url with JWT and basic auth name and password) | -| [permanodes_name_password] | `list[]list[str]` | `undefined` | An array of array with node URLs and optional JWT and basic auth name and password (length 1 is only the url, length 2 is url with JWT, length 3 is url with basic auth name and password and length 4 is url with JWT and basic auth name and password) | -| [node_sync_interval] | `int` | `undefined` | The interval for the node syncing process | -| [node_sync_disabled] | `bool` | `undefined` | Disables the node syncing process. Every node will be considered healthy and ready to use | -| [node_pool_urls] | `str` | `undefined` | An array of node pool URLs | -| [quorum] | `bool` | `false` | Bool to define if quorum should be used | -| [quorum_size] | `int` | `3` | An int that defines how many nodes should be used for quorum | -| [quorum_threshold] | `int` | `66` | Define the % of nodes that need to return the same response to accept it | -| [request_timeout] | `int` | `undefined` | Sets the default HTTP request timeout | -| [api_timeout] | `dict` | `undefined` | The API to set the request timeout. Key: 'GetHealth', 'GetInfo', 'GetPeers', 'GetTips', 'PostMessage', 'GetOutput', 'GetMilestone' Value: timeout in milliseconds | -| [local_pow] | `bool` | `undefined` | Flag determining if PoW should be done locally or remotely | -| [tips_interval] | `int` | `undefined` | Time between requests for new tips during PoW | -| [mqtt_broker_options] | `[BrokerOptions](#brokeroptions)` | `undefined` | Sets the options for the MQTT connection with the node | - -**Returns** The constructed [Client](#client). - -### Full Node APIs - -#### get_health(): bool - -Gets the node health status. - -**Returns** whether the node is healthy. - -#### get_info(): NodeInfoWrapper - -Gets information about the node. - -**Returns** the [NodeInfoWrapper](#nodeinfowrapper). - -#### get_peers(): list[PeerDto] - -Gets peers of the node. - -**Returns** the list of [PeerDto](#peerdto). - -#### get_tips(): list[str] - -Gets non-lazy tips. - -**Returns** two non-lazy tips' message ids in list. - -#### post_message(msg): str - -Submits a message. - -| Param | Type | Default | Description | -| ----- | --------------------- | ----------- | --------------------- | -| [msg] | `[Message](#message)` | `undefined` | The message to submit | - -**Returns** the message id of the submitted message. - -#### get_output(output_id): OutputResponse - -Gets the UTXO outputs associated with the given output id. - -| Param | Type | Default | Description | -| ----------- | ----- | ----------- | ------------------------------ | -| [output_id] | `str` | `undefined` | The id of the output to search | - -**Returns** the OutputResponse[#outputresponse]. - -#### get_address_balance(address): BalanceAddressResponse - -Gets the balance in the address. - -| Param | Type | Default | Description | -| --------- | ----------- | ----------- | ------------------------- | -| [address] | `list[str]` | `undefined` | The address Bech32 string | - -**Returns** the [BalanceAddressResponse](#balanceaddressresponse). - -#### get_address_outputs(address, options (optional)): list[UtxoInput] - -Gets the UTXO outputs associated with the given address. - -| Param | Type | Default | Description | -| --------- | --------------------------------------------------- | ----------- | ------------------------- | -| [address] | `str` | `undefined` | The address Bech32 string | -| [options] | `[[AddressOutputsOptions](#addressoutputsoptions)]` | `undefined` | The query filters | - -**Returns** the list of [UtxoInput](#utxoinput). - -#### find_outputs(output_ids (optional), addresses (optional)): list[OutputResponse] - -Gets the UTXO outputs associated with the given output ids and addresses. - -| Param | Type | Default | Description | -| ------------ | ----------- | ----------- | -------------------------------- | -| [output_ids] | `list[str]` | `undefined` | The list of addresses to search | -| [addresses] | `list[str]` | `undefined` | The list of output ids to search | - -**Returns** the list of [OutputResponse](#outputresponse). - -#### get_milestone(index): MilestoneDto - -Gets the milestone by the given index. - -| Param | Type | Default | Description | -| ------- | ----- | ----------- | -------------------------- | -| [index] | `int` | `undefined` | The index of the milestone | - -**Returns** the [MilestoneDto](#milestonedto). - -#### get_milestone_utxo_changes(index): MilestoneUTXOChanges - -Gets the utxo changes by the given milestone index. - -| Param | Type | Default | Description | -| ------- | ----- | ----------- | -------------------------- | -| [index] | `int` | `undefined` | The index of the milestone | - -**Returns** the [MilestoneUTXOChanges](#milestoneutxochanges). - -#### get_receipts(): Vec - -Get all receipts. - -**Returns** the [ReceiptDto](#receiptdto). - -#### get_receipts_migrated_at(index): Vec - -Get all receipts for a given milestone index. - -| Param | Type | Default | Description | -| ------- | ----- | ----------- | -------------------------- | -| [index] | `int` | `undefined` | The index of the milestone | - -**Returns** the [ReceiptDto](#receiptdto). - -#### get_treasury(): TreasuryResponse - -Get the treasury amount. - -**Returns** the [TreasuryResponse](#treasuryresponse). - -#### get_included_message(): Message - -Get the included message of a transaction. - -| Param | Type | Description | -| ------- | ----- | ------------------------- | -| [index] | `str` | The id of the transaction | - -**Returns** the new [Message](#message). - -### High-Level APIs - -#### message(seed (optional), account_index (optional), initial_address_index (optional), inputs (optional), input_range_begin (optional), input_range_end (optional), outputs (optional), dust_allowance_outputs (optional), index (optional), index_raw (optional), data (optional), data_str (optional), parents (optional)): Message - -Build a message. - -| Param | Type | Default | Description | -| ------------------------ | ------------------------------------------ | ---------------------- | -------------------------------------------- | -| [seed] | `str` | `undefined` | The hex-encoded seed of the account to spend | -| [account_index] | `int` | `undefined` | The account index | -| [initial_address_index] | `int` | `undefined` | The initial address index | -| [inputs] | list[[UtxoInput](#utxoinput)] | undefined | UtxoInputs | -| [input_range_begin] | `int` | `undefined` | The begin index of the input | -| [input_range_end] | `int` | `undefined` | The end index of the input | -| [outputs] | `list[[Output](#output)]` | `undefined` | Outputs | -| [dust_allowance_outputs] | `list[[Output](#output)]` | `undefined` | Dust allowance output to the transaction | -| [index] | `str` | `undefined` | The indexation string | -| [index_raw] | `list[int]` | `undefined` | The indexation byte array | -| [data] | `list[int]` | `undefined` | The data in bytes | -| [data_str] | `str` | `undefined` | The data string | -| [parents] | `list[str]` | `undefined` | The message ids of the parents | - -**Returns** the built [Message](#message). - -#### get_message_metadata(message_id): MessageMetadataResponse - -| Param | Type | Default | Description | -| ------------ | ----- | ----------- | -------------- | -| [message_id] | `str` | `undefined` | The message id | - -**Returns** the [MessageMetadataResponse](#messagemetadataresponse). - -#### get_message_data(message_id): Message - -Gets the message data from the message id. - -| Param | Type | Default | Description | -| ------------ | ----- | ----------- | -------------- | -| [message_id] | `str` | `undefined` | The message id | - -**Returns** the [Message](#message). - -#### get_message_raw(message_id): str - -Gets the raw message string from the message id. - -| Param | Type | Default | Description | -| ------------ | ----- | ----------- | -------------- | -| [message_id] | `str` | `undefined` | The message id | - -**Returns** the raw message string. - -#### get_message_children(message_id): list[str] - -Gets the children of the given message. - -| Param | Type | Default | Description | -| ------------ | ----- | ----------- | -------------- | -| [message_id] | `str` | `undefined` | The message id | - -**Returns** the list of children strings. - -#### get_message_id(payload_str): str - -Get the message id from the payload string. - -| Param | Type | Default | Description | -| ----------- | ----- | ----------- | ---------------------------------------------- | -| payload_str | `str` | `undefined` | The payload string from the mqtt message event | - -**Returns** The identifier of message. - -#### get_message_index(index): list[str] - -Gets the list of message indices from the message_id. - -| Param | Type | Default | Description | -| ------- | ----- | ----------- | ------------------------- | -| [index] | `str` | `undefined` | The identifier of message | - -**Returns** the list of message ids. - -#### find_messages(indexation_keys (optional), message_ids (optional)): list[Message] - -Finds all messages associated with the given indexation keys and message ids. - -| Param | Type | Default | Description | -| ----------------- | ----------- | ----------- | --------------------------------------- | -| [indexation_keys] | `list[str]` | `undefined` | The list of indexations keys too search | -| [message_ids] | `list[str]` | `undefined` | The list of message ids to search | - -**Returns** the list of the found messages. - -#### get_unspent_address(seed, account_index (optional), initial_address_index(optional)): (str, int) - -Gets a valid unspent address. - -| Param | Type | Default | Description | -| ----------------------- | ----- | ----------- | ------------------------------ | -| [seed] | `str` | `undefined` | The hex-encoded seed to search | -| [account_index] | `int` | `undefined` | The account index | -| [initial_address_index] | `int` | `undefined` | The initial address index | - -**Returns** a tuple with type of `(str, int)` as the address and corresponding index in the account. - -#### get_addresses(seed, account_index (optional), input_range_begin (optional), input_range_end (optional) get_all (optional)): list[(str, bool (optional))] - -Finds addresses from the seed regardless of their validity. - -| Param | Type | Default | Description | -| ------------------- | ------ | ----------- | ------------------------------ | -| [seed] | `str` | `undefined` | The hex-encoded seed to search | -| [account_index] | `int` | `undefined` | The account index | -| [input_range_begin] | `int` | `undefined` | The begin of the address range | -| [input_range_end] | `int` | `undefined` | The end of the address range | -| [get_all] | `bool` | `undefined` | Get all addresses | - -**Returns** a list of tuples with type of `(str, int)` as the address and corresponding index in the account. - -#### get_balance(seed, account_index (optional), initial_address_index(optional), gap_limit(optional)): int - -Get balance on a given seed and its wallet account index. - -| Param | Type | Default | Description | -| ----------------------- | ----- | ----------- | ------------------------------ | -| [seed] | `str` | `undefined` | The hex-encoded seed to search | -| [account_index] | `int` | `undefined` | The account index | -| [initial_address_index] | `int` | `undefined` | The initial address index | -| [gap_limit] | `int` | `undefined` | The gap limit | - -**Returns** the amount of balance. - -#### get_address_balances(addresses): list[AddressBalancePair] - -Get the balance in iotas for the given addresses. - -| Param | Type | Default | Description | -| ----------- | ----------- | ----------- | ------------------------------- | -| [addresses] | `list[str]` | `undefined` | The list of addresses to search | - -**Returns** the list of [AddressBalancePair](#addressbalancepair). - -#### generate_mnemonic() - -Returns a random generated Bip39 mnemonic with the English word list. - -**Returns** A String - -#### mnemonic_to_hex_seed(mnemonic) - -Returns the seed hex encoded. - -| Param | Type | Default | Description | -| -------- | ----- | ----------- | ----------------------------------------------------- | -| mnemonic | `str` | `undefined` | Bip39 mnemonic with words from the English word list. | - -**Returns** A String - -#### find_inputs(addresses, amount: u64) - -Return the inputs from addresses for a provided amount (useful for offline signing) - -| Param | Type | Default | Description | -| --------- | ----------- | ----------- | ----------------------- | -| addresses | `list[str]` | `undefined` | The input address list. | -| amount | `str` | `undefined` | The input amount. | - -**Returns** The list of [UtxoInput](#utxoinput). - -#### bech32_to_hex(bech32) - -Returns a parsed hex String from bech32. - -| Param | Type | Default | Description | -| ------ | ----- | ----------- | ------------------------- | -| bech32 | `str` | `undefined` | The address Bech32 string | - -**Returns** A String - -#### hex_to_bech32(hex, bech32_hrp (optional)) - -Returns a parsed bech32 String from hex. - -| Param | Type | Default | Description | -| ---------- | ----- | ----------- | ------------------------- | -| bech32 | `str` | `undefined` | The address Bech32 string | -| bech32_hrp | `str` | `undefined` | The Bech32 hrp string | - -**Returns** A String - -#### hex_public_key_to_bech32_address(hex, bech32_hrp (optional)) - -Returns the bech32 address from the hex public key. - -| Param | Type | Default | Description | -| ---------- | ----- | ----------- | ---------------------- | -| hex | `str` | `undefined` | Hex encoded public key | -| bech32_hrp | `str` | `undefined` | The Bech32 hrp string | - -**Returns** A String - -#### is_address_valid(address): bool - -Checks if a given address is valid. - -| Param | Type | Default | Description | -| ------- | ----- | ----------- | ------------------------- | -| address | `str` | `undefined` | The address Bech32 string | - -**Returns** A boolean. - -#### retry(message_id): (str, Message) - -Retries (promotes or reattaches) the message associated with the given id. - -| Param | Type | Default | Description | -| ------------ | ----- | ----------- | -------------- | -| [message_id] | `str` | `undefined` | The message id | - -**Returns** the message id and the retried [Message](#message). - -#### retry_until_included(message_id, interval (optional), max_attempts (optional)): list[(str, Message)] - -Retries (promotes or reattaches) the message associated with the given id. - -| Param | Type | Default | Description | -| ------------ | ----- | ----------- | ------------------------------------------------------ | -| [message_id] | `str` | `undefined` | The message id | -| interval | `int` | `5` | The interval in seconds in which we retry the message. | -| max_attempts | `int` | `40` | The maximum of attempts we retry the message. | - -**Returns** the message ids and [Message](#message) of reattached messages. - -#### consolidate_funds(seed, account_index, start_index, end_index): str - -Function to consolidate all funds from a range of addresses to the address with the lowest index in that range - -| Param | Type | Description | -| --------------- | ----- | --------------------------------------------------------------------- | -| [seed] | `str` | The seed | -| [account_index] | `int` | The account index. | -| [start_index] | `int` | The lowest address index, funds will be consolidated to this address. | -| [end_index] | `int` | The address index until which funds will be consolidated | - -**Returns** the address to which the funds got consolidated, if any were available. - -#### search_address(seed, bech32_hrp, account_index, start_index, end_index, address): (int, bool) - -Function to find the index and address type of an address - -| Param | Type | Description | -| --------------- | ------------------- | -------------------------------- | -| [seed] | str | The seed | -| [bech32_hrp] | string | The Bech32 HRP | -| [account_index] | int | The account index | -| [start_index] | int | The start address index | -| [end_index] | int | The end address index (excluded) | -| [address] | str | The address Bech32 string | - -**Returns** index and address type of an address. - -#### reattach(message_id): (str, Message) - -Reattaches the message associated with the given id. - -| Param | Type | Default | Description | -| ------------ | ----- | ----------- | -------------- | -| [message_id] | `str` | `undefined` | The message id | - -**Returns** the message id and the reattached [Message](#message). - -#### promote(message_id): (str, Message) - -Promotes the message associated with the given id. - -| Param | Type | Default | Description | -| ------------ | ----- | ----------- | -------------- | -| [message_id] | `str` | `undefined` | The message id | - -**Returns** the message id and the promoted [Message](#message). - -### MQTT APIs - -#### subscribe_topic(topic, callback): void - -Subscribe a topic and assign the associated callback. - -| Param | Type | Default | Description | -| ---------- | ---------- | ----------- | --------------------- | -| [topic] | `str` | `undefined` | The MQTT topic | -| [callback] | `function` | `undefined` | The callback function | - -#### subscribe_topics(topics, callback): void - -Subscribe topics and assign the associated callbacks, respectively. - -| Param | Type | Default | Description | -| ---------- | ----------- | ----------- | ---------------------- | -| [topics] | `list[str]` | `undefined` | The MQTT topics | -| [callback] | `function` | `undefined` | The callback functions | - -#### unsubscribe(): void - -Unsubscribe all topics. - -#### disconnect(): void - -Disconnect the mqtt broker. - -#### WalletAddress - -A dict with the following key/value pairs. - -```python -message_metadata_response = { - 'message_id': str, - 'parent_message_ids': list[str], - 'is_solid': bool, - 'referenced_by_milestone_index': int, # (optional) - 'milestone_index': int, # (optional) - 'ledger_inclusion_state': LedgerInclusionStateDto, # (optional) - 'conflict_reason': int, # (optional) - 'should_promote:' bool # (optional) - 'should_reattach': bool # (optional) -} -``` - -Please refer to [LedgerInclusionStateDto](#ledgerinclusionstatedto) for the details of this type. - -#### BalanceAddressResponse - -A dict with the following key/value pairs. - -```python -balance_for_address_response = { - 'address_type': int, - 'address': str, - 'balance': int -} -``` - -#### AddressBalancePair - -A dict with the following key/value pairs. - -```python -address_balance_pair = { - 'address': str, - 'balance': int - 'dust_allowed': bool -} -``` - -#### MilestoneDto - -A dict with the following key/value pairs. - -```python -milestoned_to = { - 'index': int, - 'timestamp': int, - 'message_id': str -} -``` - -#### MilestoneUTXOChanges - -A dict with the following key/value pairs. - -```python -milestone_utxo_changes = { - 'index': int, - 'created_outputs': list[str], - 'consumed_outputs': list[str] -} -``` - -#### ReceiptDto - -A dict with the following key/value pairs. - -```python -receiptDto = { - 'receipt': Receipt, - 'milestone_index': int, -} -``` - -#### TreasuryResponse - -A dict with the following key/value pairs. - -```python -treasuryResponse = { - 'milestone_id': str, - 'amount': int, -} -``` - -#### UtxoInput - -A dict with the following key/value pairs. - -```python -utxo_input = { - 'transaction_id': list[int], - 'index': int -} -``` - -#### OutputResponse - -A dict with the following key/value pairs. - -```python -output_response = { - 'message_id': str, - 'transaction_id': str, - 'output_index': int, - 'is_spent': bool, - 'output': OutputDto -} -``` - -Please refer to [OutputDto](#outputdto) for the details of this type. - -#### OutputDto - -A dict with the following key/value pairs. - -```python -output_dto = { - 'treasury': TreasuryOutputDto, # (opitonal) - 'signature_locked_single': SignatureLockedSingleOutputDto, # (opitonal) - 'signature_locked_dust_allowance': SignatureLockedDustAllowanceOutputDto # (opitonal) -} -``` - -Please refer to [TreasuryOutputDto](#treasuryoutputdto), [SignatureLockedSingleOutputDto](#signaturelockedsingleoutputdto), and [SignatureLockedDustAllowanceOutputDto](#signaturelockeddustallowanceoutputdto) for the details of these types. - -#### SignatureLockedSingleOutputDto - -A dict with the following key/value pairs. - -```python -signature_locked_single_output_dto = { - 'kind': int, - 'address': AddressDto, - 'amount': int -} -``` - -Please refer to [AddressDto](#addressdto) for the details of this type. - -#### SignatureLockedDustAllowanceOutputDto - -A dict with the following key/value pairs. - -```python -signature_locked_dust_allowance_output_dto = { - 'kind': int, - 'address': AddressDto, - 'amount': int -} -``` - -Please refer to [AddressDto](#addressdto) for the details of this type. - -#### pub struct TreasuryOutputDto { - -A dict with the following key/value pairs. - -```python -treasury_output_dto = { - 'kind': int, - 'amount':int -} -``` - -#### AddressDto - -A dict with the following key/value pairs. - -```python -address_dto = { - 'ed25519': Ed25519AddressDto -} -``` - -Please refer to [Ed25519AddressDto](#ed25519addressdto) for the details of this type. - -#### Ed25519AddressDto - -A dict with the following key/value pairs. - -```python -ed25519_address_dto = { - 'kind': int, - 'address': str -} -``` - -#### Message - -A dict with the following key/value pairs. - -```python -message = { - 'message_id': str, - 'network_id': int, - 'parents': list[str], - 'payload': Payload, # (optional) - 'nonce': int -} -``` - -Please refer to [Payload](#payload) for the details of this type. - -#### Payload - -A dict with the following key/value pairs. - -```python -payload = { - 'transaction': list[Transaction], # (optional) - 'milestone': list[Milestone], # (optional) - 'indexation': list[Indexation], # (optional) -} -``` - -Please refer to [Transaction](#transaction), [Milestone](#milestone), and [Indexation](#indexation) for the details of these types. - -#### Transaction - -A dict with the following key/value pairs. - -```python -transaction = { - 'essence': RegularEssence, - 'unlock_blocks': list[UnlockBlock] -} -``` - -Please refer to [RegularEssence](#regularessence), and [UnlockBlock](#unlockblock) for the details of these types. - -#### Milestone - -A dict with the following key/value pairs. - -```python -milestone = { - 'essence': MilestonePayloadEssence, - 'signatures': list[list[int]] -} -``` - -Please refer to [MilestonePayloadEssence](#milestonepayloadessence) for the details of this type. - -#### MilestonePayloadEssence - -A dict with the following key/value pairs. - -```python -milestone_payload_essence = { - 'index': int, - 'timestamp': int, - 'parents': list[str], - 'merkle_proof': list[int], - 'next_pow_score': int, - 'next_pow_score_milestone_index': int, - 'public_keys': list[list[int]] -} -``` - -#### Indexation - -A dict with the following key/value pairs. - -```python -indexation = { - 'index': str, - 'data': list[int] -} -``` - -#### RegularEssence - -A dict with the following key/value pairs. - -```python -regular_essence = { - 'inputs': list[Input], - 'outputs': list[Output], - 'payload': list[Payload] -} -``` - -Please refer to [Input](#input), [Output](#output), and [Payload](#payload) for the details of these types. - -#### Output - -A dict with the following key/value pairs. - -```python -output = { - 'address': str, - 'amount': int -} -``` - -#### Input - -A dict with the following key/value pairs. - -```python -input = { - 'transaction_id': str, - 'index': int -} -``` - -#### UnlockBlock - -A dict with the following key/value pairs. - -```python -unlock_block = { - 'signature': Ed25519Signature, # (optional) - 'reference': int # (optional) -} -``` - -Please refer to [Ed25519Signature](#ed25519signature) for the details of this type. - -#### Ed25519Signature - -A dict with the following key/value pairs. - -```python -ed25519_signature = { - 'public_key': list[int], - 'signature': list[int] -} -``` - -#### BrokerOptions - -A dict with the following key/value pairs. - -```python -broker_options = { - 'automatic_disconnect': bool, - 'timeout': int, - 'max_reconnection_attempts': int, -} -``` - -#### LedgerInclusionStateDto - -A dict with the following key/value pairs. - -```python -ledger_inclusion_state_dto = { - 'state': str -} -``` - -#### NodeInfoWrapper - -A dict with the following key/value pairs. - -```python -nodeinfo_wrapper{ - url: str, - nodeinfo: info_response, -} -info_response = { - 'name': str, - 'version': str, - 'is_healthy': bool, - 'network_id': str, - 'bech32_hrp': str, - 'min_pow_score': float, - 'messages_per_second': float, - 'referenced_messages_per_second': float, - 'referenced_rate': float, - 'latest_milestone_timestamp': u64, - 'latest_milestone_index': int, - 'confirmed_milestone_index': int, - 'pruning_index': int, - 'features': list[str], - 'min_pow_score': float, -} -``` - -#### NetworkInfo - -A dict with the following key/value pairs. - -```python -network_info = { - 'network': str, - 'network_id': int, - 'bech32_hrp': str, - 'min_pow_score': float, - 'local_pow': bool, - 'tips_interval': int, -} -``` - -#### PeerDto - -A dict with the following key/value pairs. - -```python -peer_dto = { - 'id': str, - 'multi_addresses': list[str], - 'alias': str, # (optional) - 'relation': RelationDto, - 'connected': bool, - 'gossip': GossipDto, # (optional) -} -``` - -Please refer to [RelationDto](#relationdto) and [GossipDto](#gossipdto) for the details of these types. - -#### RelationDto - -A dict with the following key/value pairs. - -```python -relation_dto = { - 'relation': str -} -``` - -#### GossipDto - -A dict with the following key/value pairs. - -```python -gossip_dto = { - 'heartbeat': HeartbeatDto, - 'metrics': MetricsDto -} -``` - -Please refer to [HeartbeatDto](#heartbeatdto) and [MetricsDto](#metricsdto) for the details of these types. - -#### HeartbeatDto - -A dict with the following key/value pairs. - -```python -heart_beat_dto = { - 'solid_milestone_index': int, - 'pruned_milestone_index': int, - 'latest_milestone_index': int, - 'connected_neighbors': int, - 'synced_neighbors': int -} -``` - -#### MetricsDto - -A dict with the following key/value pairs. - -```python -metrics_dto = { - 'received_messages': int, - 'known_messages': int, - 'received_message_requests': int, - 'received_milestone_requests': int, - 'received_heartbeats': int, - 'sent_messages': int, - 'sent_message_requests': int, - 'sent_milestone_requests': int, - 'sent_heartbeats': int, - 'dropped_packets': int, -} -``` - -#### AddressOutputsOptions - -A dict with the following key/value pairs. - -```python -options = { - 'include_spent': bool, - 'output_type': string -} -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/python/examples/_01_get_info.mdx b/docs/build/iota.rs/1.4/docs/libraries/python/examples/_01_get_info.mdx deleted file mode 100644 index bbb8241e5f8..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/python/examples/_01_get_info.mdx +++ /dev/null @@ -1,30 +0,0 @@ -import LoadBalancerHealthChecks from '../../../_admonitions/_load_balancer_health_checks.md'; -import GetInfoOutput from '../../../_partials/examples/01_get_info/outputs/snake_case.md'; -import ClientBuilder from '../../../_partials/examples/01_get_info/_client_builder.md'; - -```python reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/python/examples/01_get_info.py -``` - -**Output example** of the `get_info()` function of the `Client` class: - - - - - -The `Client` class constructor provides several parameters via which the process can be closely managed. - -The most common ones are: - -- `network`: Can be either `devnet` or `mainnet`. It instructs the library whether to automatically select devnet - nodes or mainnet nodes. -- `node`: Specify address of actual running IOTA node that should be used to communicate with in the format - `https://node:port`). For example: `https://api.lb-0.h.chrysalis-devnet.iota.cafe:443`. -- `node_pool_urls`: The library also supports managing a pool of nodes. You can provide a list of nodes and the - library manages the access to them automatically by selecting them based on their sync status. If you provide - `node_pool_urls`, then the library periodically will periodically check whether node is in sync or not by calling - `.node_sync_interval`. -- `local_pow`: If `local_pow==True` (default value) a Proof-of-work will be done locally and not remotely. -- `node_sync_disabled`: When called, the library will use nodes that are **not** in sync with network. This - parameter is usually useful if you would like to interact with a local test node that is not fully synced. **This - parameter should not be used in production**. diff --git a/docs/build/iota.rs/1.4/docs/libraries/python/examples/_02_generate_seed.mdx b/docs/build/iota.rs/1.4/docs/libraries/python/examples/_02_generate_seed.mdx deleted file mode 100644 index a3ed10a3777..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/python/examples/_02_generate_seed.mdx +++ /dev/null @@ -1,6 +0,0 @@ -You can generate a seed, for example, using SHA256 algorithm on some random input generated by cryptographically secure -pseudo-random generator, such as `os.urandom()`: - -```python reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/python/examples/02_generate_seed.py -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/python/examples/_03_generate_addresses.mdx b/docs/build/iota.rs/1.4/docs/libraries/python/examples/_03_generate_addresses.mdx deleted file mode 100644 index c4ccd235484..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/python/examples/_03_generate_addresses.mdx +++ /dev/null @@ -1,55 +0,0 @@ -You can generate an IOTA address using the -[`Client.get_addresses()`](./../api_reference.md##get_addressesseed-account_index-optional-input_range_begin-optional-input_range_end-optional-get_all-optional-liststr-bool-optional) -function that will return a list of tuples with the generated addresses. You can find more information on the -parameters in the [Address/Key Space section](../../../explanations/address_key_space.md). - -The whole process is deterministic. This means the output is the same as long as the seed is the same: - -```python reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/python/examples/03_generate_addresses.py -``` - -**Output example**: - -```string -[('atoi1qp9427varyc05py79ajku89xarfgkj74tpel5egr9y7xu3wpfc4lkpx0l86', False), - ('atoi1qzfvkkp398v7hhvu89fu88hxctf7snwc9sf3a3nd7msfv77jk7qk2ah07s3', True), - ('atoi1qq4t98j5y8wxkaujue99mjwqcp6jvvmsd5lv0755sz7dtjdz3p2lydv76sy', False), - ('atoi1qrhzhjxc4z8vpwjt3hafs5xpdng5katqe890p0h95mc0l273j8yzxn7r4hc', True), - ('atoi1qputu0yvfvxd7g39wf4rc67e0f0dyhl6enxu9jxnsrjqmemh067tw7qelyc', False), - ('atoi1qptg5w2x47qwjf3gpqt3h7d2ey5x7xf8v7qtt29gkxt4mjfjfc28sutvd8a', True), - ('atoi1qprvelq9paakh72fgm6j2kf8kexadw3t5xljer9dpsep5c7wx5mjwdxch6z', False), - ('atoi1qrwk37tz47ddng9kpxfflkpz5tplcq7ll56v4acam04307xk70l7uf6wg8j', True), - ('atoi1qper3zr5xe9x0wqs35ytwh622870g44frkyygdhs0ds8yejle3xujhq7dx3', False), - ('atoi1qq6lkr9hucfylqjaqphu0stvk8pcmsx98r7ukuq40asszwmqytlnc058thk', True), - ('atoi1qzpn7se3ryhscmqg404pycxzvfpt8v4xn8aul0tqdh00xsncgnxu7na7zjj', False), - ('atoi1qz4qqakty9qytw8fk9shelt9lwlvv83s5ggt3wjag9fkgcc74z78w4l86y5', True), - ('atoi1qp20uddchglqry0l5qnjg5aln8d5rk2v5l45hwrxv9z0daxs7u6xcsh4077', False), - ('atoi1qrlqm2u5txxxnjx22fxq0jfjzk6l4nwnue6ht5pepk65m2f4xmxqynmxu2m', True), - ('atoi1qqydc70mpjdvl8l2wyseaseqwzhmedzzxrn4l9g2c8wdcsmhldz0ulwjxpz', False), - ('atoi1qrkjennxyl2xcqem6x69ya65sasma33z0ux872k846lqft0s3qf7k6lqpft', True), - ('atoi1qr4yuekp30ff7mnnnjwy9tdhynxmlmkpuxf70qurtwudp2zpf3jeyw4uh37', False), - ('atoi1qp6m5sz5ayjtccfxapdk5lp4qkheyfg0emzntmulyxzftps730vcul8dmqr', True), - ('atoi1qzrwhkzhu67fqltfffwljejawdcghedukpgu9x6tzevwlnq89gmfjtayhgz', False), - ('atoi1qpehxcp24z947dgupjqc9ktkn5ylmdxqqnx83m7xlajnf8005756u4n7z77', True)] -``` - -- Each tuple contains `address` and `bool` value indicating if the address is a `change` address or not. `True` - means the address is a change address (internal). There are two independent sets of addresses (10 items per each). -- This behavior is controlled by the `get_all` argument. `get_all=False` (default) generates only public addresses. - -IOTA addresses are represented by a checksumed base-32 string (Bech32). You can find a detailed explanation in the -[Chrysalis documentations](/introduction/reference/details#iota-15-address-anatomym), but here are -parts relevant to this example: - -- If an address starts with `atoi` then it means it is related to `devnet`. `iota` stands for `mainnet`. -- Number `1` at the 5th position is just a separator. -- The last 6 characters are reserved for a checksum. - -Addresses can be also represented in a hex format and `iota.rs` provides some convenient functions to convert addresses: -[`Client.bech32_to_hex()`](./../api_reference.md#bech32_to_hexbech32) and -[`Client.hex_to_bech32()`](./../api_reference.md#hex_to_bech32hex-bech32_hrp-optional). - -If you want to quickly validate any IOTA address, you can use the -[`Client.is_address_valid()`](./../api_reference.md#is_address_validaddress-bool) function that returns a -`bool` value. You should perform a sanity check on address before using it. diff --git a/docs/build/iota.rs/1.4/docs/libraries/python/examples/_04_get_balance.mdx b/docs/build/iota.rs/1.4/docs/libraries/python/examples/_04_get_balance.mdx deleted file mode 100644 index 2948c2767c6..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/python/examples/_04_get_balance.mdx +++ /dev/null @@ -1,37 +0,0 @@ -There are three common API calls you can use to get a balance: - -## [`Client.get_address_balance(address: str)`](./../api_reference.md#get_address_balanceaddress-balanceaddressresponse) - -Expects a single address in Bech32 format and returns `dict` with a balance for the address. - -## [`Client.get_address_balances(addresses: list[str])`](./../api_reference.md#get_address_balancesaddresses-listaddressbalancepair) - -A convenient function that expects `list` of addresses in Bech32 format and returns list of `dict` with balances for all given addresses - -## [`Client.get_balance(seed, account_index (optional), initial_address_index(optional), gap_limit(optional))`](./../api_reference.md#get_balanceseed-account_index-optional-initial_address_indexoptional-gap_limitoptional-int) - -A convenient function that combines `Client.get_addresses()` and `Client.get_address_balances()` api calls. It returns a combined balance for the provided `seed` and optional chaining calls `.accountIndex(index)`, `.initialAddressIndex(index)` and `.gapLimit(amount)` - -`Client.get_balance(seed)` performs several tasks under the hood. It starts by generating addresses for the provided -`seed` and `account_index` from `initial_address_index`, and checks for a balance of each of the generated -addresses. Since it does not know how many addresses are used in fact, there is a condition set by the -`gap_limit` argument to know when to stop searching. If the `gap_limit` amount of addresses in a row have no -balance, the function returns results and stops searching. - -```python reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/python/examples/04_get_balance.py -``` - -Example of output: - -```json -{ - "address":"atoi1qp9427varyc05py79ajku89xarfgkj74tpel5egr9y7xu3wpfc4lkpx0l86", - "balance":10000000, - "dustAllowed":false -} -Account balance: 0 -``` - -- `dustAllowed` indicates whether the given address is allowed to accept a dust due to - [dust protection mechanism](/introduction/explanations/faq#what-is-dust-protection-and-how-does-it-work). diff --git a/docs/build/iota.rs/1.4/docs/libraries/python/examples/_05_get_outputs.mdx b/docs/build/iota.rs/1.4/docs/libraries/python/examples/_05_get_outputs.mdx deleted file mode 100644 index fa93b9ad5ee..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/python/examples/_05_get_outputs.mdx +++ /dev/null @@ -1,97 +0,0 @@ -- [`Client.get_address_outputs(str)`](#clientget_address_outputsaddress-options-optionall) -- [`Client.get_output(str)`](#clientget_outputoutput_id) -- [`Client.find_outputs(output_ids (optional), addresses (optional))`](#clientfind_outputsoutput_ids-optional-addresses-optional) - -## Client.get_address_outputs(address, options (optional)) - -The [`Client.get_address_outputs(str)`](./../api_reference.md#get_address_outputsaddress-options-optional-listutxoinput) function expects an address in Bech32 format and returns a `str[]` of -`output_ids`. - -```python reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/python/examples/05a_get_address_outputs.py -``` - -**Output example**: - -```plaintext -Output index: 0; raw transaction id: [162, 44, 186, 6, 103, 201, 34, 203, 177, 248, 189, 202, 249, 112, 178, 168, 129, 204, 214, 232, 142, 47, 204, 229, 3, 116, 222, 42, 172, 124, 55, 114] -`output_id` encoded in hex: a22cba0667c922cbb1f8bdcaf970b2a881ccd6e88e2fcce50374de2aac7c37720000 -``` - -- The `UTXO` output is represented by output `index` and `transaction_id`. `transaction_id` is basically a list of 32 - `bytes`. `index` is 2-bytes (16bits) `uint`. -- The `index` and `transaction_id` are usually combined into single hex string of 68 characters = 32 \* 2 chars - (`transaction_id`; 32 bytes in hex) + 4 chars (`index`; 2 bytes in hex). - -The resulting `output_id` is the unique id of the given `output`. - -## Client.get_output(output_id) - -You can use the [`Client.get_output(output_id)`](./../api_reference.md#get_outputoutput_id-outputresponse) function to get metadata about the an `output_id`: - -```python reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/python/examples/05b_get_output.py -``` - -**Output example**: - -```json -{ - "message_id": "f303bc90a5ed3ef15af5fc6aa81a739978c59458a71e68ce8e380f1f534da1e6", - "transaction_id": "0f2d5d2651f8061a9f5417d0658009f32b2e3f77f9706b0be3b4b3f466171f36", - "output_index": 0, - "is_spent": false, - "address": "atoi1qzt0nhsf38nh6rs4p6zs5knqp6psgha9wsv74uajqgjmwc75ugupx3y7x0r", - "amount": 1000000 -} -``` - -## Client.find_outputs(output_ids (optional), addresses (optional)) - -The function [`Client.find_outputs(output_ids (optional), addresses (optional))`](./../api_reference.md#find_outputsoutput_ids-optional-addresses-optional-listoutputresponse) is a convenient shortcut combining both -`Client.get_address_outputs(str)` and `Client.get_output(str)` methods in a single call. It supports two arguments, a -list of `output_ids` or a list of `addresses`. - -```python reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/python/examples/05c_find_outputs.py -``` - -**Output example**: - -```json -[ - { - "message_id": "f303bc90a5ed3ef15af5fc6aa81a739978c59458a71e68ce8e380f1f534da1e6", - "transaction_id": "0f2d5d2651f8061a9f5417d0658009f32b2e3f77f9706b0be3b4b3f466171f36", - "output_index": 0, - "is_spent": false, - "address": "atoi1qzt0nhsf38nh6rs4p6zs5knqp6psgha9wsv74uajqgjmwc75ugupx3y7x0r", - "amount": 1000000 - }, - { - "message_id": "825266a79c0ffb6001ed263eb150357863b7d0052627c5766e8ef5acd6fed533", - "transaction_id": "768c20c15a290e02a43b83263a98501b9d7eb0b57da40a9247289c672de63ea6", - "output_index": 0, - "is_spent": false, - "address": "atoi1qzt0nhsf38nh6rs4p6zs5knqp6psgha9wsv74uajqgjmwc75ugupx3y7x0r", - "amount": 1000000 - } -] -``` - -- `message_id`: Refers to the encapsulating message in which the transaction was sent. -- `transaction_id`, `output_index`: Refers to the output within the `SignedTransaction` payload. There may be several - `outputs` involved in a single transaction, so the `transaction_id` by itself would not be enough. -- `output`: This section provides details about the iota address to which the given - [unspent transaction output](../../../explanations/messages_payloads_and_transactions.md#unspent-transaction-output-utxo) - is coupled with. -- `amount`: States an amount of tokens related to the `output`. -- `is_spent`: Indicates whether the given `output` is a part of the actual _ledger state_ or not. As mentioned in the - [Messages, Payloads, and Transactions section](../../../explanations/messages_payloads_and_transactions.md#unspent-transaction-output-utxo), - if an output was already spent it is not part of the ledger state any more and is replaced by some other `output(s)` - in the process. - -Notice that the `output_id` that was used in a function call to get output details is the same as a combination of the -`transaction_id` and `output index`. This way a transaction is tightly coupled with `outputs` since the -`SignedTransaction` payload is a main vehicle to create and spend `outputs`, and everything is encapsulated in a -[`message`](../../../explanations/messages_payloads_and_transactions.md#messages). diff --git a/docs/build/iota.rs/1.4/docs/libraries/python/examples/_06_simple_message.mdx b/docs/build/iota.rs/1.4/docs/libraries/python/examples/_06_simple_message.mdx deleted file mode 100644 index 86e1722bd14..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/python/examples/_06_simple_message.mdx +++ /dev/null @@ -1,30 +0,0 @@ -You can use the -[`Client.message()`](./../api_reference.md#messageseed-optional-account_index-optional-initial_address_index-optional-inputs-optional-input_range_begin-optional-input_range_end-optional-outputs-optional-dust_allowance_outputs-optional-index-optional-index_raw-optional-data-optional-data_str-optional-parents-optional-message) -function to prepare a message instance and send it over a network. It accepts wide range of input parameters and can -help with any kind of message type you want to broadcast. - -```python reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/python/examples/06_simple_message.py -``` - -**Output example**: - -```string -{ - "message_id":"e2daa4c6b012b615becd6c12189b2c9e701ba0d53b31a15425b21af5105fc086", - "network_id":7712883261355838377, - "parents":[ - "0e2705ce50fec88f896663d4b7d562e74cbcfdd951ac482b1f03cfa5f27396d7", - "0f5a0b2041766127c3f3bff2dd653b450b72e364765fcc805a40423c59ed01f9", - "20635b30aee437575d7e6abdf6629eec80543bee30848b0abdda2200fc11a977", - "da97cd6cfcbb854b8fd3f064c8459c5c9eae80dbd5ef594a3e1a26dcb8fc078c" - ], - "payload":"None", - "nonce":2305843009213869242 -} -``` - -- `message_id` is a unique id that refers to the given message in the network. -- Every message in the Tangle should refer to up to 8 other messages. These are indicated in the `parents` section. -- No actual `payload` was given in this example message (`payload=None`). -- `nonce` refer to a result of proof-of-work. diff --git a/docs/build/iota.rs/1.4/docs/libraries/python/examples/_07_get_message_data.mdx b/docs/build/iota.rs/1.4/docs/libraries/python/examples/_07_get_message_data.mdx deleted file mode 100644 index 7bdfd66b299..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/python/examples/_07_get_message_data.mdx +++ /dev/null @@ -1,50 +0,0 @@ -Once a [message](../../../explanations/messages_payloads_and_transactions.md) is broadcast, you can use the -[`Client.get_message_data(message_id: str)`](./../api_reference.md#get_message_datamessage_id-message) and -[`Client.get_message_metadata()`](./../api_reference.md#get_message_metadatamessage_id-messagemetadataresponse) -functions used to get all the information about the message from the Tangle. - -```python reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/python/examples/07_get_message_data.py -``` - -Output example: - -```json -Message meta data: -{ - "message_id":"e2daa4c6b012b615becd6c12189b2c9e701ba0d53b31a15425b21af5105fc086", - "parent_message_ids":[ - "0e2705ce50fec88f896663d4b7d562e74cbcfdd951ac482b1f03cfa5f27396d7", - "0f5a0b2041766127c3f3bff2dd653b450b72e364765fcc805a40423c59ed01f9", - "20635b30aee437575d7e6abdf6629eec80543bee30848b0abdda2200fc11a977", - "da97cd6cfcbb854b8fd3f064c8459c5c9eae80dbd5ef594a3e1a26dcb8fc078c" - ], - "is_solid":true, - "referenced_by_milestone_index":284866, - "milestone_index":"None", - "ledger_inclusion_state":{ - "state":"NoTransaction" - }, - "conflict_reason":"None", - "should_promote":"None", - "should_reattach":"None" -} - -Message data: -{ - "message_id":"e2daa4c6b012b615becd6c12189b2c9e701ba0d53b31a15425b21af5105fc086", - "network_id":7712883261355838377, - "parents":[ - "0e2705ce50fec88f896663d4b7d562e74cbcfdd951ac482b1f03cfa5f27396d7", - "0f5a0b2041766127c3f3bff2dd653b450b72e364765fcc805a40423c59ed01f9", - "20635b30aee437575d7e6abdf6629eec80543bee30848b0abdda2200fc11a977", - "da97cd6cfcbb854b8fd3f064c8459c5c9eae80dbd5ef594a3e1a26dcb8fc078c" - ], - "payload":"None", - "nonce":2305843009213869242 -} -``` - -- `Client.get_message_metadata` provides information on how the given message fits to network structures such as - `ledger_inclusion_state`. -- `Client.get_message_data` provides all the data that relates to the message and its payload(s) diff --git a/docs/build/iota.rs/1.4/docs/libraries/python/examples/_08_data_message.mdx b/docs/build/iota.rs/1.4/docs/libraries/python/examples/_08_data_message.mdx deleted file mode 100644 index d7ef9a09e86..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/python/examples/_08_data_message.mdx +++ /dev/null @@ -1,38 +0,0 @@ -You can use the `data` parameter in the -[`Client.message()`](./../api_reference.md#messageseed-optional-account_index-optional-initial_address_index-optional-inputs-optional-input_range_begin-optional-input_range_end-optional-outputs-optional-dust_allowance_outputs-optional-index-optional-index_raw-optional-data-optional-data_str-optional-parents-optional-message) -function to attach data to a message. - -```python reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/python/examples/08_data_message.py -``` - -**Output example**: - -```json -{ - "message_id": "8d4fa37be3c00691131c2c3e03e7b8b956c9118a2ce4be3a8597d51d82ed2de9", - "network_id": 7712883261355838377, - "parents": [ - "3719d308ae14b7ef1ed5a3a1604228e97587b9da487db10bc6e4a4f800083da0", - "4431e2f776db888488728e0aa34c94975e65d6fa74893aa675172af6b9f37257", - "8f9fa84954c58bcfc9acc33ca827b4ea35c2caae88db736399a031120e85eebf", - "f63d416de97e6a9fd1314fbbbbb263f30dff260f3075f9a65e7dfe1f2cc56ce3" - ], - "payload": { - "transaction": "None", - "milestone": "None", - "indexation": [ - { - "index": "736f6d655f646174615f696e646578", - "data": [ - 115, 111, 109, 101, 32, 117, 116, 102, 32, 98, 97, 115, 101, 100, 32, - 100, 97, 116, 97 - ] - } - ], - "receipt": "None", - "treasury_transaction": "None" - }, - "nonce": 6917529027641573188 -} -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/python/examples/_09_transaction.mdx b/docs/build/iota.rs/1.4/docs/libraries/python/examples/_09_transaction.mdx deleted file mode 100644 index 81620997ab9..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/python/examples/_09_transaction.mdx +++ /dev/null @@ -1,9 +0,0 @@ -Sending value-based messages is a very straightforward process. You will only need to provide a valid `seed`, `outputs` -(addresses and amounts) parameters to the -[Client.message()](./../api_reference.md#messageseed-optional-account_index-optional-initial_address_index-optional-inputs-optional-input_range_begin-optional-input_range_end-optional-outputs-optional-dust_allowance_outputs-optional-index-optional-index_raw-optional-data-optional-data_str-optional-parents-optional-message) -function. The method will find valid output(s) that can be used to fund the given amount(s) and the remaining amount will -be sent back the input address. - -```python reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/python/examples/09_transaction.py -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/python/examples/_10_mqtt.mdx b/docs/build/iota.rs/1.4/docs/libraries/python/examples/_10_mqtt.mdx deleted file mode 100644 index 7ab51d51e13..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/python/examples/_10_mqtt.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```python reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/python/examples/10_mqtt.py -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/python/examples/_running_examples.mdx b/docs/build/iota.rs/1.4/docs/libraries/python/examples/_running_examples.mdx deleted file mode 100644 index 8bdf0a3a0b7..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/python/examples/_running_examples.mdx +++ /dev/null @@ -1,14 +0,0 @@ -## Prequisites - -Before you can run the examples, please refer to the [Python Getting Started guide](./../../../getting_started/python.mdx) to install -the library. - -## Run the Examples - -To run any Python example you need to select any of the -[Python examples](https://github.com/iotaledger/iota.rs/tree/dev/bindings/python/examples) and run it with your local -python interpreter. The following snippet runs `01_get_info.py` from the project root: - -```bash -python bindings/python/examples/01_get_info.py -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/rust/api_reference.md b/docs/build/iota.rs/1.4/docs/libraries/rust/api_reference.md deleted file mode 100644 index 3c1f8c9c35f..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/rust/api_reference.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -description: Official IOTA Client Library Rust API reference. -image: /img/logo/libraries.png -keywords: - - api - - rust - - cargo - - crate - - reference ---- - -# API Reference - -API reference - -You can find the [API reference](https://docs.rs/iota-client) in [docs.rs](https://docs.rs/), or generate it yourself. - -If you would like to explore the implementation in more depth, the following command generates docs for the whole crate, including private modules: - -```bash -cargo doc --document-private-items --no-deps --open -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_01_get_info.mdx b/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_01_get_info.mdx deleted file mode 100644 index 7215e501b3c..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_01_get_info.mdx +++ /dev/null @@ -1,31 +0,0 @@ -import LoadBalancerHealthChecks from '../../../_admonitions/_load_balancer_health_checks.md'; -import GetInfoOutput from '../../../_partials/examples/01_get_info/outputs/snake_case.md'; -import ClientBuilder from '../../../_partials/examples/01_get_info/_client_builder.md'; - -```rust reference -https://github.com/iotaledger/iota.rs/tree/production/examples/01_get_info.rs -``` - -**Output example** of the `get_info()` function of the `Client` instance: - - - - - - - -The most common ones are: - -- `.with_network(self, network: &str)`: Can be either `devnet` or `mainnet`. It instructs - the library whether to automatically select devnet nodes or mainnet nodes. -- `.with_node.(self, url: &str)`: Specify address of actual running IOTA node that should be used - to communicate with in the format `https://node:port`). For example: `https://api.lb-0.h.chrysalis-devnet.iota.cafe:443`. -- `.with_node_pool_urls(self, node_pool_urls: &[String])`: The library also supports managing a pool of - nodes. You can provide a list of nodes and the library manages the access to them automatically by selecting them based - on their sync status. If you provide `.node_pool_urls(urls)`, then the library periodically will periodically check whether node is in sync or - not by calling `.with_node_sync_interval(self, node_sync_interval: Duration)`. -- `.with_local_pow(self, local: bool)`: If `.with_local_pow(True)` a Proof-of-work will be done - locally and not remotely. -- `. with_node_sync_disabled(self)`: When called, the library will use nodes that - are **not** in sync with network. This parameter is usually useful if you would like to interact with a local test node - that is not fully synced. **This parameter should not be used in production**. diff --git a/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_02_generate_seed.mdx b/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_02_generate_seed.mdx deleted file mode 100644 index d563e3ae78a..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_02_generate_seed.mdx +++ /dev/null @@ -1,6 +0,0 @@ -You can generate a seed, for example, using the SHA256 algorithm on some random input generated by a cryptographically -secure pseudo-random generator, such as `SecretKey::generate()`: - -```rust reference - https://github.com/iotaledger/iota.rs/tree/production/examples/02_generate_seed.rs -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_03_generate_addresses.mdx b/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_03_generate_addresses.mdx deleted file mode 100644 index 19ae965df79..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_03_generate_addresses.mdx +++ /dev/null @@ -1,59 +0,0 @@ -You can generate IOTA addresses calling the -[`Client.get_addresses()`](https://docs.rs/iota-client/latest/iota_client/client/struct.Client.html#method.get_addresses) -function and respective chaining calls that will return a list of tuples with the generated addresses. You can find -more information on the parameters in the [Address/Key Space section](../../../explanations/address_key_space.md). - -The whole process is deterministic. This means the output is the same as long as the seed is the same: - -```rust reference -https://github.com/iotaledger/iota.rs/tree/production/examples/03_generate_addresses.rs -``` - -**Output example**: - -```palintext -List of generated public addresses: -[ -"atoi1qzt0nhsf38nh6rs4p6zs5knqp6psgha9wsv74uajqgjmwc75ugupx3y7x0r", -"atoi1qpnrumvaex24dy0duulp4q07lpa00w20ze6jfd0xly422kdcjxzakzsz5kf", -"atoi1qz4sfmp605vnj6fxt0sf0cwclffw5hpxjqkf6fthyd74r9nmmu337m3lwl2", -...] - -List of generated public addresses: -[ -"atoi1qzt0nhsf38nh6rs4p6zs5knqp6psgha9wsv74uajqgjmwc75ugupx3y7x0r", -"atoi1qpnrumvaex24dy0duulp4q07lpa00w20ze6jfd0xly422kdcjxzakzsz5kf", -"atoi1qz4sfmp605vnj6fxt0sf0cwclffw5hpxjqkf6fthyd74r9nmmu337m3lwl2", -...] - -List of generated public and internal addresses: -[ -("atoi1qzt0nhsf38nh6rs4p6zs5knqp6psgha9wsv74uajqgjmwc75ugupx3y7x0r", false), -("atoi1qprxpfvaz2peggq6f8k9cj8zfsxuw69e4nszjyv5kuf8yt70t2847shpjak", true), -("atoi1qpnrumvaex24dy0duulp4q07lpa00w20ze6jfd0xly422kdcjxzakzsz5kf", false), -...] - -List of offline generated public addresses: -["atoi1qzt0nhsf38nh6rs4p6zs5knqp6psgha9wsv74uajqgjmwc75ugupx3y7x0r", -"atoi1qpnrumvaex24dy0duulp4q07lpa00w20ze6jfd0xly422kdcjxzakzsz5kf", -"atoi1qz4sfmp605vnj6fxt0sf0cwclffw5hpxjqkf6fthyd74r9nmmu337m3lwl2", -...] - - -``` - -IOTA addresses are represented by a checksumed base-32 string (Bech32). You can find a detailed explanation in the -[Chrysalis documentations](/introduction/reference/details#iota-15-address-anatomym), but here are -parts relevant to this example: - -- If an address starts with `atoi` then it means it is related to `devnet`. `iota` stands for `mainnet`. -- Number `1` at the 5th position is just a separator. -- The last 6 characters are reserved for a checksum. - -Addresses can be also represented in a hex format and `iota.rs` provides some convenient functions to convert addresses: -[`Client.bech32ToHex(bech32)`](https://docs.rs/iota-client/latest/iota_client/client/struct.Client.html#method.bech32_to_hex) -and [`Client.hex_to_bech32(hex, bech32_hrp (optional))`](https://docs.rs/iota-client/latest/iota_client/client/struct.Client.html#method.hex_to_bech32). - -If you want to quickly validate any IOTA address, you can use the -[`Client.is_address_valid()`](https://docs.rs/iota-client/latest/iota_client/client/struct.Client.html#method.is_address_valid) -function that returns a `bool` value. You should perform a sanity check on address before using it. diff --git a/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_04_get_balance.mdx b/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_04_get_balance.mdx deleted file mode 100644 index 853ae4958bf..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_04_get_balance.mdx +++ /dev/null @@ -1,58 +0,0 @@ -There are several API calls you can use to get a balance: - -## [`Client. get_address_balances(addresses: &[String])`](https://docs.rs/iota-client/latest/iota_client/client/struct.Client.html#method.get_address_balances) - -Aconvenient function that expects `list` of addresses in Bech32 format and returns list of `dict` with balances for all -given addresses. - -## [`Client.get_balance(seed: seed: &'a Seed)`](https://docs.rs/iota-client/latest/iota_client/client/struct.Client.html#method.get_balance) - -A convenient [`GetBalanceBuilder`](https://docs.rs/iota-client/latest/iota_client/api/struct.GetBalanceBuilder.html#) -class that combines -[`Client.get_addresses(seed: &'a Seed)`](https://docs.rs/iota-client/latest/iota_client/client/struct.Client.html#method.get_addresses) -and -[`Client.get_address_balances(addresses: &[String])`](https://docs.rs/iota-client/latest/iota_client/client/struct.Client.html#method.get_address_balances) -api calls. It returns a combined balance for the provided `seed` and optional chaining calls -[`.with_account_index(account_index: usize)`](https://docs.rs/iota-client/latest/iota_client/api/struct.GetBalanceBuilder.html#method.with_account_index), -[`.with_initial_address_index(initial_address_index: usize)`](https://docs.rs/iota-client/latest/iota_client/api/struct.GetBalanceBuilder.html#method.with_initial_address_index) -and -[`.with_gap_limit(gap_limit: usize)`](https://docs.rs/iota-client/latest/iota_client/api/struct.GetBalanceBuilder.html#method.with_gap_limit). - -`Client.get_balance(seed)` performs several tasks under the hood. It starts by generating addresses for the provided -`seed` and `.account_index` from `.with_initial_address_index(account_index)`, and checks for a balance of each of the -generated addresses. Since it does not know how many addresses are used in fact, there is a condition set by the -`.with_gap_limit(gap_limit)` argument to know when to stop searching. If the `.gap_limit` amount of addresses in a row -have no balance, the function returns results and searching does not continue. - -## [`Client.get_address().balance(address: &str)`](./../api_reference.md#balanceaddress-balanceaddressresponse) - -You can use the [`GetAdressBuilder`](https://docs.rs/iota-client/latest/iota_client/node/struct.GetAddressBuilder.html) -on a `Client` instance and query for an addresses' balances by chaining a call to the `balance(address: String)` -function. - -## [`Client.get_address().outputs(address: &str, options: OutputOptions)`](./../api_reference.md#balanceaddress-balanceaddressresponse) - -You can use the [`GetAdressBuilder`](https://docs.rs/iota-client/latest/iota_client/node/struct.GetAddressBuilder.html) -on a `Client` instance and query for an addresses' balances by chaining a call to the `outputs(address: String)` -function. - -```rust reference -https://github.com/iotaledger/iota.rs/tree/production/examples/04_get_balance.rs -``` - -Example of output: - -```json -Account balance: 1096055332i - -The balance of "atoi1qzt0nhsf38nh6rs4p6zs5knqp6psgha9wsv74uajqgjmwc75ugupx3y7x0r" is 451055332i - -The outputs of address "atoi1qzt0nhsf38nh6rs4p6zs5knqp6psgha9wsv74uajqgjmwc75ugupx3y7x0r" are: [ - UtxoInput(741673db85f78ebd95d04b572d1bf32e9207bbd265d90dbbe499a6d32f2b25470000), - UtxoInput(ed33089c623c67eb06dbc1c10b0c1c0424b0ace04a2e44070702668b3de440c80000), - UtxoInput(0af84c860dc461730064e7c4c88152ed8bea1ae72b1d6f5e4ab0c3e51ed185b70100), - ...] -``` - -- `dustAllowed` indicates whether the given address is allowed to accept a dust due to - [dust protection mechanism](/introduction/explanations/faq#what-is-dust-protection-and-how-does-it-work). diff --git a/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_05_get_outputs.mdx b/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_05_get_outputs.mdx deleted file mode 100644 index d5699b78f04..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_05_get_outputs.mdx +++ /dev/null @@ -1,36 +0,0 @@ -- [`Client.get_address.get_output( output_id: &UtxoInput)`](#clientget_addressget_output-output_id-utxoinput) -- [`Client.get_output(output_id: &UtxoInput)`](#clientget_outputoutput_id-utxoinput) -- [`Client.find_outputs(outputs: &[UtxoInput], addresses: &[String])`](#clientfind_outputsoutputs-utxoinput-addresses-string): - -## Client.get_address.get_output( output_id: &UtxoInput) - -The -[`Client.get_address.get_output( output_id: &UtxoInput)`](https://docs.rs/iota-client/latest/iota_client/client/struct.Client.html#method.get_output) -function expects an address in Bech32 format and returns a `str[]` of `output_ids`. - -```rust reference -https://github.com/iotaledger/iota.rs/tree/production/examples/05_get_address_outputs.rs -``` - -**Output example**: - -```json -[ - "0f2d5d2651f8061a9f5417d0658009f32b2e3f77f9706b0be3b4b3f466171f360000", - "7614ba900a90b130707766a660a454942ac7cc4adea3fb9ad0cdca90114417c20000", - "768c20c15a290e02a43b83263a98501b9d7eb0b57da40a9247289c672de63ea60000" -] -``` - -## Client.get_output(output_id: &UtxoInput) - -The -[Client.get_output(output_id: &UtxoInput)](https://docs.rs/iota-client/latest/iota_client/client/struct.Client.html#method.get_output) -function finds an output by its `transaction_id` and corresponding `output_index`. - -## Client.find_outputs(outputs: &[UtxoInput], addresses: &[String]) - -The -[Client.find_outputs(outputs: &[UtxoInput], addresses: &[String])](https://docs.rs/iota-client/latest/iota_client/client/struct.Client.html#method.find_outputs) -function supports two arguments, a list of `outputs` or a list of `addresses` and will return all the outputs related to -the requested criteria. diff --git a/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_06_simple_message.mdx b/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_06_simple_message.mdx deleted file mode 100644 index 3f18c374e14..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_06_simple_message.mdx +++ /dev/null @@ -1,28 +0,0 @@ -The function -[`Client.postMessage( message: &Message)`](https://docs.rs/iota-client/latest/iota_client/client/struct.Client.html#method.post_message) -accepts a message instance as a parameter and sends it over a network. - -```rust reference -https://github.com/iotaledger/iota.rs/tree/production/examples/06_simple_message.rs -``` - -**Output example**: - -```string -{ - message: { - networkId: '14379272398717627559', - parentMessageIds: [ - '03ddc83fad172a322fb00fb4e449436e9d1117ff390879100647c650a30c2d52', - '252798210fa9816f6fd40f1b19095da9f2dc88ae06fc4c0523a928a29d0d782e', - 'a8e4f4cd49227068424ead8da187a48fdaa7ce8ffc4b9ac0ee2d5d3f2fcd7e70', - 'dbbc8044bc624b3378e1dda83ab95f9be468b06a6a9806c76a70353182028cf9' - ], - payload: null, - nonce: '9223372036854784215' - }, - messageId: '10dbee9cf3c58507725861b34ac711058dc13f709be1a6d21f1dc0af17b06379' -} -``` - -- `messageId` is a unique id that refers to the given message in the network. diff --git a/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_07_get_message_data.mdx b/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_07_get_message_data.mdx deleted file mode 100644 index 96266e6eb79..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_07_get_message_data.mdx +++ /dev/null @@ -1,55 +0,0 @@ -Once a [message](../../../explanations/messages_payloads_and_transactions.md) is broadcast, you can use the -[`GetMessageBuilder`](https://docs.rs/iota-client/latest/iota_client/node/struct.GetMessageBuilder.html) helper class -that you can instantiate using the -[`Client.get_message()`](https://docs.rs/iota-client/latest/iota_client/client/struct.Client.html#method.get_message) -function to retrieve it from the network. The `GetMessageBuilder` provides helper functions related to the message, such -as -[`Client.get_message().data(message_id: &MessageId)`](https://docs.rs/iota-client/latest/iota_client/node/struct.GetMessageBuilder.html#method.data) -and -[`Client.get_message().metadata(message_id: &MessageId)`](https://docs.rs/iota-client/latest/iota_client/node/struct.GetMessageBuilder.html#method.metadata): - -```rust reference -https://github.com/iotaledger/iota.rs/tree/production/examples/07_get_message_metadata.rs -``` - -**Output example**: - -```json -Message meta data: -{ - "messageId":"e52b631bc7500366b90c6e11eb7fd6abaa7527f9bb5b4b512b0b9112bb9e7be8", - "parentMessageIds": [ - "26d72339ed262c1ec29d6c91de6be26d067b3327191f5e47606df53cc40e334e", - "6289ea0aecf3830e5e8d9925959bb6e804e324bb6db23c5701f7a538d12831f6", - "fdbf2d02603235fdff99f0ceb57705ead95041d62de386387f2922e5d9f6c502", - "ffa26139ca7f9d4849e118ff369fb3a387c8fefd8d15232b8353d4acf334324c" - ], - "isSolid":true, - "shouldPromote":false, - "shouldReattach":false -} - -Message data: -{ - "message": { - "networkId":"14379272398717627559", - "parentMessageIds": [ - "27782707e4cbf84ca26b3db881bbf39b6429f9ee736a0cbe5a1c177d7a52b05d", - "61cdf92c64a3304bbbabaf9fbfb0ea7ef9624e1eedea68efbe08595ccdf853e1", - "a222d13e3ee51b56b0b0e38140a5f7f813b6d9e29b752d7e1e2424099455080d", - "ab6bca20091b58dcbb0906438a7e47bfb11621c4a37b8d118b565f7f138a40d6" - ], - "payload": { - "type":2, - "index":"484f524e4554205370616d6d6572", - "data":"42696e61727920697320746865206675747572652e0a436f756e743a2031333936393530390a54696d657374616d703a20323032312d30352d33315431353a33363a30392b30323a30300a54697073656c656374696f6e3a203337c2b573" - }, - "nonce":"246736" - }, - "messageId":"30d87fa9917602e5685638e37802bde11b260bd2379f6c850704d7babd365b44" -} -``` - -- `Client.getMessage().metadata()` provides information on how the given message fits to network structures, such as - `ledger_inclusion_state`, etc. -- `Client.getMessage().data()` provides all the data that relates to the given message and its payload(s). diff --git a/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_08_data_message.mdx b/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_08_data_message.mdx deleted file mode 100644 index 4c119e19103..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_08_data_message.mdx +++ /dev/null @@ -1,30 +0,0 @@ -You can use the -[`ClientMessageBuilder.with_data(data: Vec)`](https://docs.rs/iota-client/latest/iota_client/api/struct.ClientMessageBuilder.html#method.with_data) -function to sent data in a message. - -```rust reference -https://github.com/iotaledger/iota.rs/tree/production/examples/08_data_message.rs -``` - -**Output example**: - -```json -{ - "message": { - "networkId": "14379272398717627559", - "parentMessageIds": [ - "1a383abbe5f6a6b0899d718975c3119643aa784a68d04075f4e986fd7a0c0e4b", - "6098f889e31911833df7b7839e8b222d701ab496f7dfa1a719087edf4fa7ae52", - "a98b47db4e8254eccc738c968bd35b08a5491e56d6c1a18af298c42bbd8c3a46", - "da6796c0842c08de832c7948fffedc0d5adce372e50a108f26a128dba6096d31" - ], - "payload": { - "type": 2, - "index": "494f54412e52532042494e44494e47202d204e4f44452e4a53", - "data": "736f6d65207574662062617365642064617461" - }, - "nonce": "13835058055282176519" - }, - "messageId": "10f59c101cec669b0a0ba163bc777184c7f63455f5e771d42f910a1ba2ad20ff" -} -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_09_transaction.mdx b/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_09_transaction.mdx deleted file mode 100644 index 73a046a3862..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_09_transaction.mdx +++ /dev/null @@ -1,12 +0,0 @@ -Sending value-based messages is a very straightforward process if you use the -[`ClientMessageBuilder`](https://docs.rs/iota-client/latest/iota_client/api/struct.ClientMessageBuilder.html) helper -class. You will only need to provide a valid seed by chaining a call to -[`.with_seed(seed: &'a Seed)`](https://docs.rs/iota-client/latest/iota_client/api/struct.ClientMessageBuilder.html#method.with_seed), and -output address and amount by chaining a call to -[`.with_output(address: &str, amount: u64)`](https://docs.rs/iota-client/latest/iota_client/api/struct.ClientMessageBuilder.html#method.with_output). -The method will find valid output(s) that can be used to fund the given amount(s) and the unspent amount will be sent to -the same address. - -```rust reference -https://github.com/iotaledger/iota.rs/tree/production/examples/09_transaction.rs -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_10_mqtt.mdx b/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_10_mqtt.mdx deleted file mode 100644 index ab417901026..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_10_mqtt.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```rust reference -https://github.com/iotaledger/iota.rs/tree/production/examples/10_mqtt.rs -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_running_examples.mdx b/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_running_examples.mdx deleted file mode 100644 index d0dca8dfc37..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/rust/examples/_running_examples.mdx +++ /dev/null @@ -1,35 +0,0 @@ -## Prequisites - -### Clone the project - -You can clone the project by running the following command - -```bash -git clone https://github.com/iotaledger/iota.rs -``` - -### Set Up Your .env file - -After you have [cloned the project](#clone-the-project), you should: - -1. Move into the project directory by running the following command: - -```bash -cd iota.rs -``` - -2. Create your `.env` file by making a copy of the `.env.example` file by running the following command: - -```bash -cp .env.example .env -``` - -## Run the Examples - -After you have fulfilled the [prequisites](#prequisites), you can run examples by using the following command: - -```bash -cargo run --example 01_get_info --release -``` - -You can replace the `01_get_info` by any other example from the [Rust examples directory](https://github.com/iotaledger/iota.rs/tree/dev/examples). diff --git a/docs/build/iota.rs/1.4/docs/libraries/wasm/api_reference.md b/docs/build/iota.rs/1.4/docs/libraries/wasm/api_reference.md deleted file mode 100644 index bce0ce6a768..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/wasm/api_reference.md +++ /dev/null @@ -1,1342 +0,0 @@ -## Classes - -
-
AddressGetter
-
-
BalanceGetter
-
-
Client
-
-
ClientBuilder
-
-
GetAddressBuilder
-
-
MessageBuilder
-
-
MessageGetter
-
-
UnspentAddressGetter
-
-
- -## Functions - -
-
start()
-

Initializes the console error panic hook for better error messages

-
-
- - - -## AddressGetter - -**Kind**: global class - -- [AddressGetter](#AddressGetter) - - _instance_ - - [.accountIndex(index)](#AddressGetter+accountIndex) ⇒ [AddressGetter](#AddressGetter) - - [.range(start, end)](#AddressGetter+range) ⇒ [AddressGetter](#AddressGetter) - - [.bech32Hrp(bech32_hrp)](#AddressGetter+bech32Hrp) ⇒ [AddressGetter](#AddressGetter) - - [.includeInternal()](#AddressGetter+includeInternal) ⇒ [AddressGetter](#AddressGetter) - - [.get()](#AddressGetter+get) ⇒ Promise.<any> - - _static_ - - [.new(client, seed)](#AddressGetter.new) ⇒ [AddressGetter](#AddressGetter) - - - -### addressGetter.accountIndex(index) ⇒ [AddressGetter](#AddressGetter) - -Set the account index - -**Kind**: instance method of [AddressGetter](#AddressGetter) - -| Param | Type | -| ----- | ------------------- | -| index | number | - - - -### addressGetter.range(start, end) ⇒ [AddressGetter](#AddressGetter) - -Set the address range - -**Kind**: instance method of [AddressGetter](#AddressGetter) - -| Param | Type | -| ----- | ------------------- | -| start | number | -| end | number | - - - -### addressGetter.bech32Hrp(bech32_hrp) ⇒ [AddressGetter](#AddressGetter) - -Set the bech32 hrp - -**Kind**: instance method of [AddressGetter](#AddressGetter) - -| Param | Type | -| ---------- | ------------------- | -| bech32_hrp | string | - - - -### addressGetter.includeInternal() ⇒ [AddressGetter](#AddressGetter) - -Include internal addresses - -**Kind**: instance method of [AddressGetter](#AddressGetter) - - -### addressGetter.get() ⇒ Promise.<any> - -Get the addresses. - -**Kind**: instance method of [AddressGetter](#AddressGetter) - - -### AddressGetter.new(client, seed) ⇒ [AddressGetter](#AddressGetter) - -**Kind**: static method of [AddressGetter](#AddressGetter) - -| Param | Type | -| ------ | ------------------------------ | -| client | [Client](#Client) | -| seed | string | - - - -## BalanceGetter - -**Kind**: global class - -- [BalanceGetter](#BalanceGetter) - - _instance_ - - [.accountIndex(index)](#BalanceGetter+accountIndex) ⇒ [BalanceGetter](#BalanceGetter) - - [.initialAddressIndex(initial_address_index)](#BalanceGetter+initialAddressIndex) ⇒ [BalanceGetter](#BalanceGetter) - - [.gap_limit(gap_limit)](#BalanceGetter+gap_limit) ⇒ [BalanceGetter](#BalanceGetter) - - [.get()](#BalanceGetter+get) ⇒ Promise.<any> - - _static_ - - [.new(client, seed)](#BalanceGetter.new) ⇒ [BalanceGetter](#BalanceGetter) - - - -### balanceGetter.accountIndex(index) ⇒ [BalanceGetter](#BalanceGetter) - -Sets the account index - -**Kind**: instance method of [BalanceGetter](#BalanceGetter) - -| Param | Type | -| ----- | ------------------- | -| index | number | - - - -### balanceGetter.initialAddressIndex(initial_address_index) ⇒ [BalanceGetter](#BalanceGetter) - -Sets the address index from which to start looking for balance - -**Kind**: instance method of [BalanceGetter](#BalanceGetter) - -| Param | Type | -| --------------------- | ------------------- | -| initial_address_index | number | - - - -### balanceGetter.gap_limit(gap_limit) ⇒ [BalanceGetter](#BalanceGetter) - -Sets the gap limit to specify how many addresses will be checked each round. -If gap_limit amount of addresses in a row have no balance the function will return. - -**Kind**: instance method of [BalanceGetter](#BalanceGetter) - -| Param | Type | -| --------- | ------------------- | -| gap_limit | number | - - - -### balanceGetter.get() ⇒ Promise.<any> - -Get the balance. - -**Kind**: instance method of [BalanceGetter](#BalanceGetter) - - -### BalanceGetter.new(client, seed) ⇒ [BalanceGetter](#BalanceGetter) - -**Kind**: static method of [BalanceGetter](#BalanceGetter) - -| Param | Type | -| ------ | ------------------------------ | -| client | [Client](#Client) | -| seed | string | - - - -## Client - -**Kind**: global class - -- [Client](#Client) - - [.message()](#Client+message) ⇒ [MessageBuilder](#MessageBuilder) - - [.getMessage()](#Client+getMessage) ⇒ [MessageGetter](#MessageGetter) - - [.getAddresses(seed)](#Client+getAddresses) ⇒ [AddressGetter](#AddressGetter) - - [.getUnspentAddress(seed)](#Client+getUnspentAddress) ⇒ [UnspentAddressGetter](#UnspentAddressGetter) - - [.getBalance(seed)](#Client+getBalance) ⇒ [BalanceGetter](#BalanceGetter) - - [.getAddress()](#Client+getAddress) ⇒ [GetAddressBuilder](#GetAddressBuilder) - - [.getInfo()](#Client+getInfo) ⇒ Promise.<any> - - [.getNodeInfo(url, jwt, username, password)](#Client+getNodeInfo) ⇒ Promise.<any> - - [.networkInfo()](#Client+networkInfo) ⇒ Promise.<any> - - [.getNetworkId()](#Client+getNetworkId) ⇒ Promise.<any> - - [.getBech32Hrp()](#Client+getBech32Hrp) ⇒ Promise.<any> - - [.getMinPowScore()](#Client+getMinPowScore) ⇒ Promise.<any> - - [.getHealth()](#Client+getHealth) ⇒ Promise.<any> - - [.getTips()](#Client+getTips) ⇒ Promise.<any> - - [.getPeers()](#Client+getPeers) ⇒ Promise.<any> - - [.getOutput(output_id)](#Client+getOutput) ⇒ Promise.<any> - - [.findMessages(indexation_keys, message_ids)](#Client+findMessages) ⇒ Promise.<any> - - [.findInputs(addresses, amount)](#Client+findInputs) ⇒ Promise.<any> - - [.findOutputs(outputs, addresses)](#Client+findOutputs) ⇒ Promise.<any> - - [.getAddressBalances(addresses)](#Client+getAddressBalances) ⇒ Promise.<any> - - [.getMilestone(index)](#Client+getMilestone) ⇒ Promise.<any> - - [.getMilestoneUtxoChanges(index)](#Client+getMilestoneUtxoChanges) ⇒ Promise.<any> - - [.getReceipts()](#Client+getReceipts) ⇒ Promise.<any> - - [.getReceiptsMigratedAt(milestone_index)](#Client+getReceiptsMigratedAt) ⇒ Promise.<any> - - [.getTreasury()](#Client+getTreasury) ⇒ Promise.<any> - - [.getIncludedMessage(transaction_id)](#Client+getIncludedMessage) ⇒ Promise.<any> - - [.postMessage(message)](#Client+postMessage) ⇒ Promise.<any> - - [.retry(message_id)](#Client+retry) ⇒ Promise.<any> - - [.retryUntilIncluded(message_id, interval, max_attempts)](#Client+retryUntilIncluded) ⇒ Promise.<any> - - [.reattach(message_id)](#Client+reattach) ⇒ Promise.<any> - - [.promote(message_id)](#Client+promote) ⇒ Promise.<any> - - [.consolidateFunds(seed, account_index, start_index, end_index)](#Client+consolidateFunds) ⇒ Promise.<any> - - [.bech32ToHex(address)](#Client+bech32ToHex) ⇒ string - - [.hexToBech32(address, bech32)](#Client+hexToBech32) ⇒ Promise.<any> - - [.hexPublicKeyToBech32Address(public_key, bech32)](#Client+hexPublicKeyToBech32Address) ⇒ Promise.<any> - - [.isAddressValid(address)](#Client+isAddressValid) ⇒ boolean - - [.generateMnemonic()](#Client+generateMnemonic) ⇒ string - - [.mnemonicToHexSeed(mnemonic)](#Client+mnemonicToHexSeed) ⇒ string - - [.getMessageId(message)](#Client+getMessageId) ⇒ string - - [.getTransactionId(transaction)](#Client+getTransactionId) ⇒ string - - [.getEssenceHash(essence)](#Client+getEssenceHash) ⇒ string - - - -### client.message() ⇒ [MessageBuilder](#MessageBuilder) - -Send a message to the Tangle. - -**Kind**: instance method of [Client](#Client) - - -### client.getMessage() ⇒ [MessageGetter](#MessageGetter) - -Get a message from the Tangle. - -**Kind**: instance method of [Client](#Client) - - -### client.getAddresses(seed) ⇒ [AddressGetter](#AddressGetter) - -Generate addresses. - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| ----- | ------------------- | -| seed | string | - - - -### client.getUnspentAddress(seed) ⇒ [UnspentAddressGetter](#UnspentAddressGetter) - -Get an unspent address. - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| ----- | ------------------- | -| seed | string | - - - -### client.getBalance(seed) ⇒ [BalanceGetter](#BalanceGetter) - -Get the account balance. - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| ----- | ------------------- | -| seed | string | - - - -### client.getAddress() ⇒ [GetAddressBuilder](#GetAddressBuilder) - -GET /api/v1/addresses/{address} endpoint - -**Kind**: instance method of [Client](#Client) - - -### client.getInfo() ⇒ Promise.<any> - -Get the nodeinfo. - -**Kind**: instance method of [Client](#Client) - - -### client.getNodeInfo(url, jwt, username, password) ⇒ Promise.<any> - -Get the nodeinfo. - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| -------- | --------------------------------------------- | -| url | string | -| jwt | string \| undefined | -| username | string \| undefined | -| password | string \| undefined | - - - -### client.networkInfo() ⇒ Promise.<any> - -Gets the network related information such as network_id and min_pow_score -and if it's the default one, sync it first. - -**Kind**: instance method of [Client](#Client) - - -### client.getNetworkId() ⇒ Promise.<any> - -Gets the network id of the node we're connecting to. - -**Kind**: instance method of [Client](#Client) - - -### client.getBech32Hrp() ⇒ Promise.<any> - -returns the bech32_hrp - -**Kind**: instance method of [Client](#Client) - - -### client.getMinPowScore() ⇒ Promise.<any> - -returns the bech32_hrp - -**Kind**: instance method of [Client](#Client) - - -### client.getHealth() ⇒ Promise.<any> - -Get the node health. - -**Kind**: instance method of [Client](#Client) - - -### client.getTips() ⇒ Promise.<any> - -Get tips. - -**Kind**: instance method of [Client](#Client) - - -### client.getPeers() ⇒ Promise.<any> - -Get peers. - -**Kind**: instance method of [Client](#Client) - - -### client.getOutput(output_id) ⇒ Promise.<any> - -GET /api/v1/outputs/{outputId} endpoint -Find an output by its transaction_id and corresponding output_index. - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| --------- | ------------------- | -| output_id | string | - - - -### client.findMessages(indexation_keys, message_ids) ⇒ Promise.<any> - -Find all messages by provided message IDs and/or indexation_keys. - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| --------------- | ---------------- | -| indexation_keys | any | -| message_ids | any | - - - -### client.findInputs(addresses, amount) ⇒ Promise.<any> - -Function to find inputs from addresses for a provided amount (useful for offline signing) - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| --------- | ------------------- | -| addresses | any | -| amount | BigInt | - - - -### client.findOutputs(outputs, addresses) ⇒ Promise.<any> - -Find all outputs based on the requests criteria. This method will try to query multiple nodes if -the request amount exceeds individual node limit. - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| --------- | ---------------- | -| outputs | any | -| addresses | any | - - - -### client.getAddressBalances(addresses) ⇒ Promise.<any> - -Return the balance in iota for the given addresses; No seed needed to do this since we are only checking and -already know the addresses. - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| --------- | ---------------- | -| addresses | any | - - - -### client.getMilestone(index) ⇒ Promise.<any> - -GET /api/v1/milestones/{index} endpoint -Get the milestone by the given index. - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| ----- | ------------------- | -| index | number | - - - -### client.getMilestoneUtxoChanges(index) ⇒ Promise.<any> - -GET /api/v1/milestones/{index}/utxo-changes endpoint -Get the milestone by the given index. - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| ----- | ------------------- | -| index | number | - - - -### client.getReceipts() ⇒ Promise.<any> - -GET /api/v1/receipts endpoint -Get all receipts. - -**Kind**: instance method of [Client](#Client) - - -### client.getReceiptsMigratedAt(milestone_index) ⇒ Promise.<any> - -GET /api/v1/receipts/{migratedAt} endpoint -Get the receipts by the given milestone index. - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| --------------- | ------------------- | -| milestone_index | number | - - - -### client.getTreasury() ⇒ Promise.<any> - -GET /api/v1/treasury endpoint -Get the treasury output. - -**Kind**: instance method of [Client](#Client) - - -### client.getIncludedMessage(transaction_id) ⇒ Promise.<any> - -GET /api/v1/transactions/{transactionId}/included-message -Returns the included message of the transaction. - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| -------------- | ------------------- | -| transaction_id | string | - - - -### client.postMessage(message) ⇒ Promise.<any> - -Post message. - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| ------- | ---------------- | -| message | any | - - - -### client.retry(message_id) ⇒ Promise.<any> - -Retries (promotes or reattaches) a message for provided message id. Message should only be -retried only if they are valid and haven't been confirmed for a while. - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| ---------- | ------------------- | -| message_id | string | - - - -### client.retryUntilIncluded(message_id, interval, max_attempts) ⇒ Promise.<any> - -Only works in browser because of the timeouts -Retries (promotes or reattaches) a message for provided message id until it's included (referenced by a -milestone). Default interval is 5 seconds and max attempts is 40. Returns reattached messages - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| ------------ | --------------------------------------------- | -| message_id | string | -| interval | BigInt \| undefined | -| max_attempts | BigInt \| undefined | - - - -### client.reattach(message_id) ⇒ Promise.<any> - -Reattaches messages for provided message id. Messages can be reattached only if they are valid and haven't been -confirmed for a while. - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| ---------- | ------------------- | -| message_id | string | - - - -### client.promote(message_id) ⇒ Promise.<any> - -Promotes a message. The method should validate if a promotion is necessary through get_message. If not, the -method should error out and should not allow unnecessary promotions. - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| ---------- | ------------------- | -| message_id | string | - - - -### client.consolidateFunds(seed, account_index, start_index, end_index) ⇒ Promise.<any> - -Only works in browser because of the timeouts -Function to consolidate all funds from a range of addresses to the address with the lowest index in that range -Returns the address to which the funds got consolidated, if any were available - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| ------------- | ------------------- | -| seed | string | -| account_index | number | -| start_index | number | -| end_index | number | - - - -### client.bech32ToHex(address) ⇒ string - -Returns a parsed hex String from bech32. - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| ------- | ------------------- | -| address | string | - - - -### client.hexToBech32(address, bech32) ⇒ Promise.<any> - -Returns a parsed bech32 String from hex. - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| ------- | --------------------------------------------- | -| address | string | -| bech32 | string \| undefined | - - - -### client.hexPublicKeyToBech32Address(public_key, bech32) ⇒ Promise.<any> - -Transforms a hex encoded public key to a bech32 encoded address - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| ---------- | --------------------------------------------- | -| public_key | string | -| bech32 | string \| undefined | - - - -### client.isAddressValid(address) ⇒ boolean - -Checks if a String is a valid bech32 encoded address. - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| ------- | ------------------- | -| address | string | - - - -### client.generateMnemonic() ⇒ string - -Generates a new mnemonic. - -**Kind**: instance method of [Client](#Client) - - -### client.mnemonicToHexSeed(mnemonic) ⇒ string - -Returns a hex encoded seed for a mnemonic. - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| -------- | ------------------- | -| mnemonic | string | - - - -### client.getMessageId(message) ⇒ string - -Returns the message id from a provided message. - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| ------- | ------------------- | -| message | string | - - - -### client.getTransactionId(transaction) ⇒ string - -Returns the transaction id from a provided transaction payload. - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| ----------- | ------------------- | -| transaction | string | - - - -### client.getEssenceHash(essence) ⇒ string - -Get essence hash - -**Kind**: instance method of [Client](#Client) - -| Param | Type | -| ------- | ------------------- | -| essence | string | - - - -## ClientBuilder - -**Kind**: global class - -- [ClientBuilder](#ClientBuilder) - - [new ClientBuilder()](#new_ClientBuilder_new) - - [.node(url)](#ClientBuilder+node) ⇒ [ClientBuilder](#ClientBuilder) - - [.primaryNode(url, jwt, username, password)](#ClientBuilder+primaryNode) ⇒ [ClientBuilder](#ClientBuilder) - - [.primaryPowNode(url, jwt, username, password)](#ClientBuilder+primaryPowNode) ⇒ [ClientBuilder](#ClientBuilder) - - [.permanode(url, jwt, username, password)](#ClientBuilder+permanode) ⇒ [ClientBuilder](#ClientBuilder) - - [.nodeAuth(url, jwt, username, password)](#ClientBuilder+nodeAuth) ⇒ [ClientBuilder](#ClientBuilder) - - [.nodes(urls)](#ClientBuilder+nodes) ⇒ [ClientBuilder](#ClientBuilder) - - [.nodeSyncInterval(value)](#ClientBuilder+nodeSyncInterval) ⇒ [ClientBuilder](#ClientBuilder) - - [.nodeSyncDisabled()](#ClientBuilder+nodeSyncDisabled) ⇒ [ClientBuilder](#ClientBuilder) - - [.offlineMode()](#ClientBuilder+offlineMode) ⇒ [ClientBuilder](#ClientBuilder) - - [.nodePoolUrls(node_pool_urls)](#ClientBuilder+nodePoolUrls) ⇒ Promise.<any> - - [.quorum(value)](#ClientBuilder+quorum) ⇒ [ClientBuilder](#ClientBuilder) - - [.quorumSize(value)](#ClientBuilder+quorumSize) ⇒ [ClientBuilder](#ClientBuilder) - - [.quorumThreshold(value)](#ClientBuilder+quorumThreshold) ⇒ [ClientBuilder](#ClientBuilder) - - [.network(network)](#ClientBuilder+network) ⇒ [ClientBuilder](#ClientBuilder) - - [.localPow(value)](#ClientBuilder+localPow) ⇒ [ClientBuilder](#ClientBuilder) - - [.tipsInterval(value)](#ClientBuilder+tipsInterval) ⇒ [ClientBuilder](#ClientBuilder) - - [.requestTimeout(value)](#ClientBuilder+requestTimeout) ⇒ [ClientBuilder](#ClientBuilder) - - [.apiTimeout(api, timeout)](#ClientBuilder+apiTimeout) ⇒ [ClientBuilder](#ClientBuilder) - - [.build()](#ClientBuilder+build) ⇒ Promise.<any> - - - -### new ClientBuilder() - -Creates an IOTA client builder. - - - -### clientBuilder.node(url) ⇒ [ClientBuilder](#ClientBuilder) - -Adds an IOTA node by its URL. - -**Kind**: instance method of [ClientBuilder](#ClientBuilder) - -| Param | Type | -| ----- | ------------------- | -| url | string | - - - -### clientBuilder.primaryNode(url, jwt, username, password) ⇒ [ClientBuilder](#ClientBuilder) - -Adds an IOTA node by its URL to be used as primary node, with optional jwt and or basic authentication - -**Kind**: instance method of [ClientBuilder](#ClientBuilder) - -| Param | Type | -| -------- | --------------------------------------------- | -| url | string | -| jwt | string \| undefined | -| username | string \| undefined | -| password | string \| undefined | - - - -### clientBuilder.primaryPowNode(url, jwt, username, password) ⇒ [ClientBuilder](#ClientBuilder) - -Adds an IOTA node by its URL to be used as primary PoW node (for remote PoW), with optional jwt and or basic -authentication - -**Kind**: instance method of [ClientBuilder](#ClientBuilder) - -| Param | Type | -| -------- | --------------------------------------------- | -| url | string | -| jwt | string \| undefined | -| username | string \| undefined | -| password | string \| undefined | - - - -### clientBuilder.permanode(url, jwt, username, password) ⇒ [ClientBuilder](#ClientBuilder) - -Adds a permanode by its URL, with optional jwt and or basic authentication - -**Kind**: instance method of [ClientBuilder](#ClientBuilder) - -| Param | Type | -| -------- | --------------------------------------------- | -| url | string | -| jwt | string \| undefined | -| username | string \| undefined | -| password | string \| undefined | - - - -### clientBuilder.nodeAuth(url, jwt, username, password) ⇒ [ClientBuilder](#ClientBuilder) - -Adds an IOTA node by its URL with optional jwt and or basic authentication - -**Kind**: instance method of [ClientBuilder](#ClientBuilder) - -| Param | Type | -| -------- | --------------------------------------------- | -| url | string | -| jwt | string \| undefined | -| username | string \| undefined | -| password | string \| undefined | - - - -### clientBuilder.nodes(urls) ⇒ [ClientBuilder](#ClientBuilder) - -Adds a list of IOTA nodes by their URLs. - -**Kind**: instance method of [ClientBuilder](#ClientBuilder) - -| Param | Type | -| ----- | ---------------- | -| urls | any | - - - -### clientBuilder.nodeSyncInterval(value) ⇒ [ClientBuilder](#ClientBuilder) - -Set the node sync interval (has no effect because we can't spawn another thread in wasm to sync the nodes) - -**Kind**: instance method of [ClientBuilder](#ClientBuilder) - -| Param | Type | -| ----- | ------------------- | -| value | number | - - - -### clientBuilder.nodeSyncDisabled() ⇒ [ClientBuilder](#ClientBuilder) - -Disables the node syncing process. -Every node will be considered healthy and ready to use. - -**Kind**: instance method of [ClientBuilder](#ClientBuilder) - - -### clientBuilder.offlineMode() ⇒ [ClientBuilder](#ClientBuilder) - -Allows creating the client without nodes for offline address generation or signing - -**Kind**: instance method of [ClientBuilder](#ClientBuilder) - - -### clientBuilder.nodePoolUrls(node_pool_urls) ⇒ Promise.<any> - -Get node list from the node_pool_urls - -**Kind**: instance method of [ClientBuilder](#ClientBuilder) - -| Param | Type | -| -------------- | ---------------- | -| node_pool_urls | any | - - - -### clientBuilder.quorum(value) ⇒ [ClientBuilder](#ClientBuilder) - -Set if quroum should be used or not - -**Kind**: instance method of [ClientBuilder](#ClientBuilder) - -| Param | Type | -| ----- | -------------------- | -| value | boolean | - - - -### clientBuilder.quorumSize(value) ⇒ [ClientBuilder](#ClientBuilder) - -Set amount of nodes which should be used for quorum - -**Kind**: instance method of [ClientBuilder](#ClientBuilder) - -| Param | Type | -| ----- | ------------------- | -| value | number | - - - -### clientBuilder.quorumThreshold(value) ⇒ [ClientBuilder](#ClientBuilder) - -Set quorum_threshold - -**Kind**: instance method of [ClientBuilder](#ClientBuilder) - -| Param | Type | -| ----- | ------------------- | -| value | number | - - - -### clientBuilder.network(network) ⇒ [ClientBuilder](#ClientBuilder) - -Selects the type of network to get default nodes for it, only "devnet" is supported at the moment. -Nodes that don't belong to this network are ignored. Default nodes are only used when no other nodes are -provided. - -**Kind**: instance method of [ClientBuilder](#ClientBuilder) - -| Param | Type | -| ------- | ------------------- | -| network | string | - - - -### clientBuilder.localPow(value) ⇒ [ClientBuilder](#ClientBuilder) - -Since we can only have a single thread in wasm, local PoW is much slower - -**Kind**: instance method of [ClientBuilder](#ClientBuilder) - -| Param | Type | -| ----- | -------------------- | -| value | boolean | - - - -### clientBuilder.tipsInterval(value) ⇒ [ClientBuilder](#ClientBuilder) - -Sets after how many seconds new tips will be requested during PoW - -**Kind**: instance method of [ClientBuilder](#ClientBuilder) - -| Param | Type | -| ----- | ------------------- | -| value | number | - - - -### clientBuilder.requestTimeout(value) ⇒ [ClientBuilder](#ClientBuilder) - -Sets the default request timeout. - -**Kind**: instance method of [ClientBuilder](#ClientBuilder) - -| Param | Type | -| ----- | ------------------- | -| value | number | - - - -### clientBuilder.apiTimeout(api, timeout) ⇒ [ClientBuilder](#ClientBuilder) - -Sets the request timeout for a specific API usage. - -**Kind**: instance method of [ClientBuilder](#ClientBuilder) - -| Param | Type | -| ------- | ------------------- | -| api | string | -| timeout | number | - - - -### clientBuilder.build() ⇒ Promise.<any> - -Build the client. - -**Kind**: instance method of [ClientBuilder](#ClientBuilder) - - -## GetAddressBuilder - -**Kind**: global class - -- [GetAddressBuilder](#GetAddressBuilder) - - _instance_ - - [.balance(address)](#GetAddressBuilder+balance) ⇒ Promise.<any> - - [.outputs(address, options)](#GetAddressBuilder+outputs) ⇒ Promise.<any> - - _static_ - - [.new(client)](#GetAddressBuilder.new) ⇒ [GetAddressBuilder](#GetAddressBuilder) - - - -### getAddressBuilder.balance(address) ⇒ Promise.<any> - -Consume the builder and get the balance of a given Bech32 encoded address. -If count equals maxResults, then there might be more outputs available but those were skipped for performance -reasons. User should sweep the address to reduce the amount of outputs. - -**Kind**: instance method of [GetAddressBuilder](#GetAddressBuilder) - -| Param | Type | -| ------- | ------------------- | -| address | string | - - - -### getAddressBuilder.outputs(address, options) ⇒ Promise.<any> - -Consume the builder and get all outputs that use a given address. -If count equals maxResults, then there might be more outputs available but those were skipped for performance -reasons. User should sweep the address to reduce the amount of outputs. - -**Kind**: instance method of [GetAddressBuilder](#GetAddressBuilder) - -| Param | Type | -| ------- | ------------------- | -| address | string | -| options | any | - - - -### GetAddressBuilder.new(client) ⇒ [GetAddressBuilder](#GetAddressBuilder) - -**Kind**: static method of [GetAddressBuilder](#GetAddressBuilder) - -| Param | Type | -| ------ | ------------------------------ | -| client | [Client](#Client) | - - - -## MessageBuilder - -**Kind**: global class - -- [MessageBuilder](#MessageBuilder) - - _instance_ - - [.index(index)](#MessageBuilder+index) ⇒ [MessageBuilder](#MessageBuilder) - - [.data(data)](#MessageBuilder+data) ⇒ [MessageBuilder](#MessageBuilder) - - [.seed(seed)](#MessageBuilder+seed) ⇒ [MessageBuilder](#MessageBuilder) - - [.accountIndex(account_index)](#MessageBuilder+accountIndex) ⇒ [MessageBuilder](#MessageBuilder) - - [.initialAddressIndex(initial_address_index)](#MessageBuilder+initialAddressIndex) ⇒ [MessageBuilder](#MessageBuilder) - - [.parents(parents)](#MessageBuilder+parents) ⇒ [MessageBuilder](#MessageBuilder) - - [.input(output_id)](#MessageBuilder+input) ⇒ [MessageBuilder](#MessageBuilder) - - [.inputRange(start, end)](#MessageBuilder+inputRange) ⇒ [MessageBuilder](#MessageBuilder) - - [.output(address, amount)](#MessageBuilder+output) ⇒ [MessageBuilder](#MessageBuilder) - - [.dustAllowanceOutput(address, amount)](#MessageBuilder+dustAllowanceOutput) ⇒ [MessageBuilder](#MessageBuilder) - - [.prepareTransaction()](#MessageBuilder+prepareTransaction) ⇒ Promise.<any> - - [.signTransaction(prepared_transaction_data, seed, input_range_start, input_range_end)](#MessageBuilder+signTransaction) ⇒ Promise.<any> - - [.finishMessage(payload)](#MessageBuilder+finishMessage) ⇒ Promise.<any> - - [.submit()](#MessageBuilder+submit) ⇒ Promise.<any> - - _static_ - - [.new(client)](#MessageBuilder.new) ⇒ [MessageBuilder](#MessageBuilder) - - - -### messageBuilder.index(index) ⇒ [MessageBuilder](#MessageBuilder) - -Set indexation to the builder - -**Kind**: instance method of [MessageBuilder](#MessageBuilder) - -| Param | Type | -| ----- | ----------------------- | -| index | Uint8Array | - - - -### messageBuilder.data(data) ⇒ [MessageBuilder](#MessageBuilder) - -Set data to the builder - -**Kind**: instance method of [MessageBuilder](#MessageBuilder) - -| Param | Type | -| ----- | ----------------------- | -| data | Uint8Array | - - - -### messageBuilder.seed(seed) ⇒ [MessageBuilder](#MessageBuilder) - -Sets the seed. - -**Kind**: instance method of [MessageBuilder](#MessageBuilder) - -| Param | Type | -| ----- | ------------------- | -| seed | string | - - - -### messageBuilder.accountIndex(account_index) ⇒ [MessageBuilder](#MessageBuilder) - -Sets the account index. - -**Kind**: instance method of [MessageBuilder](#MessageBuilder) - -| Param | Type | -| ------------- | ------------------- | -| account_index | number | - - - -### messageBuilder.initialAddressIndex(initial_address_index) ⇒ [MessageBuilder](#MessageBuilder) - -Sets the index of the address to start looking for balance. - -**Kind**: instance method of [MessageBuilder](#MessageBuilder) - -| Param | Type | -| --------------------- | ------------------- | -| initial_address_index | number | - - - -### messageBuilder.parents(parents) ⇒ [MessageBuilder](#MessageBuilder) - -Set 1-8 custom parent message ids - -**Kind**: instance method of [MessageBuilder](#MessageBuilder) - -| Param | Type | -| ------- | ---------------- | -| parents | any | - - - -### messageBuilder.input(output_id) ⇒ [MessageBuilder](#MessageBuilder) - -Set a custom input(transaction output) - -**Kind**: instance method of [MessageBuilder](#MessageBuilder) - -| Param | Type | -| --------- | ------------------- | -| output_id | string | - - - -### messageBuilder.inputRange(start, end) ⇒ [MessageBuilder](#MessageBuilder) - -Set a custom range in which to search for addresses for custom provided inputs. Default: 0..100 - -**Kind**: instance method of [MessageBuilder](#MessageBuilder) - -| Param | Type | -| ----- | ------------------- | -| start | number | -| end | number | - - - -### messageBuilder.output(address, amount) ⇒ [MessageBuilder](#MessageBuilder) - -Set a transfer to the builder - -**Kind**: instance method of [MessageBuilder](#MessageBuilder) - -| Param | Type | -| ------- | ------------------- | -| address | string | -| amount | BigInt | - - - -### messageBuilder.dustAllowanceOutput(address, amount) ⇒ [MessageBuilder](#MessageBuilder) - -Set a dust allowance transfer to the builder, address needs to be Bech32 encoded - -**Kind**: instance method of [MessageBuilder](#MessageBuilder) - -| Param | Type | -| ------- | ------------------- | -| address | string | -| amount | BigInt | - - - -### messageBuilder.prepareTransaction() ⇒ Promise.<any> - -Prepare a transaction - -**Kind**: instance method of [MessageBuilder](#MessageBuilder) - - -### messageBuilder.signTransaction(prepared_transaction_data, seed, input_range_start, input_range_end) ⇒ Promise.<any> - -Sign a transaction - -**Kind**: instance method of [MessageBuilder](#MessageBuilder) - -| Param | Type | -| ------------------------- | --------------------------------------------- | -| prepared_transaction_data | any | -| seed | string | -| input_range_start | number \| undefined | -| input_range_end | number \| undefined | - - - -### messageBuilder.finishMessage(payload) ⇒ Promise.<any> - -Create a message with a provided payload - -**Kind**: instance method of [MessageBuilder](#MessageBuilder) - -| Param | Type | -| ------- | ---------------- | -| payload | any | - - - -### messageBuilder.submit() ⇒ Promise.<any> - -Build and sumbit the message. - -**Kind**: instance method of [MessageBuilder](#MessageBuilder) - - -### MessageBuilder.new(client) ⇒ [MessageBuilder](#MessageBuilder) - -**Kind**: static method of [MessageBuilder](#MessageBuilder) - -| Param | Type | -| ------ | ------------------------------ | -| client | [Client](#Client) | - - - -## MessageGetter - -**Kind**: global class - -- [MessageGetter](#MessageGetter) - - _instance_ - - [.index(index)](#MessageGetter+index) ⇒ Promise.<any> - - [.data(message_id)](#MessageGetter+data) ⇒ Promise.<any> - - [.raw(message_id)](#MessageGetter+raw) ⇒ Promise.<any> - - [.children(message_id)](#MessageGetter+children) ⇒ Promise.<any> - - [.metadata(message_id)](#MessageGetter+metadata) ⇒ Promise.<any> - - _static_ - - [.new(client)](#MessageGetter.new) ⇒ [MessageGetter](#MessageGetter) - - - -### messageGetter.index(index) ⇒ Promise.<any> - -Get message ids with an index. - -**Kind**: instance method of [MessageGetter](#MessageGetter) - -| Param | Type | -| ----- | ----------------------- | -| index | Uint8Array | - - - -### messageGetter.data(message_id) ⇒ Promise.<any> - -Get a message with the message id. - -**Kind**: instance method of [MessageGetter](#MessageGetter) - -| Param | Type | -| ---------- | ------------------- | -| message_id | string | - - - -### messageGetter.raw(message_id) ⇒ Promise.<any> - -Get the raw message with the message id. - -**Kind**: instance method of [MessageGetter](#MessageGetter) - -| Param | Type | -| ---------- | ------------------- | -| message_id | string | - - - -### messageGetter.children(message_id) ⇒ Promise.<any> - -Get the childrens of a message with the message id. - -**Kind**: instance method of [MessageGetter](#MessageGetter) - -| Param | Type | -| ---------- | ------------------- | -| message_id | string | - - - -### messageGetter.metadata(message_id) ⇒ Promise.<any> - -Get the metadata of a message with the message id. - -**Kind**: instance method of [MessageGetter](#MessageGetter) - -| Param | Type | -| ---------- | ------------------- | -| message_id | string | - - - -### MessageGetter.new(client) ⇒ [MessageGetter](#MessageGetter) - -**Kind**: static method of [MessageGetter](#MessageGetter) - -| Param | Type | -| ------ | ------------------------------ | -| client | [Client](#Client) | - - - -## UnspentAddressGetter - -**Kind**: global class - -- [UnspentAddressGetter](#UnspentAddressGetter) - - _instance_ - - [.accountIndex(index)](#UnspentAddressGetter+accountIndex) ⇒ [UnspentAddressGetter](#UnspentAddressGetter) - - [.initialAddressIndex(index)](#UnspentAddressGetter+initialAddressIndex) ⇒ [UnspentAddressGetter](#UnspentAddressGetter) - - [.get()](#UnspentAddressGetter+get) ⇒ Promise.<any> - - _static_ - - [.new(client, seed)](#UnspentAddressGetter.new) ⇒ [UnspentAddressGetter](#UnspentAddressGetter) - - - -### unspentAddressGetter.accountIndex(index) ⇒ [UnspentAddressGetter](#UnspentAddressGetter) - -Sets the account index - -**Kind**: instance method of [UnspentAddressGetter](#UnspentAddressGetter) - -| Param | Type | -| ----- | ------------------- | -| index | number | - - - -### unspentAddressGetter.initialAddressIndex(index) ⇒ [UnspentAddressGetter](#UnspentAddressGetter) - -Sets the index of the address to start looking for balance - -**Kind**: instance method of [UnspentAddressGetter](#UnspentAddressGetter) - -| Param | Type | -| ----- | ------------------- | -| index | number | - - - -### unspentAddressGetter.get() ⇒ Promise.<any> - -Get an unspent address with its index. - -**Kind**: instance method of [UnspentAddressGetter](#UnspentAddressGetter) - - -### UnspentAddressGetter.new(client, seed) ⇒ [UnspentAddressGetter](#UnspentAddressGetter) - -**Kind**: static method of [UnspentAddressGetter](#UnspentAddressGetter) - -| Param | Type | -| ------ | ------------------------------ | -| client | [Client](#Client) | -| seed | string | - - - -## start() - -Initializes the console error panic hook for better error messages - -**Kind**: global function diff --git a/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_01_get_info.mdx b/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_01_get_info.mdx deleted file mode 100644 index 0c70d6ec2a9..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_01_get_info.mdx +++ /dev/null @@ -1,37 +0,0 @@ -import LoadBalancerHealthChecks from '../../../_admonitions/_load_balancer_health_checks.md'; -import ClientBuilder from '../../../_partials/examples/01_get_info/_client_builder.md'; -import GetInfoOutput from '../../../_partials/examples/01_get_info/outputs/camelCase.md'; - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/wasm/examples/01_get_info.js -``` - -**Output example** of the `getInfo()` function of the `Client` instance: - - - - - - - -The most common ones are: - -- `.network(str)`: Can be either `devnet` or `mainnet`. It instructs - the library whether to automatically select devnet nodes or mainnet nodes. -- `.node(url)`: Specify address of actual running IOTA node that should be used - to communicate with in the format `https://node:port`). For example: `https://api.lb-0.h.chrysalis-devnet.iota.cafe:443`. -- `.nodePoolUrls(urls)`: The library also supports managing a pool of - nodes. You can provide a list of nodes and the library manages the access to them automatically by selecting them based - on their sync status. If you provide `.nodePoolUrls(urls)`, then the library periodically will periodically check whether node is in sync or - not by calling `.nodeSyncInterval(interval)`. -- `.localPow(bool)`: If `.localPow (True)` a Proof-of-work will be done - locally and not remotely. -- `.disableNodeSync()`: When called, the library will use nodes that - are **not** in sync with network. This parameter is usually useful if you would like to interact with a local test node - that is not fully synced. **This parameter should not be used in production**. - -The following example uses additional initialization chaining calls, such as leveraging a custom node: - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/wasm/examples/01b_get_info.js -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_02_generate_seed.mdx b/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_02_generate_seed.mdx deleted file mode 100644 index 34e0e3d618e..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_02_generate_seed.mdx +++ /dev/null @@ -1,6 +0,0 @@ -You can generate a seed, for example, using the SHA256 algorithm on some random input generated by a cryptographically -secure pseudo-random generator, such as `crypto.randomBytes()`: - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/wasm/examples/02_generate_seed.js -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_03_generate_addresses.mdx b/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_03_generate_addresses.mdx deleted file mode 100644 index 45b9cc700f1..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_03_generate_addresses.mdx +++ /dev/null @@ -1,38 +0,0 @@ -You can generate an IOTA address using the [`AddressGetter`](./../api_reference.md#addressgetter) helper -class and calling the [`Client.getAddresses()`](./../api_reference.md#getaddressesseed-addressgetter) -function and respective chaining calls that will return a list of tuples with the generated addresses. You can find -more information on the parameters in the [Address/Key Space section](./../../../explanations/address_key_space.md). - -The whole process is deterministic. This means the output is the same as long as the seed is the same: - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/wasm/examples/03_generate_addresses.js -``` - -**Output example**: - -```string -[ - 'atoi1qz6dr6dtl0856tf0pczz7gesrf7j8a4vr00q58ld2zx7ttlv3p96snpym9z', - 'atoi1qpp7sz28a0ghvd6knwnljr7j2s04qquduuc5vlz94fwf94zznj2yv5ew2c4', - 'atoi1qzje6zhg5vu456eg3z84ekcfn3laxqyczche5eeqhcdh3w9yr5sqvr4z4td', - 'atoi1qqwhxjmcvmatpedeedapgx0vwyupfwx9k5n4w0lnc5l6vmz78aavwhs55v0', - 'atoi1qzg63t9880jtfysvpq7rrynz0rqt3kd2fw8r4934ezraz9dpwvzxkw2dtmh' -] -``` - -IOTA addresses are represented by a checksumed base-32 string (Bech32). You can find a detailed explanation in the -[Chrysalis documentations](/introduction/reference/details#iota-15-address-anatomym), but here are -parts relevant to this example: - -- If an address starts with `atoi` then it means it is related to `devnet`. `iota` stands for `mainnet`. -- Number `1` at the 5th positvion is just a separator. -- The last 6 characters are reserved for a checksum. - -Addresses can be also represented in a hex format and `iota.rs` provides some convenient functions to convert addresses: -[`Client.bech32ToHex(address)`](./../api_reference.md#clientbech32tohexaddress--string) and -[`Client.hexToBech32(address, bech32)`](./../api_reference.md#clienthextobech32address-bech32--promiseany). - -If you want to quickly validate any IOTA address, you can use the -[`Client.isAddressValid()`](./../api_reference.md#clientisaddressvalidaddress--boolean) function that -returns a `bool` value. You should perform a sanity check on address before using it. diff --git a/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_04_get_balance.mdx b/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_04_get_balance.mdx deleted file mode 100644 index e4c82e541fc..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_04_get_balance.mdx +++ /dev/null @@ -1,45 +0,0 @@ -There are two API calls you can use to get a balance: - -## [`Client.getAddressBalances(addresses: any)`](./../api_reference.md#Client+getAddressBalances) - -A convenient function that expects `list` of addresses in Bech32 format and returns list of `dict` with balances for all -given addresses. - -## [`Client.getBalance(seed: string)`](./../api_reference.md#Client+getBalance) - -A convenient helper [`BalanceGetter`](./../api_reference.md#BalanceGetter) class that combines -[`Client.getAddresses(seed: string)`](./../api_reference.md#Client+getAddresses) and -`Client.getAddressBalances()` api calls. It returns a combined balance for the provided `seed` and optional chaining -calls [`.accountIndex(index)`](./../api_reference.md#BalanceGetter+accountIndex), -[`.initialAddressIndex(initial_address_index: number)`](./../api_reference.md#balancegetterinitialaddressindexinitial_address_index--codebalancegettercode) -and -[`.gap_limit(amount: number)`](./../api_reference.md#balancegettergap_limitgap_limit--codebalancegettercode) - -`Client.getBalance(seed: string)` performs several tasks under the hood. It starts by generating addresses for the -provided `seed` and `.accountIndex` from -[`.initialAddressIndex(initial_address_index: number)`](./../api_reference.md#BalanceGetter+initialAddressIndex), -and checks for a balance of each of the generated addresses. Since it does not know how many addresses are used in fact, -there is a condition set by the -[`.gap_limit(amount: number)`](./../api_reference.md#BalanceGetter+gap_limit) argument to know when to stop -searching. If the `.gap_limit` amount of addresses in a row have no balance, the function returns results and searching -does not continue. - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/wasm/examples/04_get_balance.js -``` - -Example of output: - -```json -{ - "address":"atoi1qp9427varyc05py79ajku89xarfgkj74tpel5egr9y7xu3wpfc4lkpx0l86", - "balance":10000000, - "dustAllowed":false, - "ledgerIndex": 2338924 -} -Account balance: 0 -``` - -- `dustAllowed` indicates whether the given address is allowed to accept a dust. You can learn more about dust - protection in the - [Chrysalis documentation](/introduction/explanations/faq#what-is-dust-protection-and-how-does-it-work). diff --git a/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_05_get_outputs.mdx b/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_05_get_outputs.mdx deleted file mode 100644 index 10ed2c66af7..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_05_get_outputs.mdx +++ /dev/null @@ -1,94 +0,0 @@ -- [`Client.getAddress().outputs(str)`](#clientgetaddressoutputsstr) -- [`Client.getOutput(str)`](#clientgetoutputstr) -- [`Client.findOutputs(output_ids (optional), addresses (optional))`](#clientfindoutputsoutput_ids-optional-addresses-optional) - -## Client.getAddress().outputs(str) - -This -[`Client.getAddress().outputs(str)`](./../api_reference.md#getaddressbuilderoutputsaddress-options--promiseany) -expects an address in Bech32 format and returns a `str[]` of `output_ids`. - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/wasm/examples/05a_get_address_outputs.js -``` - -**Output example**: - -```json -[ - "0f2d5d2651f8061a9f5417d0658009f32b2e3f77f9706b0be3b4b3f466171f360000", - "7614ba900a90b130707766a660a454942ac7cc4adea3fb9ad0cdca90114417c20000", - "768c20c15a290e02a43b83263a98501b9d7eb0b57da40a9247289c672de63ea60000" -] -``` - -## Client.getOutput(str) - -The function [`Client.getOutput(str)`](./../api_reference.md#clientgetoutputoutput_id--promiseany) can be -used to get metadata about the given `output_id`: - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/wasm/examples/05b_get_output.js -``` - -**Output example**: - -```json -{ - "messageId": "f303bc90a5ed3ef15af5fc6aa81a739978c59458a71e68ce8e380f1f534da1e6", - "transactionId": "0f2d5d2651f8061a9f5417d0658009f32b2e3f77f9706b0be3b4b3f466171f36", - "outputIndex": 0, - "isSpent": false, - "address": "atoi1qzt0nhsf38nh6rs4p6zs5knqp6psgha9wsv74uajqgjmwc75ugupx3y7x0r", - "amount": 1000000 -} -``` - -## Client.findOutputs(output_ids (optional), addresses (optional)) - -The function [`Client.findOutputs()`](./../api_reference.md#clientfindoutputsoutputs-addresses--promiseany) -is a convenient shortcut combining both `Client.getAddressOutputs(str)` and `Client.getOutput(str)` methods in a single -call. It supports two arguments, a list of `output_ids` or a list of `addresses`. - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/wasm/examples/05c_find_outputs.js -``` - -**Output example**: - -```json -[ - { - "messageId": "f303bc90a5ed3ef15af5fc6aa81a739978c59458a71e68ce8e380f1f534da1e6", - "transactionId": "0f2d5d2651f8061a9f5417d0658009f32b2e3f77f9706b0be3b4b3f466171f36", - "outputIndex": 0, - "isSpent": false, - "address": "atoi1qzt0nhsf38nh6rs4p6zs5knqp6psgha9wsv74uajqgjmwc75ugupx3y7x0r", - "amount": 1000000 - }, - { - "messageId": "825266a79c0ffb6001ed263eb150357863b7d0052627c5766e8ef5acd6fed533", - "transactionId": "768c20c15a290e02a43b83263a98501b9d7eb0b57da40a9247289c672de63ea6", - "outputIndex": 0, - "isSpent": false, - "address": "atoi1qzt0nhsf38nh6rs4p6zs5knqp6psgha9wsv74uajqgjmwc75ugupx3y7x0r", - "amount": 1000000 - } -] -``` - -- `messageId`: Refers to the encapsulating message in which the transaction was sent. -- `transactionId`, `outputIndex`: Refers to the output within the `SignedTransaction` payload. There may be several - `outputs` involved in a single transaction, so the `transactionId` by itself would not be enough. -- `output`: This section provides details about the iota address to which the given - [unspent transaction output](#unspent-transaction-output-utxo) is coupled with. -- `amount`: States an amount of tokens related to the `output`. -- `isSpent`: Indicates whether the given `output` is a part of the actual _ledger state_ or not. As mentioned in the - [Messages, Payloads, and Transactions section](../../../explanations/messages_payloads_and_transactions.md#unspent-transaction-output-utxo), - if an output was already spent it is not part of the ledger state any more and is replaced by some other `output(s)` - in the process. - -Notice that the `outputId` that was used in a function call to get output details is the same as a combination of the -`transactionId` and `outputIndex`. This way a transaction is tightly coupled with `outputs` since the -`SignedTransaction` payload is a main vehicle to create and spend `outputs`, and everything is encapsulated in a -[message](../../../explanations/messages_payloads_and_transactions.md#messages). diff --git a/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_06_simple_message.mdx b/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_06_simple_message.mdx deleted file mode 100644 index 133d2824a46..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_06_simple_message.mdx +++ /dev/null @@ -1,29 +0,0 @@ -The function [`Client.postMessage(message)`](./../api_reference.md#clientpostmessagemessage--promiseany) -accepts a message instance as a parameter and sends it over a network. Alternatively, there is a convenient -[MessageBuilder](./../api_reference.md#messagebuilder) helper class with chaining calls that prepares a -message instance and broadcasts it over the network. - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/nodejs/examples/06_simple_message.js -``` - -**Output example**: - -```string -{ - message: { - networkId: '14379272398717627559', - parentMessageIds: [ - '03ddc83fad172a322fb00fb4e449436e9d1117ff390879100647c650a30c2d52', - '252798210fa9816f6fd40f1b19095da9f2dc88ae06fc4c0523a928a29d0d782e', - 'a8e4f4cd49227068424ead8da187a48fdaa7ce8ffc4b9ac0ee2d5d3f2fcd7e70', - 'dbbc8044bc624b3378e1dda83ab95f9be468b06a6a9806c76a70353182028cf9' - ], - payload: null, - nonce: '9223372036854784215' - }, - messageId: '10dbee9cf3c58507725861b34ac711058dc13f709be1a6d21f1dc0af17b06379' -} -``` - -- `messageId` is a unique id that refers to the given message in the network. diff --git a/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_07_get_message_data.mdx b/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_07_get_message_data.mdx deleted file mode 100644 index 2d5e7d3134f..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_07_get_message_data.mdx +++ /dev/null @@ -1,53 +0,0 @@ -Once a [message](../../../explanations/messages_payloads_and_transactions.md#messages) is broadcast, you can use the -[`MessageGetter`](./../api_reference.md#messagegetter) helper class that you can instantiate using the -[`Client.getMessage()`](./../api_reference.md#clientgetmessage--codemessagegettercode) function to retrieve -it from the network. The `MessageGetter` provides helper functions related to the message, such as -[`Client.getMessage().data(message_id: String)`](./../api_reference.md#messagegetterdatamessage_id--promiseany) -and -[`Client.getMessage().metadata(message_id: String)`](./../api_reference.md#messagegettermetadatamessage_id--promiseany): - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/nodejs/examples/07_get_message_data.js -``` - -**Output example**: - -```json -Message meta data: -{ - "messageId":"e52b631bc7500366b90c6e11eb7fd6abaa7527f9bb5b4b512b0b9112bb9e7be8", - "parentMessageIds": [ - "26d72339ed262c1ec29d6c91de6be26d067b3327191f5e47606df53cc40e334e", - "6289ea0aecf3830e5e8d9925959bb6e804e324bb6db23c5701f7a538d12831f6", - "fdbf2d02603235fdff99f0ceb57705ead95041d62de386387f2922e5d9f6c502", - "ffa26139ca7f9d4849e118ff369fb3a387c8fefd8d15232b8353d4acf334324c" - ], - "isSolid":true, - "shouldPromote":false, - "shouldReattach":false -} - -Message data: -{ - "message": { - "networkId":"14379272398717627559", - "parentMessageIds": [ - "27782707e4cbf84ca26b3db881bbf39b6429f9ee736a0cbe5a1c177d7a52b05d", - "61cdf92c64a3304bbbabaf9fbfb0ea7ef9624e1eedea68efbe08595ccdf853e1", - "a222d13e3ee51b56b0b0e38140a5f7f813b6d9e29b752d7e1e2424099455080d", - "ab6bca20091b58dcbb0906438a7e47bfb11621c4a37b8d118b565f7f138a40d6" - ], - "payload": { - "type":2, - "index":"484f524e4554205370616d6d6572", - "data":"42696e61727920697320746865206675747572652e0a436f756e743a2031333936393530390a54696d657374616d703a20323032312d30352d33315431353a33363a30392b30323a30300a54697073656c656374696f6e3a203337c2b573" - }, - "nonce":"246736" - }, - "messageId":"30d87fa9917602e5685638e37802bde11b260bd2379f6c850704d7babd365b44" -} -``` - -- `Client.getMessage().metadata()` provides information on how the given message fits to network structures, such as - `ledger_inclusion_state`, etc. -- `Client.getMessage().data()` provides all the data that relates to the given message and its payload(s). diff --git a/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_08_data_message.mdx b/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_08_data_message.mdx deleted file mode 100644 index 95d6b9010fb..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_08_data_message.mdx +++ /dev/null @@ -1,29 +0,0 @@ -You can use the [MessageBuilder.data(data: Uint8Array)](./../api_reference.md#messagebuilderdatadata--codemessagebuildercode) function -function to attach data to a message. - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/nodejs/examples/08_data_message.js -``` - -**Output example**: - -```json -{ - "message": { - "networkId": "14379272398717627559", - "parentMessageIds": [ - "1a383abbe5f6a6b0899d718975c3119643aa784a68d04075f4e986fd7a0c0e4b", - "6098f889e31911833df7b7839e8b222d701ab496f7dfa1a719087edf4fa7ae52", - "a98b47db4e8254eccc738c968bd35b08a5491e56d6c1a18af298c42bbd8c3a46", - "da6796c0842c08de832c7948fffedc0d5adce372e50a108f26a128dba6096d31" - ], - "payload": { - "type": 2, - "index": "494f54412e52532042494e44494e47202d204e4f44452e4a53", - "data": "736f6d65207574662062617365642064617461" - }, - "nonce": "13835058055282176519" - }, - "messageId": "10f59c101cec669b0a0ba163bc777184c7f63455f5e771d42f910a1ba2ad20ff" -} -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_09_transaction.mdx b/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_09_transaction.mdx deleted file mode 100644 index 84609dfa7cb..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_09_transaction.mdx +++ /dev/null @@ -1,9 +0,0 @@ -Sending value-based messages is a very straightforward process if you use the -[`MessageBuilder`](./../api_reference.md#messagebuilder) helper class. You will only need to provide a valid seed by chaining a call to -[`.seed(seed: string)`](./../api_reference.md#messagebuilderseedseed--codemessagebuildercode) and -an output address and amount by chaining a call to [`.output(address: string, amount: BigInt)`](./../api_reference.md#messagebuilderoutputaddress-amount--codemessagebuildercode). The method will find valid -output(s) that can be used to fund the given amount(s) and the unspent amount will be sent to the same address. - -```js reference -https://github.com/iotaledger/iota.rs/tree/production/bindings/wasm/examples/09_transaction.js -``` diff --git a/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_running_examples.md b/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_running_examples.md deleted file mode 100644 index 5c449c0896e..00000000000 --- a/docs/build/iota.rs/1.4/docs/libraries/wasm/examples/_running_examples.md +++ /dev/null @@ -1,20 +0,0 @@ -## Prequisites - -Before you run the examples, please refer to the [Wasm Getting Started guide](./../../../getting_started/wasm.md) , and make sure you have [built the bindings](./../../../getting_started/wasm.md#build) for -`node.js`. - -## Run the Examples - -You can run the wasm example using the following command: - -```bash -npm run example:node -``` - -### For Web - -For the web examples, you should run the following command: - -```bash -npm run serve -``` diff --git a/docs/build/iota.rs/1.4/docs/overview.md b/docs/build/iota.rs/1.4/docs/overview.md deleted file mode 100644 index df2a304dbfe..00000000000 --- a/docs/build/iota.rs/1.4/docs/overview.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -description: The wallet library is a stateful package with a standardized interface for developers to build applications involving IOTA value transactions. -image: /img/banner/banner_client_lib_overview.png -keywords: - - layered overview - - high level - - low level - - stronghold - - value transactions - - explanation ---- - -# Overview - -![IOTA Client Library Overview](/img/banner/banner_client_lib_overview.png) - -The iota.rs library is designed to simplify how you connect and interact -with [nodes](/introduction/explanations/node_software) in the IOTA network. You can use it to generate -addresses, send messages, sign and send transactions, and more. - -Beyond establishing the initial connection to a node, iota.rs has no state. Operations use only the data you pass during -a call and have no effect on your software beyond returning a value. You are in complete control of the data flow in -your application. - -This stateless approach makes iota.rs easy to use and understand. But since you are in full control of data management, -you are also fully responsible for it, which could feel overwhelming if you handle complex or sensitive data. If you -plan on managing funds in your application, take a look at -our [wallet.rs library](/wallet.rs/welcome) instead. It allows you to manage your user's funds -safely, and it already includes our best security practices. It -uses [stronghold.rs](/stronghold.rs/welcome) to store sensitive data and iota.rs to communicate -with the IOTA network and, unlike iota.rs, it has a state. - -## Supported Languages - -We implemented the iota.rs library in [Rust](./getting_started/rust.md) and prepared bindings -for [JavaScript](./getting_started/nodejs.md), [Python](./getting_started/python.mdx) -, [Java](./getting_started/java/getting_started.mdx), and [Wasm](./getting_started/wasm.md). Every binding is adjusted for the -language's conventions and best practices. For example, Python developers avoid the Builder programming pattern, so our -Python binding uses named constructor arguments. However, we never change the meaning behind our API, which is equally -powerful no matter which language you choose. - -## Your Application In the IOTA Network - -Your application communicates with iota.rs either directly in Rust or through one of the language bindings. The iota.rs -library turns your requests into REST API calls and sends them to a node through the Internet. The node, in turn, -interacts with the rest of an IOTA network, which could be -the [main operational network (mainnet)](/introduction/reference/networks/mainnet) or -a [network for testing purposes (devnet)](/introduction/reference/networks/devnet). - -![A diagram that illustrates the text above. It has three layers: the application layer that includes iota.rs and its bindings, communication layer (the Internet network), and IOTA network layer with nodes that operate on one of the IOTA networks.](/img/overview/layered_overview.svg 'An overview of IOTA layers.') - -## API Design - -The iota.rs library exposes operations of two types. Clients interact with nodes by calling their REST API, and the -first group of operations mirrors the available calls. When your program invokes such an operation, it directly -translates it into a REST call to a node. See -the [node's REST API reference](https://editor.swagger.io/?url=https://raw.githubusercontent.com/rufsam/protocol-rfcs/master/text/0026-rest-api/0026-rest-api.yaml) -for a complete list of available endpoints. - -Operations from the first group tend to be too atomic and basic to use conveniently. The second group provides you with -higher-level helper functions. These functions represent an actual task and combine multiple basic operations -internally. For example, you can get your token balance by calling `getBalance`. It will first call `getAddresses`, then -call `getAddressBalances` for each address, and add the results together to return the total balance. See -the [full specification](./specs.mdx) for details. diff --git a/docs/build/iota.rs/1.4/docs/specs.mdx b/docs/build/iota.rs/1.4/docs/specs.mdx deleted file mode 100644 index f598d95945d..00000000000 --- a/docs/build/iota.rs/1.4/docs/specs.mdx +++ /dev/null @@ -1,1219 +0,0 @@ ---- -description: IOTA Client Library user-friendly API specifications. -image: /img/logo/iota_mark_light.png -keywords: - - definition - - message - - return - - types - - parameters - - address - - account - - reference ---- - -import RustStandard from './_admonitions/_rust_standard.md'; -import MinimumNodes from './_admonitions/_minimum_nodes.md'; -import ActiveDevelopment from './_admonitions/_active_development.md'; - -# High Level API Specification - -## Introduction - -This document specifies a user-friendly API used in the client libraries. The main implementation is in Rust, which will -receive automatically compiled client libraries in other languages via C or WebAssembly bindings. There are many crates -to support developers who want to create foreign function interfaces with native bindings. - -## Builder - -The data structure to initialize the instance of the Higher level client library. It is always called first when -starting a new interaction with the library. - - - -### Parameters - -#### network - -| Required | Default Value | Type | Definition | -| -------- | ------------- | ---- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| ✘ | devnet | &str | Optional, the network type can be "devnet" or "mainnet". If you don not provide a node url is provided, default nodes will be used for the specified network. Nodes that are not in this network will be ignored. | - -#### node - -| Required | Default Value | Type | Definition | -| -------- | ------------- | ---- | ----------------------------------------------------------------------- | -| ✘ | None | &str | The URL of the node you want to connect to; format: `https://node:port` | - -#### primary_node - -| Required | Default Value | Type | Definition | -| -------- | ------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| ✘ | None | &str, auth_name_pwd: Option<(&str, &str)> | The URL of a node to always you want to connect to first, if multiple nodes are available.
(optional) You can use a JWT and or name and password for basic authentication; format: `https://node:port`, Some("JWT"), Some("name", "password") | - -#### primary_pow_node - -| Required | Default Value | Type | Definition | -| -------- | ------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| ✘ | None | &str, auth_name_pwd: Option<(&str, &str)> | The URL of a node to always you want to connect to first when submitting a message with remote PoW, if multiple nodes are available. This will override primary_node in that case\*\*.
(optional) You can use a JWT or name and password for basic authentication; format: `https://node:port`, Some("JWT"), Some("name", "password") | - -#### permanode - -| Required | Default Value | Type | Definition | -| -------- | ------------- | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| ✘ | None | &str, auth_name_pwd: Option<(&str, &str)> | The URL of a permanode.
(optional) You can use a JWT or name and password for basic authentication; format: `https://node:port`, Some("JWT"), Some("name", "password") | - -#### node_auth - -| Required | Default Value | Type | Definition | -| -------- | ------------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| ✘ | None | &str, Option, Option<(&str, &str)> | The URL of a node to connect to with.
(optional)You can use a JWT and or name and password for basic authentication; format: `https://node:port`, Some("JWT"), Some("name", "password") | - -#### nodes - -| Required | Default Value | Type | Definition | -| -------- | ------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| ✘ | None | &[&str] | A list of nodes to connect to. You can add nodes are using the `https://node:port` format.
The amount of nodes specified in quorum_size is randomly selected from this node list to check for quorum based on the quorum threshold.
If quorum_size is not given the full list of nodes is checked. | - -#### node_sync_interval - -| Required | Default Value | Type | Definition | -| -------- | ----------------------- | ------------------- | --------------------------------------------------------------- | -| ✘ | Duration::from_secs(60) | std::time::Duration | The interval in milliseconds to check for node health and sync. | - -#### node_sync_disabled - -| Required | Default Value | Type | Definition | -| -------- | ------------- | ---- | ---------------------------------------------- | -| ✘ | false | bool | If disabled unhealthy nodes will also be used. | - -#### node_pool_urls - -| Required | Default Value | Type | Definition | -| -------- | ------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| ✘ | None | &[String] | A list of node_pool_urls from which nodes are added.
The amount of nodes specified in quorum_size is randomly selected from this node list to check for quorum based on the quorum threshold.
If quorum_size is not given the full list of nodes is checked. | - -#### quorum - -| Required | Default Value | Type | Definition | -| -------- | ------------- | ---- | ------------------------------------------------- | -| ✘ | false | bool | Defines if quorum should be used for the requests | - -##### quorum_size - -| Required | Default Value | Type | Definition | -| -------- | ------------- | ----- | ------------------------------------------------ | -| ✘ | 3 | usize | Defines how many nodes should be used for quorum | - -#### quorum_threshold - -| Required | Default Value | Type | Definition | -| -------- | ------------- | ----- | ------------------------------------------------------------------------- | -| ✘ | 66 | usize | Defines the % of nodes that need to return the same response to accept it | - -#### request_timeout - -| Required | Default Value | Type | Definition | -| -------- | ----------------------- | ------------------- | ---------------------------------------------------------------------------------------------- | -| ✘ | Duration::from_secs(30) | std::time::Duration | The amount of seconds a request can be outstanding to a node before it is considered timed out | - -#### api_timeout - -| Required | Default Value | Type | Definition | -| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| ✘ | Api::GetInfo: Duration::from_secs(2)),
Api::GetHealth: Duration::from_secs(2),
Api::GetPeers: Duration::from_secs(2),
Api::GetMilestone: Duration::from_secs(2),
Api::GetTips: Duration::from_secs(2),
Api::PostMessage: Duration::from_secs(2),
Api::PostMessageWithRemotePow: Duration::from_secs(30),
Api::GetOutput: Duration::from_secs(2) | HashMap<[Api],
std::time::Duration> | The amount of milliseconds a request to a specific API endpoint can be outstanding to a node before it is considered timed out. | - -##### local_pow - -| Required | Default Value | Type | Definition | -| -------- | ------------- | ---- | ------------------------------------------------------------------ | -| ✘ | True | bool | If not defined it defaults to local PoW to offload node load times | - -#### tips_interval - -| Required | Default Value | Type | Definition | -| -------- | ------------- | ---- | ----------------------------------------------------- | -| ✘ | 15 | u64 | Time interval during PoW when new tips get requested. | - -##### mqtt_broker_options - -| Required | Default Value | Type | Definition | -| -------- | --------------------------------------------- | ------------------------------- | ---------------------------------------------- | -| ✘ | True,
Duration::from_secs(30),
True | [BrokerOptions](#brokeroptions) | If not defined the default values will be used | - - - -### Return - -If you finalize the builder with `finish()` it will run the instance in the background. You do not need to worry about -handling the return object. - -## On Initialization - -On initialisation, calls the getNodeInfo API. This will check the health of each node in the node list, and put the -healthy nodes, which match the PoW settings and network in a synced `nodelist`. - -| Node metadata | Description | -| ------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| network | If this parameter does not match the global builder parameter, you should not add it to the synced nodelist. | -| pow | If the global local_pow parameter is set to false, then you should only use nodes with the PoW feature in the synced nodelist. | - -## Sync Process - -When you build `Client` instance (The instance used for calling the client APIs), the status of each listed node will be -checked. If the returned status of the node information is healthy, which means the node is synced, then this node will -be pushed into a `synced_nodes` list. The rust-like pseudocode of the `synced_nodes` construction process follows. The -node syncing process is repeated every 60 seconds by default. You can change this number by specifying the -initializer's `node_sync_interval` argument. - -```rust -synced_nodes = Vec::new() -for node in node_pool_urls{ - status = Client.get_info(node).await?; - if status == healthy{ - synced_nodes.push(node) - } -} -``` - -## General High Level API - -Here is the high level abstraction API collection with sensible default values for users easy to use. - -### message() - -A generic send function you can use to easily send a message. - -#### Parameters - -Depending on the provided values this function will create a message with: - -- No payload. -- An indexation payload. -- A transaction payload. -- A transaction payload containing an indexation payload. - -##### seed - -| Required | Default | Type | Definition | -| -------- | ------- | ------------------------ | --------------------------------------------------------------------------------- | -| ✘ | None | [Seed](#seed-2)(#seed-1) | The seed of the account you are going to spend from. Only needed for transactions | - -##### account_index - -| Required | Default | Type | Definition | -| -------- | ------- | ----- | ---------------------------------------------------------------------------------------- | -| ✘ | 0 | usize | The account index responsible for the value `✘` in the Bip32Path `m/44'/4218'/✘'/0'/0'`. | - -##### initial_address_index - -| Required | Default | Type | Definition | -| -------- | ------- | ----- | ------------------------------------------------------------------------------------------------------------------------- | -| ✘ | 0 | usize | The index from where to start looking for balance. Responsible for the value `✘` in the Bip32Path `m/44'/4218'/0'/0'/✘'`. | - -##### input - -| Required | Default | Type | Definition | -| -------- | ------- | --------- | -------------------------------------------------------------------------------------------- | -| ✘ | None | UtxoInput | Users can manually select their UtxoInputs, instead of having automatically selected inputs. | - -##### input_range - -| Required | Default | Type | Definition | -| -------- | ------- | ----- | ------------------------------------------------------------------------------------------------ | -| ✘ | 0..100 | Range | If custom inputs are provided, this custom range will be used to search for the input addresses. | - -##### output - -| Required | Default | Type | Definition | -| -------- | ------- | ------------------------------------ | --------------------------------------------------------------------------------------- | -| ✘ | None | address: &[String],
amount: u64 | Address you want to send to and amount to send. The address needs to be Bech32 encoded. | - -##### output_hex - -| Required | Default | Type | Definition | -| -------- | ------- | ------------------------------- | ------------------------------------------------------------------------------------ | -| ✘ | None | address: &str,
amount: u64 | Address you want to send to and amount to send. The address needs to be hex encoded. | - -##### index - -| Required | Default | Type | Definition | -| -------- | ------- | ------------ | ---------------------------------------------------------------------- | -| ✘ | None | &[u8] / &str | An optional indexation key for an indexation payload. 1-64 bytes long. | - -##### data - -| Required | Default | Type | Definition | -| -------- | ------- | ---------- | ----------------------------------------- | -| ✘ | None | Vec<u8> | Optional data for the indexation payload. | - -##### parents - -| Required | Default | Type | Definition | -| -------- | ------- | ----------------------- | ------------------------------------------------------- | -| ✘ | None | [MessageId](#messageid) | 1-8 optional parents [messageId](#messageid)to be used. | - -#### Return - -The [Message](#message-1) object we build. - -#### Implementation Details - -When implementing this function please make sure that you: - -- Validate inputs, such as address and seed to check that they are correct. -- Check if the account balance is bigger or equal to the value using method similar to [`get_balance()`](#get_balance). -- Build and validate the message with signed transaction payload accordingly. -- Get tips using the [`get_tips()`](#get_tips) method. -- Perform proof-of-work locally (if not set to remote). -- Send the message using the [`post_messages()`](#post_messages) method. - -### get_message() - -(`GET /api/v1/messages`) - -Endpoint collection of all GET messages. - -#### Parameters - -##### message_id - -| Required | Type | Definition | -| -------- | ----------------------- | ------------------------- | -| ✔ | [messageId](#messageid) | The message's identifier. | - -##### index - -| Required | Type | Definition | -| -------- | ------------ | ------------------ | -| ✔ | &[u8] / &str | An indexation key. | - -#### Returns - -Depending on the final calling method, users cam get different results according to their needs: - -- `metadata(&MessageId)`: Returns [MessageMetadata](#messagemetadata) of the message. -- `data(&MessageId)`: Returns a [Message](#message-1) object. -- `raw(&MessageId)`: Returns the raw data of given message. -- `children(&MessageId)`: Returns the list of [MessageId](#messageid)s that reference a message by its identifier. -- `index(&[u8] | &str)` : Returns the list of [MessageId](#messageid)s that have this str as indexation key - -### find_messages() - -Find all messages using the provided message IDs. - -#### Parameters - -##### indexation_keys - -| Required | Type | Definition | -| -------- | -------------- | ---------------------------------------- | -| ✘ | [&[u8] / &str] | The index key of the indexation payload. | - -##### message_ids - -| Required | Type | Definition | -| -------- | ----------------------- | ------------------------- | -| ✘ | [MessageId](#messageid) | The message's identifier. | - -#### Returns - -A vector of [Message](#message-1) Object. - -### get_unspent_address() - -Return a valid unspent public Bech32 encoded address. - -#### Parameters - -##### seed - -| Required | Default | Type | Definition | -| -------- | ------- | --------------- | ------------------------ | -| ✔ | - | [Seed](#seed-2) | The seed we want to use. | - -##### account_index - -| Required | Default | Type | Definition | -| -------- | ------- | ----- | --------------------------------------------------------------------------------------------- | -| ✘ | 0 | usize | The account index.
Responsible for the value `✘` in the Bip32Path `m/44'/4218'/✘'/0'/0'`. | - -##### initial_address_index - -| Required | Default | Type | Definition | -| -------- | ------- | ----- | ------------------------------------------------------------------------------------------------------------------- | -| ✘ | 0 | usize | Start index of the addresses to search.
Responsible for the value `✘` in the Bip32Path `m/44'/4218'/0'/0'/✘'`. | - -#### Return - -Return a tuple with type of `(String, usize)` as the address and corresponding index in the account. - -#### Implementation Details - -Please make sure that you follow these steps when implementing this method: - -- Start by generating addresses with given account index and starting index. We have a - default [gap limit](https://blog.blockonomics.co/bitcoin-what-is-this-gap-limit-4f098e52d7e1) of 20 at a time. -- Check for balances on the generated addresses using the [find_outputs()](#find_outputs) method and keep track of the - positive balances. -- Repeat the above step until you find an unspent address. -- Return the address with corresponding index on the wallet chain. - -### get_addresses() - -Returns a list of addresses from the seed regardless of their validity. - -#### Parameters - -##### seed - -| Required | Default | Type | Definition | -| -------- | ------- | --------------- | -------------------------------- | -| ✔ | None | [Seed](#seed-2) | The seed you want to search for. | - -##### account_index - -| Required | Default | Type | Definition | -| -------- | ------- | ----- | --------------------------------------------------------------------------------------------- | -| ✘ | 0 | usize | The account index.
Responsible for the value `✘` in the Bip32Path `m/44'/4218'/✘'/0'/0'`. | - -##### range - -| Required | Default | Type | Definition | -| -------- | ------- | --------------- | ------------------------------------------------------------------------- | -| ✘ | None | std::ops::Range | Range indices of the addresses you want to search for. Default is (0..20) | - -##### get_all - -| Required | Default | Type | Definition | -| -------- | ------- | ---- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| ✘ | ✘ | ✘ | Get public and [change addresses](https://bitcoin.stackexchange.com/questions/75033/bip44-and-change-addresses).
Will return Vec<([String], bool)>, where the bool is indicating whether it is a change address | - -#### Return - -A Vec<[String]>, with the public addresses - -### get_balance() - -Returns the balance for a provided seed and its wallet account index. - -#### Parameters - -##### seed - -| Required | Default | Type | Definition | -| -------- | ------- | --------------- | -------------------------------- | -| ✔ | - | [Seed](#seed-2) | The seed you want to search for. | - -##### account_index - -| Required | Default | Type | Definition | -| -------- | ------- | ----- | ---------------------------------------------------------------------------------------------- | -| ✘ | 0 | usize | The account index.
Responsible for the value `✘` in the Bip32Path `m/44'/4218'/✘'/0'/0'`. | - -##### initial_address_index - -| Required | Default | Type | Definition | -| -------- | ------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| ✘ | 0 | usize | Start index from which to generate addresses. The default valu is 0.
Responsible for the value `✘` in the Bip32Path `m/44'/4218'/0'/0'/✘'`. | - -##### gap_limit - -| Required | Default | Type | Definition | -| -------- | ------- | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| ✘ | 20 | usize | The gap limit specifies how many addresses will be checked each round.
If gap_limit amount of addresses in a row have no balance the function will return. | - -#### Return - -Total account balance. - -#### Implementation Details - -Please make sure to follow these steps when you are implementing this method: - -- Start by generating addresses with given wallet account index and starting index. You will have a - default [gap limit](https://blog.blockonomics.co/bitcoin-what-is-this-gap-limit-4f098e52d7e1) of 20 at a time. -- Check for balances on the generated addresses using the [`find_outputs()`](#find_outputs) method and keep track of the - positive balances. -- Repeat the step above until you find an address with zero balance; -- Accumulate the positive balances and return the result. - -### get_address_balances() - -Return the balance in iota for the given addresses. You do not need a seed or security level to do this since you are -only checking and already know the addresses. - -#### Parameters - -##### addresses - -| Required | Type | Definition | -| -------- | ---------- | --------------------------------- | -| ✔ | [[String]] | List of Bech32 encoded addresses. | - -#### Return - -A list of tuples with value of [AddressBalancePair](#addressbalancepair). The usize is the balance of the address. - -#### Implementation details - -Please make sure to follow these steps when implementing this method: - -- Validate the _address_ semantics. -- Get the latest balance for the provided address using the [`find_outputs()`](#find_outputs) method with the addresses - as parameter. -- Return the list of Output which contains corresponding pairs of addresses and balances. - -### generate_mnemonic() - -Returns a random generated Bip39 mnemonic with words from the English word list. - -#### Return - -Parsed [String]. - -### mnemonic_to_hex_seed(mnemonic) - -Returns the hex encoded seed. - -#### Parameters - -##### mnemonic - -| Required | Type | Definition | -| -------- | -------- | ------------------------------------------------------- | -| ✔ | [String] | A Bip39 mnemonic with words from the English word list. | - -#### Return - -Parsed [String]. - -### bech32_to_hex() - -Returns a parsed hex String from bech32. - -#### Parameters - -#### bech32 - -| Required | Type | Definition | -| -------- | -------- | ----------------------- | -| ✔ | [String] | Bech32 encoded address. | - -#### Return - -Parsed [String]. - -### hex_to_bech32() - -Returns a parsed bech32 String from hex. - -#### Parameters - -##### hex - -| Required | Type | Definition | -| -------- | -------- | -------------------- | -| ✔ | [String] | Hex encoded address. | - -##### bech32_hrp - -| Required | Type | Definition | -| -------- | ----------------- | -------------------- | -| ✔ | [Option] | Optional bech32 hrp. | - -#### Return - -A parsed [String]. - -### parse_bech32_address() - -Returns a valid [Address](#address) parsed from a String. - -#### Parameters - -##### address - -| Required | Type | Definition | -| -------- | -------- | ----------------------- | -| ✔ | [String] | Bech32 encoded address. | - -#### Return - -A parsed [Address]. - -### is_address_valid() - -#### Parameters - -##### address - -| Required | Type | Definition | -| -------- | -------- | ----------------------- | -| ✔ | [String] | Bech32 encoded address. | - -#### Return - -A boolean showing if the address is valid. - -### subscriber() - -Subscribe to a node event [Topic](#topic)(MQTT). - -Requires one of: - -- `topic()`: Add a new [Topic](#topic) to the list. -- `topics()`: Add a vector of [Topic](#topic) to the list. -- `subscribe()`: Subscribe to the given topics with the callback, which will be called every time when the topic is - detected. -- `unsubscribe()`: Unsubscribes from all subscriptions. -- `disconnect()`: Disconnects the broker. This will clear the stored topic handlers and close the MQTT connection. - -#### Returns - -An `Ok(())` result if the call was successful. - -### retry() - -Retries (promotes or reattaches) a message for the provided [messageId](#messageid) if the node suggests it. As the -confirmation throughput of the node is expected to be quite high, you should not need to use this function often. - -#### Parameters - -##### message_id - -| Required | Type | Definition | -| -------- | ----------------------- | -------------------------- | -| ✔ | [messageId](#messageid) | The identifier of message. | - -#### Returns - -A tuple with the newly promoted or reattached `(MessageId, Message)`. - -#### Implementation Details - -Please make sure to follow these steps when implementing this method: - -- You should only allow unconfirmed messages to retry. The method will validate the confirmation state of the provided - messages. If a message id of a confirmed message is provided, the method will return an error. -- The method will also validate if a retry is necessary. This can be done by leveraging - the `/messages/{messageId}/metadata` endpoint (already available through [get_message](#get_message)). - See [this](https://github.com/iotaledger/trinity-wallet/blob/develop/src/shared/libs/iota/transfers.js#L105-L131) - implementation for reference. -- Use [reattach](#reattach) or [promote](#promote) accordingly. - -### retry_until_included() - -Retries (promotes or reattaches) a message for provided [messageId](#messageid) until it is included (referenced by a -milestone). The default interval is 5 seconds and the max number of attempts is 40. As the confirmation throughput of -the node is expected to be quite high, you should not need to use this function often. - -#### Parameters - -##### message_id - -| Required | Type | Definition | -| -------- | -------------------------- | -------------------------- | -| ✔ | [&[MessageId](#messageid)] | The identifier of message. | - -##### interval - -| Required | Type | Definition | -| -------- | -------------- | ------------------------------------------- | -| ✘ | Option<u64> | The interval in which we retry the message. | - -##### max_attempts - -| Required | Type | Definition | -| -------- | -------------- | --------------------------------------------- | -| ✘ | Option<u64> | The maximum of attempts we retry the message. | - -#### Returns - -An array of tuples with the newly reattached `(MessageId, Message)`. - -### consolidate_funds() - -You can use this function to consolidate all funds from a range of addresses to the address with the lowest index in -that range. - -#### Parameters - -##### seed - -| Required | Type | Definition | -| -------- | --------------- | -------------------------------- | -| ✔ | [Seed](#seed-2) | The seed you want to search for. | - -##### account_index - -| Required | Type | Definition | -| -------- | ----- | --------------------------------------------------------------------------------------------- | -| ✘ | usize | The account index.
Responsible for the value `✘` in the Bip32Path `m/44'/4218'/✘'/0'/0'`. | - -##### address_range - -| Required | Type | Definition | -| -------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| ✘ | Range | Range from which to generate public and internal addresses from which to consolidate the funds.
Responsible for the value `✘` in the Bip32Path `m/44'/4218'/0'/0'/✘'`. | - -#### Returns - -The address in which the funds got consolidated. - -### reattach() - -Depends on [find_messages](#find_messages), [get_message](#get_message) and [post_message](#post_message). - -Reattaches a message. The method will validate if a reattachment is necessary using the [get_message](#get_message) -method. If a reattachment is not necessary, the method will error out and will not allow unnecessary reattachments. - -#### Parameters - -##### message_id - -| Required | Type | Definition | -| -------- | ----------------------- | -------------------------- | -| ✔ | [messageId](#messageid) | The identifier of message. | - -#### Returns - -A tuple with the newly reattached `(MessageId, Message)`. - -### promote() - -Depends on [find_messages](#find_messages), [get_message](#get_message) and [post_message](#post_message). - -Reattaches a message. The method will validate if a reattachment is necessary using the [get_message](#get_message) -method. If a promotion is not necessary, the method will error out and will not allow unnecessary promotions. - -#### Parameters - -#### message_id - -| Required | Type | Definition | -| -------- | ----------------------- | -------------------------- | -| ✔ | [messageId](#messageid) | The identifier of message. | - -#### Returns - -A tuple with the newly promoted `(MessageId, Message)`. - -## Full Node API - -The full node APIs of [Hornet](/hornet/welcome) will -still be public. Users who are familiar with these relative low level Restful APIs can still call them directly if they -are confident in their usage. - - - -### get_health() - -(`GET /health`) - -Returns the health of the node, which can be used for load-balancing or uptime monitoring. - -#### Parameters - -None. - -#### Returns - -Boolean to indicate if node is healthy. - -### get_peers() - -(`GET /peers`) - -Get information about the peers of the node. - -#### Parameters - -None. - -#### Returns - -```Rust -pub struct PeerDto { - pub id: String, - #[serde(rename = "multiAddresses")] - pub multi_addresses: Vec, - pub alias: Option, - pub relation: RelationDto, - pub connected: bool, - pub gossip: Option, -} -``` - -### get_info() - -(`GET /api/v1/info`) - -Returns information about the node. - -#### Parameters - -None - -#### Returns - -A Response Object similar to: - -```rust -pub struct NodeInfoWrapper { - pub nodeinfo: NodeInfo, - pub url: String, -} -pub struct NodeInfo { - pub name: String, - pub version: String, - pub is_healthy: bool, - pub network_id: String, - pub latest_milestone_index: usize, - pub min_pow_score: f64, - pub messages_per_second: f64, - pub referenced_messages_per_second: f64, - pub referenced_rate: f64, - pub latest_milestone_timestamp: u64, - pub confirmed_milestone_index: usize, - pub pruning_index: usize, - pub features: Vec, -} -``` - -### get_tips() - -(`GET /tips`) - -Returns two non-lazy tips. If the node can only provide one tip, tip1 and tip2 will be identical. - -#### Parameters - -None. - -#### Returns - -A tuple with two [[MessageId](#messageid)]s: - -```rust -(MessageId, MessageId) -``` - -### post_message() - -(`POST /message`) - -Submits a message. The node will take care of any missing fields and attempt to build the message. On success, the -message will be stored in the Tangle. This endpoint will return the identifier of the message. - -#### Parameters - -##### message - -| Required | Type | Definition | -| -------- | --------------------- | ------------------- | -| ✔ | [Message](#message-1) | The message object. | - -#### Returns - -The [messageId](#messageid) of the message object. - -### get_output() - -(`GET /outputs`) - -Get the producer of the output, the corresponding address, amount and spend status of an output. This information can -only be retrieved for outputs which are part of a confirmed transaction. - -#### Parameters - -##### output_id - -| Required | Type | Definition | -| -------- | --------- | ------------------------- | -| ✔ | UtxoInput | Identifier of the output. | - -#### Returns - -An [OutputMetadata](#outputmetadata) that contains information about the output. - -### get_address() - -(`GET /addresses`) - -#### Parameters - -##### address - -| Required | Type | Definition | -| -------- | -------- | -------------------------- | -| ✔ | [String] | The address to search for. | - -#### Returns - -Depending on the final calling method, you can get different outputs you need: - -- `balance()`: Returns the confirmed balance of the address. -- `outputs([options])`: Returns the UtxoInput array (transaction IDs with corresponding output index). - -### find_outputs() - -Find all outputs based on the requests criteria. - -#### Parameters - -##### output_id - -| Required | Type | Definition | -| -------- | ----------- | ------------------------- | -| ✘ | [UtxoInput] | The identifier of output. | - -##### addresses - -| Required | Type | Definition | -| -------- | ---------- | --------------------------- | -| ✘ | [[String]] | The Bech32 encoded address. | - -#### Returns - -A vector of [OutputMetadata](#outputmetadata). - -### get_milestone() - -(`GET /milestones`) - -Get the milestone by the given index. - -#### Parameters - -##### index - -| Required | Type | Definition | -| -------- | ---- | ----------------------- | -| ✔ | u32 | Index of the milestone. | - -#### Returns - -An [[Milestone](#milestone)] object. - -### get_milestone_utxo_changes() - -(`GET /milestones/{}/utxo-changes`) - -Get all UTXO changes of a given milestone. - -#### Parameters - -##### index - -| Required | Type | Definition | -| -------- | ---- | ----------------------- | -| ✔ | u32 | Index of the milestone. | - -#### Returns - -```Rust -MilestoneUTXOChanges { - index: 1, - created_outputs: [], - consumed_outputs: [], -} -``` - -### get_receipts() - -(`GET /receipts`) - -Get all receipts. - -#### Returns - -```Rust -Vec -``` - -### get_receipts_migrated_at() - -(`GET /receipts/{migratedAt}`) - -Get all receipts for a given milestone index. - -#### Returns - -```Rust -Vec -``` - -### get_treasury() - -(`GET /treasury`) - -Get the treasury amount. - -#### Returns - -```Rust -pub struct TreasuryResponse { - #[serde(rename = "milestoneId")] - milestone_id: String, - amount: u64, -} -``` - -### get_included_message() - -(`GET /transactions/{transactionId}/included-message`) - -Get the included message of the transaction. - -#### Parameters - -##### transaction_id - -| Required | Type | Definition | -| -------- | ------------- | -------------------------- | -| ✔ | TransactionId | The id of the transaction. | - -#### Returns - -```Rust -struct Message { - parents: Vec, - payload: Option, - nonce: u64, -} -``` - -## Objects - -The objects used in the [API](#full-node-api) aim to provide a secure way to handle certain data structures specified in the IOTA -stack. - -### Address - -An Ed25519 address which can be encoded in either Bech32 or Hex. Bech32 is preferred and used in most functions. - -```Rust -pub enum Address { - Ed25519(Ed25519Address), -} -``` - -### AddressBalancePair - -```Rust -pub struct AddressBalancePair { - /// Address, bech32 encoded - pub address: String, - /// Balance in the address - pub balance: u64, - /// If dust is allowed on the address - pub dust_allowed: bool, -} -``` - -### Api - -```Rust -pub enum Api { - /// `get_health` API - GetHealth, - /// `get_info`API - GetInfo, - /// `get_tips` API - GetTips, - /// `post_message` API - PostMessage, - /// `post_message` API with remote pow - PostMessageWithRemotePow, - /// `get_output` API - GetOutput, - /// `get_milestone` API - GetMilestone, -} -``` - -### BrokerOptions - -```Rust -pub struct BrokerOptions { - #[serde(default = "default_broker_automatic_disconnect", rename = "automaticDisconnect")] - pub(crate) automatic_disconnect: bool, - #[serde(default = "default_broker_timeout")] - pub(crate) timeout: std::time::Duration, - #[serde(rename = "maxReconnectionAttempts", default)] - pub(crate) max_reconnection_attempts: usize, -} -``` - -### Message - -The message object returned by various functions. Based on -the [RFC](https://github.com/GalRogozinski/protocol-rfcs/blob/message/text/0017-message/0017-message.md) for the Message -object. The following is a brief overview of how each of the components in a Message type will look like: - -```rust -struct Message { - parents: Vec, - payload: Option, - nonce: u64, -} - -enum Payload { - Transaction(Box), - Milestone(Box), - Indexation(Box), -} - -struct Transaction { - pub essence: TransactionPayloadEssence, - pub unlock_blocks: Vec, -} - -struct Milestone { - essence: MilestoneEssence, - signatures: Vec>, -} - -struct Indexation { - index: String, - data: Box<[u8]>, -} - -struct TransactionPayloadEssence { - pub(crate) inputs: Box<[Input]>, - pub(crate) outputs: Box<[Output]>, - pub(crate) payload: Option, -} - -enum Input { - UTXO(UtxoInput(OutputId)), -} - -struct OutputId { - transaction_id: TransactionId, - index: u16, -} - -enum Output { - SignatureLockedSingle(SignatureLockedSingleOutput), -} - -struct SignatureLockedSingleOutput { - address: Address, - amount: u64, -} - -enum UnlockBlock { - Signature(SignatureUnlock), - Reference(ReferenceUnlock), -} - -enum SignatureUnlock { - Ed25519(Ed25519Signature), -} - -struct Ed25519Signature { - public_key: [u8; 32], - signature: Box<[u8]>, -} - -struct ReferenceUnlock(u16); -``` - -### MessageId - -A 32 bytes array which can represent as hex string. - -```rust -struct MessageId([u8; MESSAGE_ID_LENGTH]); -``` - -### MessageMetadata - -```rust -pub struct MessageMetadata { - /// Message ID - pub message_id: String, - /// Message IDs of parents - pub parents: Vec, - /// Solid status - pub is_solid: bool, - /// Should promote - pub should_promote: Option, - /// Should reattach - pub should_reattach: Option, - /// Referenced by milestone index - pub referenced_by_milestone_index: Option, - /// Ledger inclusion state - pub ledger_inclusion_state: Option, -} -``` - -### Milestone - -A milestone metadata. - -```rust -pub struct MilestoneMetadata { - /// Milestone index - pub milestone_index: u32, - /// Milestone ID - pub message_id: String, - /// Timestamp - pub timestamp: u64, -} -``` - -### OutputMetadata - -The metadata of an output. - -```rust -pub struct OutputMetadata { - /// Message ID of the output - pub message_id: Vec, - /// Transaction ID of the output - pub transaction_id: Vec, - /// Output index. - pub output_index: u16, - /// Spend status of the output - pub is_spent: bool, - /// Corresponding address - pub address: Address, - /// Balance amount - pub amount: u64, -} -``` - -### Seed - -An IOTA seed with its inner structure omitted. You can create this type by passing a String. It will verify and return -an error if it is not valid. - -```Rust -pub enum Seed { - /// Ed25519 variant - Ed25519(Ed25519Seed) -} -``` - -### Topic - -A string with the exact MQTT topic to monitor. It can have one of the following variations: - -``` -milestones/latest -milestones/confirmed - -messages -messages/referenced -messages/indexation/{index} -messages/{messageId}/metadata -transactions/{transactionId}/included-message - -outputs/{outputId} - -addresses/{address}/outputs -addresses/ed25519/{address}/outputs -``` diff --git a/docs/build/iota.rs/1.4/docs/troubleshooting.md b/docs/build/iota.rs/1.4/docs/troubleshooting.md deleted file mode 100644 index 62cb7751c09..00000000000 --- a/docs/build/iota.rs/1.4/docs/troubleshooting.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -description: Troubleshooting the IOTA Client Library. -image: /img/logo/libraries.png -keywords: - - discussion - - channel - - problem - - solution - - discord - - stackexchange - - reference ---- - -# Troubleshooting - -## StackExchange - -The [IOTA StackExchange](https://iota.stackexchange.com/) -is an excellent tool for developers to find answers to their problems. Just search for your problem and find your -answer! If there is no answer yet, submit your question and share it in the discussion channel below. - -## Join the Discussion - -If you want to get involved in discussions about this library, or you are looking for support, you can visit -the [#clients-libraries](https://discord.com/channels/397872799483428865/800637917189636136) channel on -our [Discord](https://discord.iota.org). diff --git a/docs/build/iota.rs/1.4/docs/welcome.md b/docs/build/iota.rs/1.4/docs/welcome.md deleted file mode 100644 index e2366ce344e..00000000000 --- a/docs/build/iota.rs/1.4/docs/welcome.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -description: Official IOTA Client Library which can be used to easily integrate an IOTA Client into your application -image: /img/banner/banner_client_lib.png -keywords: - - requirements - - software - - library - - rust - - python - - nodejs - - explanation ---- - -# Welcome - -:::caution -This is documentation for iota.rs, which is no longer actively maintained. -For up-to-date documentation, see the documentation for its successor the [IOTA SDK](/iota-sdk/welcome). -::: - -![IOTA Client Library](/img/banner/banner_client_lib.png) - -The iota.rs library handles communications between your software and the IOTA network. - -The iota.rs library is free and open-source, and it will be. Both the IOTA Foundation and the IOTA community maintain -the library and this wiki, which means that you can rely on it as a source of knowledge on iota.rs. Start exploring it -from the [Overview](overview.md) page. - -If you have questions, jump into a discussion or start a new one on our [Discord server](https://discord.iota.org) or -ask questions and find answers at our [community on Stack Exchange](https://iota.stackexchange.com/). If you wish to -contribute to the project, make sure that you read our [contribution guide](./contribute.md). - -We are glad that you are here! diff --git a/docs/build/iota.rs/1.4/sidebars.js b/docs/build/iota.rs/1.4/sidebars.js deleted file mode 100644 index e91cbd6e5f2..00000000000 --- a/docs/build/iota.rs/1.4/sidebars.js +++ /dev/null @@ -1,132 +0,0 @@ -/** - * * Creating a sidebar enables you to: - - create an ordered group of docs - - render a sidebar for each doc of that group - - provide next/previous navigation - - The sidebars can be generated from the filesystem, or explicitly defined here. - - Create as many sidebars as you want. - */ -module.exports = { - docs: [ - { - type: 'doc', - id: 'welcome', - }, - { - type: 'doc', - id: 'overview', - }, - { - type: 'category', - label: 'Getting Started', - items: [ - { - type: 'doc', - id: 'getting_started/required_prior_knowledge', - }, - { - type: 'category', - label: 'Java', - items: [ - 'getting_started/java/getting_started', - 'getting_started/java/android_development', - ], - }, - { - type: 'doc', - id: 'getting_started/nodejs', - label: 'Nodejs', - }, - { - type: 'doc', - id: 'getting_started/python', - label: 'Python', - }, - { - type: 'doc', - id: 'getting_started/rust', - label: 'Rust', - }, - { - type: 'doc', - id: 'getting_started/wasm', - label: 'Wasm', - }, - ], - }, - { - type: 'category', - label: 'Explanations', - items: [ - 'explanations/seeds', - 'explanations/address_key_space', - 'explanations/messages_payloads_and_transactions', - ], - }, - { - type: 'category', - label: 'Examples', - items: [ - 'examples/running_examples', - 'examples/get_info', - 'examples/generate_seed', - 'examples/generate_addresses', - 'examples/get_balance', - 'examples/get_outputs', - 'examples/simple_message', - 'examples/get_message_data', - 'examples/data_message', - 'examples/transaction', - 'examples/mqtt', - ], - }, - { - type: 'category', - label: 'API Reference', - items: [ - { - type: 'doc', - id: 'libraries/java/api_reference', - label: 'Java', - }, - { - type: 'doc', - id: 'libraries/nodejs/api_reference', - label: 'Node.js', - }, - { - type: 'doc', - id: 'libraries/python/api_reference', - label: 'Python', - }, - { - type: 'doc', - id: 'libraries/rust/api_reference', - label: 'Rust', - }, - { - type: 'doc', - id: 'libraries/wasm/api_reference', - label: 'Wasm', - }, - ], - }, - { - type: 'doc', - id: 'specs', - label: 'Specification', - }, - { - type: 'doc', - id: 'troubleshooting', - label: 'Troubleshooting', - }, - { - type: 'doc', - id: 'contribute', - label: 'Contribute', - }, - ], -}; diff --git a/docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_api_ref_coming_soon.md b/docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_api_ref_coming_soon.md deleted file mode 100644 index 48fe7581fd4..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_api_ref_coming_soon.md +++ /dev/null @@ -1,5 +0,0 @@ -:::tip Coming Soon - -The API reference for this language is a work in progress. In the meantime, please use the Rust API. - -::: diff --git a/docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_dot_env_warning.md b/docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_dot_env_warning.md deleted file mode 100644 index 3fe3f9ddabf..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_dot_env_warning.md +++ /dev/null @@ -1,5 +0,0 @@ -:::warning Dotenv - -This example uses dotenv, which is not safe to use in production environments. - -::: diff --git a/docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_guide_coming_soon.md b/docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_guide_coming_soon.md deleted file mode 100644 index 81fc486f568..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_guide_coming_soon.md +++ /dev/null @@ -1,6 +0,0 @@ -:::tip Guide Coming Soon - -This how to guide is not available in your language of choice at the moment. -Please feel free to browse [more examples](./../how_tos/15_more_examples.mdx) which may suit your requirements. - -::: diff --git a/docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_iotajs_example.mdx b/docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_iotajs_example.mdx deleted file mode 100644 index 4e76547c85d..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_iotajs_example.mdx +++ /dev/null @@ -1,5 +0,0 @@ -:::tip Iota.js - -You can also find this guide in the native iota.js library - -::: diff --git a/docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_password_storage.md b/docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_password_storage.md deleted file mode 100644 index 1b60dd89dd6..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_password_storage.md +++ /dev/null @@ -1,7 +0,0 @@ -:::warning Password Storage - -Never store passwords or seeds on a host's environment variables or in the source code in a production -setup. Please follow our [backup and security](/introduction/how_tos/backup_security) -recommendations for production use. - -::: diff --git a/docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_wallet_transaction_recommendation.md b/docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_wallet_transaction_recommendation.md deleted file mode 100644 index 63abab9349e..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/_admonitions/_wallet_transaction_recommendation.md +++ /dev/null @@ -1,8 +0,0 @@ -:::info Wallet.rs - -Though it is possible to send transactions with `iota.rs`, we strongly recommend that you use the official -[`wallet.rs`](/wallet.rs/welcome) library together with the -[`stronghold.rs`](/stronghold.rs/welcome) enclave for value-based transfers. This combination -incorporates the best security practices while dealing with seeds, related addresses, and UTXO. - -::: diff --git a/docs/build/iota.rs/2.0-rc.7/docs/contribute.md b/docs/build/iota.rs/2.0-rc.7/docs/contribute.md deleted file mode 100644 index 9c5a1b36ced..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/contribute.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -description: Contribute to the IOTA Client Library joining the IOTA Libraries Initiative, contributing to the official GitHub repository or sharing your knowledge on Discord. -image: /img/logo/iota_mark_light.png -keywords: - - join - - documentation - - project - - contribute - - discord - - GitHub ---- - -# Contribute to the Project - -**Thanks for thinking about contributing to the project! We have the following ways that you can contribute.** - -## Join the IOTA Libraries Initiative - -The [IOTA Libraries Initiative](https://github.com/iota-community/X-Team_IOTA_Libraries) is a collaborative effort to help improve the developer experience. - -- Quality assurance and review -- Documentation -- Code samples - -If you'd like to get involved, join the #experience channel on [Discord](https://discord.iota.org). - -## Contribute to the project's GitHub repository - -All the code is open source and hosted on [GitHub](https://github.com/iotaledger/iota.rs) where you can do the following: - -- Report a bug -- Suggest a new feature -- Contribute to the documentation - -## Contribute to the documentation - -This documentation is also open source and hosted on GitHub. - -If you want to contribute new documentation or fix an error, see the [contribution guidelines](https://github.com/iotaledger/documentation/blob/develop/.github/CONTRIBUTING.md). - -## Share your knowledge - -Helping others is an important part of any open source ecosystem. - -By sharing your knowledge with others, you can provide a lot of value to the community and maybe inspire someone else to learn and contribute. - -Take a look at what discussions are going on in the #clients-discussion channel on [Discord](https://discord.iota.org). - -Thanks :heart: diff --git a/docs/build/iota.rs/2.0-rc.7/docs/getting_started/getting_started.md b/docs/build/iota.rs/2.0-rc.7/docs/getting_started/getting_started.md deleted file mode 100644 index 66953201742..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/getting_started/getting_started.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -description: Get started with the IOTA Client Library and choose your programming language. -image: /img/banner/banner_client_lib_getting_started.png -keywords: - - rust - - node.js - - python - - java - - javascript - - client ---- - -# Getting Started - -Choose your programming language: - -- [Rust](./rust.mdx) -- [Node.js](./nodejs.mdx) -- [Java](./java.mdx) -- [Python](./python.mdx) - -## Connect to the Testnet API - -We recommended that you start your interactions with Shimmer on a _testnet_ network. The _testnet_ will allow you to safely -get acquainted with the `iota.rs` library, without the risk of losing any funds if you make a mistake along the way. -You can use this Shimmer Testnet API load balancer: - -```plaintext -https://api.testnet.shimmer.network -``` - -## Explore the Network - -You can use the [Shimmer Tangle Explorer](https://explorer.shimmer.network/testnet) to view transactions and data stored in -the Tangle. - -## Get Test Tokens - -In order to properly test value-based transactions on testnet network, you are going to need some tokens. You can get -some testnet tokens through the [Shimmer Faucet](https://faucet.testnet.shimmer.network). diff --git a/docs/build/iota.rs/2.0-rc.7/docs/getting_started/java.mdx b/docs/build/iota.rs/2.0-rc.7/docs/getting_started/java.mdx deleted file mode 100644 index 4108b0bc44d..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/getting_started/java.mdx +++ /dev/null @@ -1,425 +0,0 @@ ---- -title: Getting Started With Java -description: Getting started with the official IOTA Client Java library. -image: /img/logo/iota_mark_light.png -keywords: - - Java - - jar - - Maven - - Gradle ---- - -# IOTA Client Java Library - -Get started with the official IOTA Client Java library. - -## Requirements - -minimum Java version >= 8 - -## Use in your Android project (Android Studio) - -1. Download the `iota-client-1.0.0-rc.1.jar` file from the [GitHub release](https://github.com/iotaledger/iota.rs/releases/tag/iota-client-java-1.0.0-rc.1) and add it as a library to your project. -2. Download the `iota-client-1.0.0-rc.1-android.zip` file from the [GitHub release](https://github.com/iotaledger/iota.rs/releases/tag/iota-client-java-1.0.0-rc.1), unzip it and add the `jniLibs` folder with its contents to your Android Studio project as shown below: - -``` -project/ -├──src/ - └── main/ - ├── AndroidManifest.xml - ├── java/ - └── jniLibs/ - ├── arm64-v8a/ <-- ARM 64bit - │ └── libiota-client.so - │ └── libc++_shared.so - ├── armeabi-v7a/ <-- ARM 32bit - │ └── libiota-client.so - │ └── libc++_shared.so - │── x86/ <-- Intel 32bit - │ └── libiota-client.so - │ └── libc++_shared.so - └── x86_64/ <-- Intel 64bit - └── libiota-client.so - └── libc++_shared.so -``` - -## Use in your Java project (Linux, macOS, Windows) - -Depending on your operating system, add one of the following dependencies to your `build.gradle` file: - -#### linux-x86_64 - -``` -implementation 'org.iota:iota-client:1.0.0-rc.1:linux-x86_64' -``` - -#### windows-x86_64 - -``` -implementation 'org.iota:iota-client:1.0.0-rc.1:windows-x86_64' -``` - -#### aarch64-apple-darwin - -``` -implementation 'org.iota:iota-client:1.0.0-rc.1:aarch64-apple-darwin' -``` - -#### osx-x86_64 - -``` -implementation 'org.iota:iota-client:1.0.0-rc.1:osx-x86_64' -``` - -## Use the Library - -In order to use the library, you need to create a `Client` instance as illustrated below: - -```java -import org.iota.Client; -import org.iota.types.ClientConfig; -import org.iota.types.expections.InitializeClientException; -import org.iota.types.expections.ClientException; -import org.iota.types.responses.NodeInfoResponse; - -public class HelloWorld { - public static void main(String[] args) throws InitializeClientException, ClientException { - // Build the client. - Client client = new Client(new ClientConfig().withNodes(new String[]{"https://api.testnet.shimmer.network"})); - - // Get the node information for a given node. - NodeInfoResponse response = client.getNodeInfo(); - - // Print the URL of the node that was requested. - System.out.println(response.getNodeUrl()); - - // Print the node information for the requested node. - System.out.println(response.getNodeInfo()); - } -} -``` - -## What's Next? - -Now that you are up and running, you can get acquainted with the library using -its [how-to guides](../how_tos/00_run_how_tos.mdx) and the -repository's [code examples](https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/java/examples/src). - -## Instead, build everything from scratch yourself - -If you don't like to use the provided libraries and instead want to build everything yourself from scratch: - -### Build for Android - -Requirements: - -- minimum Java version >= 8 -- Android Studio with NDK -- latest stable version of Rust -- cargo-ndk (https://github.com/bbqsrc/cargo-ndk) - -1. Generate the JAR: - -``` -git clone https://github.com/iotaledger/iota.rs -cd iota.rs/client/bindings/java -./gradlew jarWithoutNativeLibs -``` - -2. You will find the built JAR in the `lib/build/libs` directory. Add it as a library to your Android project. - -3. Install the Android targets you want to support: - -``` - rustup target add aarch64-linux-android armv7-linux-androideabi x86_64-linux-android i686-linux-android -``` - -4. Build the native library for your Android targets: - -``` -cd lib/native -cargo ndk -t arm64-v8a -t armeabi-v7a -t x86 -t x86_64 -o ./jniLibs build --release -``` - -5. On success, you will find the built native libraries in the `jniLibs/` directory like: - -``` -── jniLibs/ - ├── arm64-v8a/ <-- ARM 64bit - │ └── libiota-client.so - ├── armeabi-v7a/ <-- ARM 32bit - │ └── libiota-client.so - │── x86/ <-- Intel 32bit - │ └── libiota-client.so - └── x86_64/ <-- Intel 64bit - └── libiota-client.so -``` - -6. Each folder is missing its `libc++_shared.so`. You can find them in the configured Android NDK folder like: - -``` -find $ANDROID_NDK_HOME -name "libc++_shared.so" -``` - -7. Copy the found `libc++_shared.so` files to their respective folder inside the `jniLibs` directory: - -``` -── jniLibs/ - ├── arm64-v8a/ <-- ARM 64bit - │ └── libiota-client.so - │ └── libc++_shared.so - ├── armeabi-v7a/ <-- ARM 32bit - │ └── libiota-client.so - │ └── libc++_shared.so - │── x86/ <-- Intel 32bit - │ └── libiota-client.so - │ └── libc++_shared.so - └── x86_64/ <-- Intel 64bit - └── libiota-client.so - └── libc++_shared.so -``` - -8. Add the `jniLibs` folder with its contents to your Android Studio project as shown below: - -``` -project/ -├──src/ - └── main/ - ├── AndroidManifest.xml - ├── java/ - └── jniLibs/ - ├── arm64-v8a/ <-- ARM 64bit - │ └── libiota-client.so - │ └── libc++_shared.so - ├── armeabi-v7a/ <-- ARM 32bit - │ └── libiota-client.so - │ └── libc++_shared.so - │── x86/ <-- Intel 32bit - │ └── libiota-client.so - │ └── libc++_shared.so - └── x86_64/ <-- Intel 64bit - └── libiota-client.so - └── libc++_shared.so -``` - -### Build for Linux, macOS, Windows - -Please note, following instructions build the library for your host OS/architecture only. - -Requirements: - -import WarningPasswordStorage from '../_admonitions/_password_storage.md'; - - - -# IOTA Client Java Library - -Get started with the official IOTA Client Java library. - -## Requirements - -minimum Java version >= 8 - -## Use in your Android project (Android Studio) - -1. Download the `iota-client-1.0.0-rc.1.jar` file from the [GitHub release](https://github.com/iotaledger/iota.rs/releases/tag/iota-client-java-1.0.0-rc.1) and add it as a library to your project. -2. Download the `iota-client-1.0.0-rc.1-android.zip` file from the [GitHub release](https://github.com/iotaledger/iota.rs/releases/tag/iota-client-java-1.0.0-rc.1), unzip it and add the `jniLibs` folder with its contents to your Android Studio project as shown below: - -``` -project/ -├──src/ - └── main/ - ├── AndroidManifest.xml - ├── java/ - └── jniLibs/ - ├── arm64-v8a/ <-- ARM 64bit - │ └── libiota-client.so - │ └── libc++_shared.so - ├── armeabi-v7a/ <-- ARM 32bit - │ └── libiota-client.so - │ └── libc++_shared.so - │── x86/ <-- Intel 32bit - │ └── libiota-client.so - │ └── libc++_shared.so - └── x86_64/ <-- Intel 64bit - └── libiota-client.so - └── libc++_shared.so -``` - -## Use in your Java project (Linux, macOS, Windows) - -Depending on your operating system, add one of the following dependencies to your `build.gradle` file: - -#### linux-x86_64 - -``` -implementation 'org.iota:iota-client:1.0.0-rc.1:linux-x86_64' -``` - -#### windows-x86_64 - -``` -implementation 'org.iota:iota-client:1.0.0-rc.1:windows-x86_64' -``` - -#### aarch64-apple-darwin - -``` -implementation 'org.iota:iota-client:1.0.0-rc.1:aarch64-apple-darwin' -``` - -#### osx-x86_64 - -``` -implementation 'org.iota:iota-client:1.0.0-rc.1:osx-x86_64' -``` - -## Use the Library - -In order to use the library, you need to create a `Client` instance as illustrated below: - -```java -import org.iota.Client; -import org.iota.types.ClientConfig; -import org.iota.types.expections.InitializeClientException; -import org.iota.types.expections.ClientException; -import org.iota.types.responses.NodeInfoResponse; - -public class HelloWorld { - public static void main(String[] args) throws InitializeClientException, ClientException { - // Build the client. - Client client = new Client(new ClientConfig().withNodes(new String[]{"https://api.testnet.shimmer.network"})); - - // Get the node information for a given node. - NodeInfoResponse response = client.getNodeInfo(); - - // Print the URL of the node that was requested. - System.out.println(response.getNodeUrl()); - - // Print the node information for the requested node. - System.out.println(response.getNodeInfo()); - } -} -``` - -## What's Next? - -Now that you are up and running, you can get acquainted with the library using -its [how-to guides](../how_tos/00_run_how_tos.mdx) and the -repository's [code examples](https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/java/examples/src). - -## Instead, build everything from scratch yourself - -If you don't like to use the provided libraries and instead want to build everything yourself from scratch: - -### Build for Android - -Requirements: - -- minimum Java version >= 8 -- Android Studio with NDK -- latest stable version of Rust -- cargo-ndk (https://github.com/bbqsrc/cargo-ndk) - -1. Generate the JAR: - -``` -git clone https://github.com/iotaledger/iota.rs -cd iota.rs/client/bindings/java -./gradlew jarWithoutNativeLibs -``` - -2. You will find the built JAR in the `lib/build/libs` directory. Add it as a library to your Android project. - -3. Install the Android targets you want to support: - -``` - rustup target add aarch64-linux-android armv7-linux-androideabi x86_64-linux-android i686-linux-android -``` - -4. Build the native library for your Android targets: - -``` -cd lib/native -cargo ndk -t arm64-v8a -t armeabi-v7a -t x86 -t x86_64 -o ./jniLibs build --release -``` - -5. On success, you will find the built native libraries in the `jniLibs/` directory like: - -``` -── jniLibs/ - ├── arm64-v8a/ <-- ARM 64bit - │ └── libiota-client.so - ├── armeabi-v7a/ <-- ARM 32bit - │ └── libiota-client.so - │── x86/ <-- Intel 32bit - │ └── libiota-client.so - └── x86_64/ <-- Intel 64bit - └── libiota-client.so -``` - -6. Each folder is missing its `libc++_shared.so`. You can find them in the configured Android NDK folder like: - -``` -find $ANDROID_NDK_HOME -name "libc++_shared.so" -``` - -7. Copy the found `libc++_shared.so` files to their respective folder inside the `jniLibs` directory: - -``` -── jniLibs/ - ├── arm64-v8a/ <-- ARM 64bit - │ └── libiota-client.so - │ └── libc++_shared.so - ├── armeabi-v7a/ <-- ARM 32bit - │ └── libiota-client.so - │ └── libc++_shared.so - │── x86/ <-- Intel 32bit - │ └── libiota-client.so - │ └── libc++_shared.so - └── x86_64/ <-- Intel 64bit - └── libiota-client.so - └── libc++_shared.so -``` - -8. Add the `jniLibs` folder with its contents to your Android Studio project as shown below: - -``` -project/ -├──src/ - └── main/ - ├── AndroidManifest.xml - ├── java/ - └── jniLibs/ - ├── arm64-v8a/ <-- ARM 64bit - │ └── libiota-client.so - │ └── libc++_shared.so - ├── armeabi-v7a/ <-- ARM 32bit - │ └── libiota-client.so - │ └── libc++_shared.so - │── x86/ <-- Intel 32bit - │ └── libiota-client.so - │ └── libc++_shared.so - └── x86_64/ <-- Intel 64bit - └── libiota-client.so - └── libc++_shared.so -``` - -### Build for Linux, macOS, Windows - -Please note, following instructions build the library for your host OS/architecture only. - -Requirements: - -- minimum Java version >= 8 -- latest stable version of Rust - -1. Generate the JAR: - -``` -git clone https://github.com/iotaledger/iota.rs -cd iota.rs/client/bindings/java -./gradlew jar -``` - -2. You will find the built JAR in the `lib/build/libs` directory. Add it as a library to your Java project. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/getting_started/nodejs.mdx b/docs/build/iota.rs/2.0-rc.7/docs/getting_started/nodejs.mdx deleted file mode 100644 index 46f2e414ee4..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/getting_started/nodejs.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: Getting Started With Node.js -description: Getting started with the official IOTA Client Node.js library. -image: /img/logo/iota_mark_light.png -keywords: - - Node.js - - dotenv - - install - - npm - - yarn - - security ---- - -import WarningPasswordStorage from '../_admonitions/_password_storage.md'; - - - -## Requirements - -- One of the following [Node.js](https://nodejs.org/en/) versions: - - - '14.x' - - '16.x' (LTS) . - - '18.x' (Current). - -- [Rust and Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) to compile the binding. - -## Install the Library - -You can install the library using [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/) with the following -commands: - -### npm - -```bash -npm i @iota/client -``` - -### Yarn - -```bash -yarn add @iota/client -``` - -## Use the Library - -After you have linked the library, you can create a [`Client`](./../libraries/nodejs/references/classes/Client.md) -instance and interface with it. - -```javascript -import { Client } from '@iota/client'; - -const client = new Client({ - nodes: ['https://api.testnet.shimmer.network'], -}); - -client.getInfo().then(console.log).catch(console.error); -``` - -## Connecting to MQTT - -Connecting to a MQTT broker using a raw ip doesn't work with TCP. This is a limitation -of [rustls](https://docs.rs/rustls/latest/rustls/). - -## What's Next? - -Now that you are up and running, you can get acquainted with the library using -its [how-to guides](../how_tos/00_run_how_tos.mdx) and the -repository's [code examples](https://github.com/iotaledger/iota.rs/tree/develop/bindings/nodejs/examples). diff --git a/docs/build/iota.rs/2.0-rc.7/docs/getting_started/python.mdx b/docs/build/iota.rs/2.0-rc.7/docs/getting_started/python.mdx deleted file mode 100644 index 818fdc9acaa..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/getting_started/python.mdx +++ /dev/null @@ -1,113 +0,0 @@ ---- -title: Getting Started With Python -description: Getting started with the official IOTA Client Python library. -image: /img/logo/iota_mark_light.png -keywords: - - Python - - install - - pip - - unpack ---- - -import WarningPasswordStorage from '../_admonitions/_password_storage.md'; - - - -## Requirements - -- [Python 3.x](https://www.python.org). -- [pip](https://pypi.org/project/pip). - -## Install package from PyPI - -You can install the library by executing `pip install iota-client`. - -## Install from source - -:::caution - -We recommend to install the library with [pip from PyPI](#install-package-from-pypi). -Only compile the library from source if you are in need of some unreleased features or are working with an unsupported computer architecture. - -::: - -### Additional Requirements - -- [Rust and Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html). -- (for Linux only) `libudev`. You can install it with `apt install libudev-dev`. - -### Clone the Repository - -You can clone the [iota.rs client library](https://github.com/iotaledger/iota.rs) by running the following command: - -```bash -git clone -b develop https://github.com/iotaledger/iota.rs -``` - -### Change to the Python Binding Directory - -After you have cloned the repository, you should change directory to `iota.rs/client/bindings/python`. You can do so by -running the following command: - -```bash -cd iota.rs/client/bindings/python -``` - -### Install the Required Dependencies and Build the Wheel - -Once you have [cloned the repository](#clone-the-repository), -and [moved to the binding's directory](#change-to-the-python-binding-directory), you should install dependencies and build the wheel file. - -You can do so by running the following commands: - -```bash -pip install -r requirements-dev.txt -pip install . -``` - -### (optional) Create and Use a Virtual Environment - -If you want to isolate the library from the rest of your system, you can create a virtual environment by running the -following commands: - -#### Linux/MacOs - -```bash -python3 -m venv iota_client_venv -source iota_client_venv/bin/activate -``` - -#### Windows - -```shell -.\iota_client_venv\Scripts\activate -``` - -### (optional) Deactivate the virtual environment - -If you want to deactivate the virtual environment, you should run the following command from the virtual environment: - -```bash -deactivate -``` - -## Use the Library - -After you installed the library, you can create a `IotaClient` instance and interface with it. - -```python -from iota_client import IotaClient - -# Create an IotaClient instance -client = IotaClient({'nodes': ['https://api.testnet.shimmer.network']}) - -# Get the node info -node_info = client.get_info() -print(f'{node_info}') -``` - -## What's Next? - -Now that you are up and running, you can get acquainted with the library using -its [how-to guides](../how_tos/00_run_how_tos.mdx) and the -repository's [code examples](https://github.com/iotaledger/iota.rs/tree/develop/bindings/nodejs/examples). diff --git a/docs/build/iota.rs/2.0-rc.7/docs/getting_started/rust.mdx b/docs/build/iota.rs/2.0-rc.7/docs/getting_started/rust.mdx deleted file mode 100644 index 1907e880734..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/getting_started/rust.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: Getting Started With Rust -description: Getting started with the official IOTA Client Rust library. -image: /img/logo/iota_mark_light.png -keywords: - - Rust - - install - - cargo - - system environment variables ---- - -import WarningPasswordStorage from '../_admonitions/_password_storage.md'; - - - -## Requirements - -- [Rust and Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html). -- (for Linux only) `libudev`. You can install it with `apt install libudev-dev`. - -## Include the Library in Your `Cargo.toml` - -The only thing you need to do to start using the library is to add it as dependency in your `Cargo.toml` file: - -```bash -[dependencies] -iota-client = { git = "https://github.com/iotaledger/iota.rs", branch = "develop" } -tokio = { version = "1.22.0", features = [ "full" ] } -``` - -## Use the Library - -This example fetches node information. - -```rust -use iota_client::{Client, Result}; - -#[tokio::main] -async fn main() -> Result<()> { - // Create a client with that node. - let client = Client::builder() - .with_node("https://api.testnet.shimmer.network")? - .with_ignore_node_health() - .finish()?; - - // Get node info. - let info = client.get_info().await?; - - // Print node info. - println!("{info:#?}"); - - Ok(()) -} -``` - -## What's Next? - -Now that you are up and running, you can get acquainted with the library using -its [how-to guides](../how_tos/00_run_how_tos.mdx) and the -repository's [code examples](https://github.com/iotaledger/iota.rs/tree/develop/examples). diff --git a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/00_run_how_tos.mdx b/docs/build/iota.rs/2.0-rc.7/docs/how_tos/00_run_how_tos.mdx deleted file mode 100644 index e03d325a467..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/00_run_how_tos.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Run Code Examples -description: The iota.rs has multiple code examples to get you up and running in no time. However, these require a specific set up depending on your language of choice. -image: /img/logo/iota_mark_light.png -keywords: - - how to - - examples - - npm - - cargo - - yarn - - java - - nodejs - - python - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import JavaCode from '../libraries/java/how_to/_run_how_tos.mdx'; -import NodejsGetCode from '../libraries/nodejs/how_to/_run_how_tos.mdx'; -import PythonGetCode from '../libraries/python/how_to/_run_how_tos.md'; -import RustGetCode from '../libraries/rust/how_to/_run_how_tos.md'; - -Each language has different set up instructions you need to follow to get the code examples up and running. - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/01_get_node_info.mdx b/docs/build/iota.rs/2.0-rc.7/docs/how_tos/01_get_node_info.mdx deleted file mode 100644 index 41d9247bead..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/01_get_node_info.mdx +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: Get Node Information -description: 'You can access all the features of the iota.rs library using an instance of the Client class. The Client class provides high-level abstraction to all interactions over IOTA network (Tangle).' -image: /img/logo/iota_mark_light.png -keywords: - - how to - - client class - - iota node - - ClientBuilder - - load balancer - - java - - nodejs - - python - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import JavaCode from '../libraries/java/how_to/_01_get_node_info/_code_sample.mdx'; -import JavaOutput from '../libraries/java/how_to/_01_get_node_info/_expected_output.md'; -import NodejsCode from '../libraries/nodejs/how_to/_01_get_node_info/_code_sample.mdx'; -import NodejsOutput from '../libraries/nodejs/how_to/_01_get_node_info/_expected_output.md'; -import PythonCode from '../libraries/python/how_to/_01_get_node_info/_code_sample.mdx'; -import PythonOutput from '../libraries/python/how_to/_01_get_node_info/_expected_output.md'; -import RustCode from '../libraries/rust/how_to/_01_get_node_info/_code_sample.mdx'; -import RustOutput from '../libraries/rust/how_to/_01_get_node_info/_expected_output.md'; -import IotaJs from '../_admonitions/_iotajs_example.mdx'; - -You can access all the features of the `iota.rs` library using an instance of the `Client` class. The `Client` class -provides high-level abstraction to all interactions over IOTA network (Tangle). You have to instantiate this class -before you start any interactions with the library, or more precisely with the -[IOTA nodes](/introduction/stardust/explanations/node_software) that power IOTA network. - -The following code example will: - -1. Create a `Client` which will connect to the [Shimmer Testnet](https://api.testnet.shimmer.network). -2. Use the created client to get information about the node. -3. Print the information to the console. - - - -## Code Example - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/02_generate_mnemonic.mdx b/docs/build/iota.rs/2.0-rc.7/docs/how_tos/02_generate_mnemonic.mdx deleted file mode 100644 index 19615d2a4ef..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/02_generate_mnemonic.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: Generate a Mnemonic -description: You can generate a mnemonic using any Client instance. -image: /img/logo/iota_mark_light.png -keywords: - - how to - - generate mnemonic - - java - - nodejs - - python - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import JavaCode from '../libraries/java/how_to/_02_generate_mnemonic/_code_sample.mdx'; -import JavaOutput from '../libraries/java/how_to/_02_generate_mnemonic/_expected_output.md'; -import NodejsCode from '../libraries/nodejs/how_to/_02_generate_mnemonic/_code_sample.mdx'; -import NodejsOutput from '../libraries/nodejs/how_to/_02_generate_mnemonic/_expected_output.md'; -import PythonCode from '../libraries/python/how_to/_02_generate_mnemonic/_code_sample.mdx'; -import PythonOutput from '../libraries/python/how_to/_02_generate_mnemonic/_expected_output.md'; -import RustCode from '../libraries/rust/how_to/_02_generate_mnemonic/_code_sample.mdx'; -import RustOutput from '../libraries/rust/how_to/_02_generate_mnemonic/_expected_output.md'; - -The following example will generate a mnemonic using a `Client` instance. Since this functionality doesn't need to -communicate with any nodes, you can start your `Client` in offline mode. - -The following code example will: - -1. Create a `Client` in offline mode. -2. Use the created client to generate a mnemonic. - -## Code Examples - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/03_generate_addresses.mdx b/docs/build/iota.rs/2.0-rc.7/docs/how_tos/03_generate_addresses.mdx deleted file mode 100644 index 2346b463760..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/03_generate_addresses.mdx +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: Generate Addresses -description: You can generate an IOTA address using the Client.get_addresses() function that will return a list of tuples with the generated addresses. -image: /img/logo/iota_mark_light.png -keywords: - - how to - - address - - iota address - - addressgetter - - environment variable - - java - - nodejs - - python - - rust - - wasm ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import JavaCode from '../libraries/java/how_to/_03_generate_addresses/_code_sample.mdx'; -import JavaOutput from '../libraries/java/how_to/_03_generate_addresses/_expected_output.md'; -import NodejsCode from '../libraries/nodejs/how_to/_03_generate_addresses/_code_sample.mdx'; -import NodejsOutput from '../libraries/nodejs/how_to/_03_generate_addresses/_expected_output.md'; -import PythonCode from '../libraries/python/how_to/_03_generate_addresses/_code_sample.mdx'; -import PythonOutput from '../libraries/python/how_to/_03_generate_addresses/_expected_output.md'; -import RustCode from '../libraries/rust/how_to/_03_generate_addresses/_code_sample.mdx'; -import RustOutput from '../libraries/rust/how_to/_03_generate_addresses/_expected_output.md'; -import IotaJs from '../_admonitions/_iotajs_example.mdx'; - -You can generate an IOTA address using the `Client.get_addresses()` function that will return a list of tuples with the -generated addresses. - -The following code example will: - -1. Create a `Client` which will connect to the [Shimmer Testnet](https://api.testnet.shimmer.network). -2. Create a `SecretManager` from a [mnemonic](02_generate_mnemonic.mdx). -3. Generate a public address. -4. Generate an internal address. -5. Generate an offline address. - - - -## Code Example - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/04_get_output.mdx b/docs/build/iota.rs/2.0-rc.7/docs/how_tos/04_get_output.mdx deleted file mode 100644 index 8be27016da8..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/04_get_output.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: Get Outputs -description: You can get outputs by their output ID using the Client.get_output(output_id) function. -image: /img/logo/iota_mark_light.png -keywords: - - how to - - outputs - - get_output - - get output by id - - java - - nodejs - - python - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import JavaCode from '../libraries/java/how_to/_04_get_output/_code_sample.mdx'; -import JavaOutput from '../libraries/java/how_to/_04_get_output/_expected_output.md'; -import NodejsCode from '../libraries/nodejs/how_to/_04_get_output/_code_sample.mdx'; -import NodejsOutput from '../libraries/nodejs/how_to/_04_get_output/_expected_output.md'; -import PythonCode from '../libraries/python/how_to/_04_get_output/_code_sample.mdx'; -import PythonOutput from '../libraries/python/how_to/_04_get_output/_expected_output.md'; -import RustCode from '../libraries/rust/how_to/_04_get_output/_code_sample.mdx'; -import RustOutput from '../libraries/rust/how_to/_04_get_output/_expected_output.md'; - -You can get outputs by their output ID using the `Client.get_output(output_id)` function. - -The following code example will: - -1. Create a `Client` which will connect to the [Shimmer Testnet](https://api.testnet.shimmer.network). -2. Get an output by its output ID. - -## Code Example - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/05_build_output.mdx b/docs/build/iota.rs/2.0-rc.7/docs/how_tos/05_build_output.mdx deleted file mode 100644 index 18608d1d3a0..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/05_build_output.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: Build a Basic Output -description: Build a simple output using the Client.buildBasicOutput(options) function. -image: /img/logo/iota_mark_light.png -keywords: - - how to - - address - - iota address - - addressgetter - - environment variable - - java - - nodejs - - python - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import JavaCode from '../libraries/java/how_to/_05_build_output/_code_sample.mdx'; -import JavaOutput from '../libraries/java/how_to/_05_build_output/_expected_output.md'; -import NodejsCode from '../libraries/nodejs/how_to/_05_build_output/_code_sample.mdx'; -import NodejsOutput from '../libraries/nodejs/how_to/_05_build_output/_expected_output.md'; -import PythonCode from '../libraries/python/how_to/_05_build_output/_code_sample.mdx'; -import PythonOutput from '../libraries/python/how_to/_05_build_output/_expected_output.md'; -import RustCode from '../libraries/rust/how_to/_05_build_output/_code_sample.mdx'; -import RustOutput from '../libraries/rust/how_to/_05_build_output/_expected_output.md'; - -You can build a simple output using the `Client.buildBasicOutput(options)` function. - -The following code example will: - -1. Create a `Client` which will connect to the [Shimmer Testnet](https://api.testnet.shimmer.network). -2. Create a `SecretManager` from a [mnemonic](02_generate_mnemonic.mdx). -3. [Generate a public address](03_generate_addresses.mdx). -4. Build a simple output. - -## Code Example - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/06_get_address_balances.mdx b/docs/build/iota.rs/2.0-rc.7/docs/how_tos/06_get_address_balances.mdx deleted file mode 100644 index fb11824e34a..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/06_get_address_balances.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: Get Address Balance -description: 'You can retrieve the outputs for any given address using the Client.basicOutputIds(queryParameters) function. You can then use the retrieved outputs to calculate the balance.' -image: /img/logo/iota_mark_light.png -keywords: - - how to - - address - - iota address - - get balance - - get outputs - - java - - nodejs - - python - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import JavaCode from '../libraries/java/how_to/_06_get_address_balances/_code_sample.mdx'; -import JavaOutput from '../libraries/java/how_to/_06_get_address_balances/_expected_output.md'; -import NodejsCode from '../libraries/nodejs/how_to/_06_get_address_balances/_code_sample.mdx'; -import NodejsOutput from '../libraries/nodejs/how_to/_06_get_address_balances/_expected_output.md'; -import PythonCode from '../libraries/python/how_to/_06_get_address_balances/_code_sample.mdx'; -import PythonOutput from '../libraries/python/how_to/_06_get_address_balances/_expected_output.md'; -import RustCode from '../libraries/rust/how_to/_06_get_address_balances/_code_sample.mdx'; -import RustOutput from '../libraries/rust/how_to/_06_get_address_balances/_expected_output.md'; - -You can retrieve the outputs for any given address using the Client.basicOutputIds(queryParameters) function. -You can then use the retrieved outputs to calculate the balance. - -The following code example will: - -1. Create a `Client` which will connect to the [Shimmer Testnet](https://api.testnet.shimmer.network). -2. Create a `SecretManager` from a [mnemonic](02_generate_mnemonic.mdx). -3. Get outputs for the [generated address](03_generate_addresses.mdx). -4. Add the total amount of native tokens and outputs. -5. Log the results from step 4 to console. - -## Code Example - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/07_create_block.mdx b/docs/build/iota.rs/2.0-rc.7/docs/how_tos/07_create_block.mdx deleted file mode 100644 index 159ceb32292..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/07_create_block.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: Create a Block -description: 'The simplest block you can create is an empty block. You will only need connect your client to a node and then call the -`Client.block(&self)` function.' -image: /img/logo/iota_mark_light.png -keywords: -- how to -- block -- create -- create empty block -- java -- nodejs -- python -- rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import JavaCode from '../libraries/java/how_to/_07_create_block/_code_sample.mdx'; -import JavaOutput from '../libraries/java/how_to/_07_create_block/_expected_output.md'; -import NodejsCode from '../libraries/nodejs/how_to/_07_create_block/_code_sample.mdx'; -import NodejsOutput from '../libraries/nodejs/how_to/_07_create_block/_expected_output.md'; -import PythonCode from '../libraries/python/how_to/_07_create_block/_code_sample.mdx'; -import PythonOutput from '../libraries/python/how_to/_07_create_block/_expected_output.md'; -import RustCode from '../libraries/rust/how_to/_07_create_block/_code_sample.mdx'; -import RustOutput from '../libraries/rust/how_to/_07_create_block/_expected_output.md'; - -The simplest block you can create is an empty block. You will only need connect your client to a node and then call the -`Client.block(&self)` function. - -The following code example will: - -1. Create a `Client` which will connect to the [Shimmer Testnet](https://api.testnet.shimmer.network). -2. Build and post an empty block. - -## Code Example - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/08_post_block.mdx b/docs/build/iota.rs/2.0-rc.7/docs/how_tos/08_post_block.mdx deleted file mode 100644 index fc5eb7125e7..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/08_post_block.mdx +++ /dev/null @@ -1,119 +0,0 @@ ---- -title: Post a Data Block -description: 'You can post a data block by attaching hex encoded data to a blocks options.' -image: /img/logo/iota_mark_light.png -keywords: - - how to - - block - - create - - create empty block - - java - - nodejs - - python - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import JavaCode from '../libraries/java/how_to/_08_post_block/_code_sample.mdx'; -import JavaOutput from '../libraries/java/how_to/_08_post_block/_expected_output.md'; -import NodejsCode from '../libraries/nodejs/how_to/_08_post_block/_code_sample.mdx'; -import NodejsOutput from '../libraries/nodejs/how_to/_08_post_block/_expected_output.md'; -import PythonCode from '../libraries/python/how_to/_08_post_block/_code_sample.mdx'; -import PythonOutput from '../libraries/python/how_to/_08_post_block/_expected_output.md'; -import RustCode from '../libraries/rust/how_to/_08_post_block/_code_sample.mdx'; -import RustOutput from '../libraries/rust/how_to/_08_post_block/_expected_output.md'; - -import JavaRawCode from '../libraries/java/how_to/_08_post_raw_block/_code_sample.mdx'; -import JavaRawOutput from '../libraries/java/how_to/_08_post_raw_block/_expected_output.md'; -import RustRawCode from '../libraries/rust/how_to/_08_post_raw_block/_code_sample.mdx'; -import RustRawOutput from '../libraries/rust/how_to/_08_post_raw_block/_expected_output.md'; -import NodeJsRawCode from '../_admonitions/_guide_coming_soon.md'; -import NodeJsRawOutput from '../_admonitions/_guide_coming_soon.md'; -import PythonRawCode from '../libraries/python/how_to/_14_post_raw_block/_code_sample.mdx'; -import PythonRawOutput from '../libraries/python/how_to/_14_post_raw_block/_expected_output.md'; -import IotaJs from '../_admonitions/_iotajs_example.mdx'; - -You can post a data block by adding hex encoded data as options when you [create a block](07_create_block.mdx). - -The following code example will: - -1. Create a `Client` which will connect to the [Shimmer Testnet](https://api.testnet.shimmer.network). -2. Create the `options` with the hex encoded data. -3. Create a `SecretManager` from a [mnemonic](02_generate_mnemonic.mdx). -4. [Create and post](07_create_block.mdx) the block with the data from step 2. -5. [Generate a public address](03_generate_addresses.mdx). - - - -## Post a Block - -### Code Example - - - - - - - - - - - - - - - - -### Expected Output - - - - - - - - - - - - - - - - -## Post a Raw Block - -### Code Example - - - - - - - - - - - - - - - - -### Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/09_get_block.mdx b/docs/build/iota.rs/2.0-rc.7/docs/how_tos/09_get_block.mdx deleted file mode 100644 index 74862788a42..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/09_get_block.mdx +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: Get a Block -description: You can retrieve a block\'s data by calling the Client.get_block(&block_id) function. -keywords: - - how to - - block - - get - - block data - - block metadata - - get block by id - - java - - nodejs - - python - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import JavaCode from '../libraries/java/how_to/_09_get_block/_code_sample.mdx'; -import JavaOutput from '../libraries/java/how_to/_09_get_block/_expected_output.md'; -import NodejsCode from '../libraries/nodejs/how_to/_09_get_block/_code_sample.mdx'; -import NodejsOutput from '../libraries/nodejs/how_to/_09_get_block/_expected_output.md'; -import PythonCode from '../libraries/python/how_to/_09_get_block/_code_sample.mdx'; -import PythonOutput from '../libraries/python/how_to/_09_get_block/_expected_output.md'; -import RustCode from '../libraries/rust/how_to/_09_get_block/_code_sample.mdx'; -import RustOutput from '../libraries/rust/how_to/_09_get_block/_expected_output.md'; -import IotaJs from '../_admonitions/_iotajs_example.mdx'; - -You can retrieve a block's data by calling the `Client.get_block(&block_id)` function. - -You can also retrieve a block's metadata by calling the `Client.get_block_metadata(&block_id)` function. - -The following code example will: - -1. Create a `Client` which will connect to the [Shimmer Testnet](https://api.testnet.shimmer.network). -2. Create a block with no payload. -3. Retrieve and log the block's metadata. -4. Retrieve and log the block's data. -5. Get the block by its block ID. - - - -## Code Example - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/10_prepare_sign_transaction.mdx b/docs/build/iota.rs/2.0-rc.7/docs/how_tos/10_prepare_sign_transaction.mdx deleted file mode 100644 index dd16e6610ac..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/10_prepare_sign_transaction.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: Send a Transaction -description: You can send a transaction by attaching an output with an address and amount to a block. -keywords: - - how to - - block - - post transaction - - build transaction - - outputs - - java - - nodejs - - python - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import JavaCode from '../libraries/nodejs/how_to/_10_prepare_signed_transaction/_code_sample.mdx'; -import JavaOutput from '../libraries/nodejs/how_to/_10_prepare_signed_transaction/_expected_output.md'; -import NodejsCode from '../libraries/nodejs/how_to/_10_prepare_signed_transaction/_code_sample.mdx'; -import NodejsOutput from '../libraries/nodejs/how_to/_10_prepare_signed_transaction/_expected_output.md'; -import PythonCode from '../libraries/python/how_to/_10_prepare_signed_transaction/_code_sample.mdx'; -import PythonOutput from '../libraries/python/how_to/_10_prepare_signed_transaction/_expected_output.md'; -import RustCode from '../libraries/rust/how_to/_10_prepare_signed_transaction/_code_sample.mdx'; -import RustOutput from '../libraries/rust/how_to/_10_prepare_signed_transaction/_expected_output.md'; -import IotaJs from '../_admonitions/_iotajs_example.mdx'; - -The following code example will: - -1. Create a `Client` which will connect to the [Shimmer Testnet](https://api.testnet.shimmer.network). -2. Create a `SecretManager` from a [mnemonic](02_generate_mnemonic.mdx). -3. [Generate a public address](03_generate_addresses.mdx). -4. [Build](07_create_block.mdx) and [post a block](08_post_block.mdx) with an output address and amount to send. -5. Log the transaction. - - - -## Code Example - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/11_build_nft_output.mdx b/docs/build/iota.rs/2.0-rc.7/docs/how_tos/11_build_nft_output.mdx deleted file mode 100644 index fdd96a3c807..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/11_build_nft_output.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: Build an NFT Output -description: The following example will build and send an NFT output. -keywords: - - how to - - block - - output - - NFT - - create NFT - - java - - nodejs - - python - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import JavaCode from '../libraries/java/how_to/_11_nft_output/_code_sample.mdx'; -import JavaOutput from '../libraries/java/how_to/_11_nft_output/_expected_output.md'; -import NodejsCode from '../libraries/nodejs/how_to/_11_nft_output/_code_sample.mdx'; -import NodejsOutput from '../libraries/nodejs/how_to/_11_nft_output/_expected_output.md'; -import PythonCode from '../libraries/python/how_to/_11_nft_output/_code_sample.mdx'; -import PythonOutput from '../libraries/python/how_to/_11_nft_output/_expected_output.md'; -import RustCode from '../libraries/rust/how_to/_11_nft_output/_code_sample.mdx'; -import RustOutput from '../libraries/rust/how_to/_11_nft_output/_expected_output.md'; -import IotaJs from '../_admonitions/_iotajs_example.mdx'; - -The following code example will: - -1. Create a `Client` which will connect to the [Shimmer Testnet](https://api.testnet.shimmer.network). -2. Create a `SecretManager` from a [mnemonic](02_generate_mnemonic.mdx). -3. Build an NFT output. -4. [Build](07_create_block.mdx) and [post](08_post_block.mdx) a block with the NFT output created in step 3. - - - -## Code Example - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/12_build_foundry_output.mdx b/docs/build/iota.rs/2.0-rc.7/docs/how_tos/12_build_foundry_output.mdx deleted file mode 100644 index 609b07dda59..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/12_build_foundry_output.mdx +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: Build a Foundry Output -description: The following example will build a Foundry output. -keywords: - - how to - - block - - output - - Foundry - - java - - nodejs - - python - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import JavaCode from '../libraries/java/how_to/_12_foundry_output/_code_sample.mdx'; -import JavaOutput from '../libraries/java/how_to/_12_foundry_output/_expected_output.md'; -import NodejsCode from '../libraries/nodejs/how_to/_12_foundry_output/_code_sample.mdx'; -import NodejsOutput from '../libraries/nodejs/how_to/_12_foundry_output/_expected_output.md'; -import PythonCode from '../_admonitions/_guide_coming_soon.md'; -import PythonOutput from '../_admonitions/_guide_coming_soon.md'; -import RustCode from '../libraries/rust/how_to/_12_foundry_output/_code_sample.mdx'; -import RustOutput from '../libraries/rust/how_to/_12_foundry_output/_expected_output.md'; - -The following code example will: - -1. Create a `Client` which will connect to the [Shimmer Testnet](https://api.testnet.shimmer.network). -2. Create a `SecretManager` from a [mnemonic](02_generate_mnemonic.mdx). -3. Build a Foundry output. - -## Code Example - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/13_build_alias_output.mdx b/docs/build/iota.rs/2.0-rc.7/docs/how_tos/13_build_alias_output.mdx deleted file mode 100644 index 627d1a03eb6..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/13_build_alias_output.mdx +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: Build an Alias Output -description: The following example will build and send an NFT output. -keywords: - - how to - - block - - output - - alias - - java - - nodejs - - python - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import JavaCode from '../libraries/java/how_to/_13_alias_output/_code_sample.mdx'; -import JavaOutput from '../libraries/java/how_to/_13_alias_output/_expected_output.md'; -import NodejsCode from '../libraries/nodejs/how_to/_13_alias_output/_code_sample.mdx'; -import NodejsOutput from '../libraries/nodejs/how_to/_13_alias_output/_expected_output.md'; -import PythonCode from '../_admonitions/_guide_coming_soon.md'; -import PythonOutput from '../_admonitions/_guide_coming_soon.md'; -import RustCode from '../libraries/rust/how_to/_13_alias_output/_code_sample.mdx'; -import RustOutput from '../libraries/rust/how_to/_13_alias_output/_expected_output.md'; - -The following code example will: - -1. Create a `Client` which will connect to the [Shimmer Testnet](https://api.testnet.shimmer.network). -2. Create a `SecretManager` from a [mnemonic](02_generate_mnemonic.mdx). -3. Build an Alias output. - -## Code Example - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/14_mqtt.mdx b/docs/build/iota.rs/2.0-rc.7/docs/how_tos/14_mqtt.mdx deleted file mode 100644 index a82ab16d828..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/14_mqtt.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: Listen to MQTT -description: You can listen to MQTT topics by connecting to a node and using the `Client.subscribe()` function. -keywords: - - how to - - subscribe topic - - unsubscribe topic - - MQTT - - listen MQTT - - java - - nodejs - - python - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import JavaCode from '../_admonitions/_guide_coming_soon.md'; -import JavaOutput from '../_admonitions/_guide_coming_soon.md'; -import NodejsCode from '../libraries/nodejs/how_to/_14_mqtt/_code_sample.mdx'; -import NodejsOutput from '../libraries/nodejs/how_to/_14_mqtt/_expected_output.md'; -import PythonCode from '../_admonitions/_guide_coming_soon.md'; -import PythonOutput from '../_admonitions/_guide_coming_soon.md'; -import RustCode from '../libraries/rust/how_to/_14_mqtt/_code_sample.mdx'; -import RustOutput from '../libraries/rust/how_to/_14_mqtt/_expected_output.md'; - -The following code example will: - -1. Create a `Client` which will connect to the [Shimmer Testnet](https://api.testnet.shimmer.network). -2. Subscribe to a set of `topics`. -3. Listen to the topic defined in step 2 and log the output. - -## Code Example - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/15_more_examples.mdx b/docs/build/iota.rs/2.0-rc.7/docs/how_tos/15_more_examples.mdx deleted file mode 100644 index 7c2699b87cb..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/15_more_examples.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: More examples -description: You can find more usage examples in the official iota.rs repository. -keywords: - - how to - - more examples - - java - - nodejs - - python - - rust ---- - -You can find more usage examples in the official [iota.rs repository](https://github.com/iotaledger/iota.rs/tree/develop/). - -The following links will take to the examples folder for your language of choice: - -- [Rust](https://github.com/iotaledger/iota.rs/tree/develop/examples) -- [Node.js](https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/nodejs/examples) -- [Java](https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/java/iota-client-java/examples). -- [Python](https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/python/examples) diff --git a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/16_use-python-with-iota.mdx b/docs/build/iota.rs/2.0-rc.7/docs/how_tos/16_use-python-with-iota.mdx deleted file mode 100644 index de51f8fc62b..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/how_tos/16_use-python-with-iota.mdx +++ /dev/null @@ -1,121 +0,0 @@ ---- -title: Use Shimmer Python library together with IOTA Library -description: How to use the Python Shimmer Library together with the IOTA library -keywords: - - Python - - IOTA - - Shimmer ---- - -:::info - -As Python doesn't support using multiple versions of the same library, if you want to use both the Shimmer and IOTA version, you need to build one of them yourself and rename it. - -::: - -In this guide we will show you an Example on how you can install both the IOTA and Shimmer Python client for usage in the same application. -For that we will build the IOTA client library ourselfes and rename it. - -### Install Shimmer Version - -First install the Shimmer version following the [installation guide](/getting_started/python.mdx#install-package-from-pypi). - -### Install IOTA Version - -To install the IOTA version you need to follow the [Install from source](/iota.rs/getting_started/python#install-from-source) guide. -Before you continue with the steps after having cloned the repo, we need to apply some changes to the repo first. - -:::info - -In this guide we will rename the `iota-client` to `iota-client-production`, but you can use whatever you want. - -::: - -In `bindings/python/native/Cargo.toml` change both names: - -```diff -[package] -- name = "iota-client-python" -+ name = "iota-client-production" - version = "0.2.0-alpha.3" - authors = ["IOTA Stiftung"] - edition = "2021" - description = "Python bindings for the IOTA client library" - documentation = "/iota.rs/welcome" - homepage = "https://www.iota.org/" - repository = "https://github.com/iotaledger/iota.rs" - license = "Apache-2.0" - keywords = ["iota", "tangle", "client", "python"] - categories = ["cryptography::cryptocurrencies"] - -[lib] -- name = "iota_client" -+ name = "iota_client_production" - crate-type = ["cdylib"] -``` - -In `bindings/python/native/setup.py`: - -```diff -setup( -- name="iota_client", -+ name="iota_client_production" - version="0.1.0", - classifiers=[ - "License :: SPDX-License-Identifier :: Apache-2.0", - "Development Status :: 0.1.0 - Alpha", - "Intended Audience :: Developers", - "Programming Language :: Python", - "Programming Language :: Rust", - "Operating System :: POSIX", - "Operating System :: MacOS :: MacOS X", - ], - packages=["iota_client"], - rust_extensions=[ - RustExtension( - "iota_client.iota_client", - rustc_flags=get_py_version_cfgs(), - debug=False, - ), - ], - include_package_data=True, - zip_safe=False, -) -``` - -And in `bindings/python/native/src/lib.rs`: - -```diff -/// A Python module implemented in Rust. -#[pymodule] -- fn iota_client(_py: Python<'_>, m: &PyModule) -> PyResult<()> { -+ fn iota_client_production(_py: Python<'_>, m: &PyModule) -> PyResult<()> { - m.add_class::()?; - Ok(()) - } -``` - -Now you can continue the installation from [here](/iota.rs/getting_started/python#change-to-the-python-binding-directory). - -### Usage - -With both libraries installed you can now use them for example like this: - -```python -import json - -from iota_client import IotaClient as ShimmerClient # Imported as ShimmerClient to prevent confusion -import iota_client_production - -# Create an IotaClient instance -shimmer_client = ShimmerClient({'nodes': ['https://api.testnet.shimmer.network']}) - -# Get and print the node info -print(f'{json.dumps(shimmer_client.get_info(), indent=4)}') - -# create a client with a node -iota_client = iota_client_production.Client( - nodes_name_password=[['https://api.lb-0.h.chrysalis-devnet.iota.cafe']]) - -print(f'{json.dumps(iota_client.get_info(), indent=4)}') -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/api_reference.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/api_reference.md deleted file mode 100644 index 40c6e5c1350..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/api_reference.md +++ /dev/null @@ -1,537 +0,0 @@ ---- -description: Official IOTA Client Library Java API reference. -image: /img/logo/iota_mark_light.png -keywords: - - api - - java ---- - -# API Reference - -# Client.java - -## `public boolean getHealth(String nodeUrl) throws ClientException` - -Get the health of a given node. - -- **Parameters:** `nodeUrl` — The URL of the node to check. -- **Returns:** True if the node is healthy, false otherwise. - -## `public NodeInfoResponse getNodeInfo() throws ClientException` - -Get the node information of the given node. - -- **Returns:** The node information of the given node. - -## `public BlockId[] getTips() throws ClientException` - -Get the tips of the Tangle. - -- **Returns:** The tips of the Tangle. - -## `public BlockId postBlock(Block block) throws ClientException` - -Post a block to the node. - -- **Parameters:** `block` — The block to be posted. -- **Returns:** The block id of the block that was posted. - -## `public BlockId postBlockRaw(byte[] blockBytes) throws ClientException` - -Post a block to the node. - -- **Parameters:** `blockBytes` — The raw bytes of the block to be posted. -- **Returns:** The block id of the block that was just posted. - -## `public Block getBlock(BlockId blockId) throws ClientException` - -Get a block by its block id - -- **Parameters:** `blockId` — The block ID of the block you want to retrieve. -- **Returns:** A block object. - -## `public byte[] getBlockRaw(BlockId blockId) throws ClientException` - -Get the raw bytes of a block - -- **Parameters:** `blockId` — The block ID of the block you want to get. -- **Returns:** The raw bytes of the block. - -## `public BlockMetadata getBlockMetadata(BlockId blockId) throws ClientException` - -Get the metadata of a block - -- **Parameters:** `blockId` — The id of the block to get metadata for. -- **Returns:** BlockMetadata - -## `public Map.Entry getOutput(OutputId outputId) throws ClientException` - -Get the output with the given id - -- **Parameters:** `outputId` — The id of the output you want to get. -- **Returns:** A map entry with the output and its metadata. - -## `public OutputMetadata getOutputMetadata(OutputId outputId) throws ClientException` - -Get the metadata of an output - -- **Parameters:** `outputId` — The output ID of the output you want to get metadata for. -- **Returns:** OutputMetadata - -## `public Receipt[] getReceiptsMigratedAt(int milestoneIndex) throws ClientException` - -Returns the list of all the receipts that were migrated at the given milestone index - -- **Parameters:** `milestoneIndex` — The index of the milestone to get the receipts for. -- **Returns:** Receipts - -## `public Receipt[] getReceipts() throws ClientException` - -Get all the receipts. - -- **Returns:** An array of Receipt objects. - -## `public TreasuryResponse getTreasury() throws ClientException` - -Get the treasury balance - -- **Returns:** TreasuryResponse - -## `public Block getIncludedBlock(TransactionId transactionId) throws ClientException` - -Returns the block that contains the transaction that was included in the ledger. - -- **Parameters:** `transactionId` — The transaction that was included in the ledger. -- **Returns:** A block that contains the transaction. - -## `public MilestonePayload getMilestoneById(MilestoneId milestoneId) throws ClientException` - -Get the milestone payload for the given milestone id - -- **Parameters:** `milestoneId` — The milestone ID of the milestone you want to get. -- **Returns:** A MilestonePayload object. - -## `public MilestonePayload getMilestoneByIndex(int milestoneIndex) throws ClientException` - -Get the milestone at the specified index - -- **Parameters:** `milestoneIndex` — The index of the milestone you want to retrieve. -- **Returns:** A MilestonePayload object. - -## `public byte[] getMilestoneByIdRaw(MilestoneId milestoneId) throws ClientException` - -Returns the raw bytes of a milestone by its id - -- **Parameters:** `milestoneId` — The milestone ID to get the raw data for. -- **Returns:** A byte array of the milestone data. - -## `public byte[] getMilestoneByIndexRaw(int milestoneIndex) throws ClientException` - -Returns the raw bytes of the milestone at the given index - -- **Parameters:** `milestoneIndex` — The index of the milestone you want to retrieve. -- **Returns:** The raw bytes of the milestone at the given index. - -## `public UtxoChangesResponse getUtxoChangesById(MilestoneId milestoneId) throws ClientException` - -Returns the UTXO changes for the given milestone id - -- **Parameters:** `milestoneId` — The milestone id of the milestone to get the UTXO changes for. -- **Returns:** The UTXO changes for the given milestone index. - -## `public UtxoChangesResponse getUtxoChangesByIndex(int milestoneIndex) throws ClientException` - -Returns the UTXO changes for the given milestone index - -- **Parameters:** `milestoneIndex` — The index of the milestone to get the UTXO changes for. -- **Returns:** The UTXO changes for the given milestone index. - -## `public Peer[] getPeers() throws ClientException` - -Get the list of peers connected to the node - -- **Returns:** An array of Peer objects. - -## `public OutputId[] getBasicOutputIds(NodeIndexerApi.QueryParams params) throws ClientException` - -Returns the basic output ids that match the given query parameters - -- **Parameters:** `params` — a QueryParams object that contains the following fields: -- **Returns:** An array of OutputIds. - -## `public OutputId[] getAliasOutputIds(NodeIndexerApi.QueryParams params) throws ClientException` - -Returns the alias output ids that match the given query parameters - -- **Parameters:** `params` — a QueryParams object that contains the following fields: -- **Returns:** An array of OutputIds. - -## `public OutputId[] getNftOutputIds(NodeIndexerApi.QueryParams params) throws ClientException` - -Returns the NFT output ids that match the given query parameters - -- **Parameters:** `params` — a QueryParams object that contains the following fields: -- **Returns:** An array of OutputIds. - -## `public OutputId[] getFoundryOutputIds(NodeIndexerApi.QueryParams params) throws ClientException` - -Returns the Foundry output ids that match the given query parameters - -- **Parameters:** `params` — a QueryParams object that contains the following fields: -- **Returns:** An array of OutputIds. - -## `public OutputId getAliasOutputIdByAliasId(AliasId aliasId) throws ClientException` - -The aliasId of the alias you want to get the outputId for.eturns the output id of an alias by its alias id - -- **Parameters:** `aliasId` — The aliasId of the alias you want to get the outputId for. -- **Returns:** OutputId - -## `public OutputId getNftOutputIdByNftId(NftId nftId) throws ClientException` - -The aliasId of the alias you want to get the outputId for. - -- **Parameters:** `nftId` — The NFT Id of the NFT you want to get the outputId for. -- **Returns:** OutputId - -## `public OutputId getFoundryOutputIdByFoundryId(FoundryId foundryId) throws ClientException` - -The aliasId of the alias you want to get the outputId for. - -- **Parameters:** `foundryId` — The id of the foundry you want to get the output id for. -- **Returns:** The output id of the foundry. - -## `public List> getOutputs(OutputId[] outputIds) throws ClientException` - -Get the outputs for the given output IDs - -- **Parameters:** `outputIds` — An array of OutputId objects. -- **Returns:** A list of entries, where each entry is a pair of an Output and its OutputMetadata. - -## `public List> tryGetOutputs(OutputId[] outputIds) throws ClientException` - -Try get the outputs for the given output IDs - -- **Parameters:** `outputIds` — An array of OutputId objects. -- **Returns:** A list of entries, where each entry is a pair of an output and its metadata. - -## `public Block[] findBlocks(BlockId[] blockIds) throws ClientException` - -Finds blocks by their ids - -- **Parameters:** `blockIds` — An array of BlockId objects. -- **Returns:** An array of blocks. - -## `public Map.Entry retry(BlockId blockId) throws ClientException` - -Retry a block that has failed to process - -- **Parameters:** `blockId` — The id of the block to retry. -- **Returns:** A map entry with the block id and the block. - -## `public LinkedHashMap retryUntilIncluded(BlockId blockId, int interval, int maxAttempts) throws ClientException` - -Retry until the block is included in the blockchain - -- **Parameters:** - - `blockId` — The block ID to retry. - - `interval` — The interval in seconds between each attempt to retrieve the block. - - `maxAttempts` — The maximum number of attempts to make before giving up. -- **Returns:** A LinkedHashMap of BlockId and Block. - -## `public String consolidateFunds(SecretManager secretManager, GenerateAddressesOptions generateAddressesOptions) throws ClientException` - -This function will consolidate all funds of the wallet - -- **Parameters:** - - `secretManager` — The secret manager that holds the secret for the account you want to consolidate funds for. - - `generateAddressesOptions` — This is an object that contains the following parameters: -- **Returns:** A String containing the transaction hash. - -## `public UtxoInput[] findInputs(String[] addresses, int amount) throws ClientException` - -Finds the inputs that are needed to create a transaction with the given amount - -- **Parameters:** - - `addresses` — An array of addresses to search for inputs. - - `amount` — The amount you want to spend. -- **Returns:** An array of UtxoInput objects. - -## `public List> findOutputs(OutputId[] outputIds, String[] addresses) throws ClientException` - -Finds outputs by their ids and addresses - -- **Parameters:** - - `outputIds` — An array of OutputId objects. - - `addresses` — The addresses to search for outputs. -- **Returns:** A list of outputs and their metadata. - -## `public Map.Entry reattach(BlockId blockId) throws ClientException` - -Reattaches a block to the blockchain - -- **Parameters:** `blockId` — The id of the block to reattach. -- **Returns:** A map entry with the block id and the block. - -## `public Map.Entry reattachUnchecked(BlockId blockId) throws ClientException` - -ReattachUnchecked() reattaches a block to the tangle, without checking if it's necessary to. - -- **Parameters:** `blockId` — The block id of the block to reattach. -- **Returns:** A map entry with the block id and the block. - -## `public Map.Entry promote(BlockId blockId) throws ClientException` - -Promote a block - -- **Parameters:** `blockId` — The id of the block to promote. -- **Returns:** A map entry with the block id and the block. - -## `public Map.Entry promoteUnchecked(BlockId blockId) throws ClientException` - -Promote a block, without checking if it's necessary to. - -- **Parameters:** `blockId` — The id of the block to promote. -- **Returns:** A map entry with the block id and the block. - -## `public String bech32ToHex(String bech32) throws ClientException` - -Converts a bech32 address to a hex address - -- **Parameters:** `bech32` — bech32 address -- **Returns:** A hex string. - -## `public String hexToBech32(String hex, String bech32) throws ClientException` - -Converts a hex string to a bech32 string - -- **Parameters:** - - `hex` — The hexadecimal string to be converted. - - `bech32` — The bech32 to use. -- **Returns:** The bech32 address. - -## `public String hexPublicKeyToBech32Address(String hex, String bech32) throws ClientException` - -Converts a hex public key to a bech32 address - -- **Parameters:** - - `hex` — The public key in hexadecimal format. - - `bech32` — The bech32 prefix -- **Returns:** The bech32 address. - -## `public String parseBech32Address(String address) throws ClientException` - -This function is used to parse the Bech32 address - -- **Parameters:** `address` — The address to be parsed. -- **Returns:** The address in hex format. - -## `public boolean isAddressValid(String address) throws ClientException` - -Checks if the given address is valid - -- **Parameters:** `address` — The address to validate. -- **Returns:** A boolean value. - -## `public String generateMnemonic() throws ClientException` - -Generate a mnemonic - -- **Returns:** The mnemonic string. - -## `public String mnemonicToHexSeed(String mnemonic) throws ClientException` - -Converts a mnemonic to a hex seed - -- **Parameters:** `mnemonic` — The mnemonic to convert to a hex seed. -- **Returns:** A hex seed. - -## `public BlockId getBlockId(Block block) throws ClientException` - -This function computes the block id of a block - -- **Parameters:** `block` — The block to compute the block id from. -- **Returns:** The block id of the block. - -## `public TransactionId getTransactionId(TransactionPayload payload) throws ClientException` - -This function returns a transaction ID for a given transaction payload - -- **Parameters:** `payload` — The payload of the transaction. -- **Returns:** A TransactionId object. - -## `public AliasId computeAliasId(OutputId aliasOutputId) throws ClientException` - -Computes the alias id for the given alias output id - -- **Parameters:** `aliasOutputId` — The output ID of the alias. -- **Returns:** The alias id of the output id. - -## `public NftId computeNftId(OutputId nftOutputId) throws ClientException` - -Computes the NFT ID from the NFT output ID - -- **Parameters:** `nftOutputId` — The output id of the NFT. -- **Returns:** The NFT ID of the NFT output. - -## `public FoundryId computeFoundryId(String aliasAddress, int serialNumber, int tokenScheme) throws ClientException` - -Computes the Foundry ID for a given alias address, serial number, and token scheme - -- **Parameters:** - - `aliasAddress` — The alias address of the device. - - `serialNumber` — The serial number of the token. - - `tokenScheme` — The token scheme to use. This is a value from the TokenScheme enum. -- **Returns:** A FoundryId object. - -## `public Output buildAliasOutput( AliasOutputBuilderParams params ) throws ClientException` - -Builds an alias output - -- **Parameters:** `params` — AliasOutputBuilderParams -- **Returns:** An output object. - -## `public Output buildBasicOutput( BasicOutputBuilderParams params ) throws ClientException` - -Builds a basic output - -- **Parameters:** `params` — The parameters for the request. -- **Returns:** An output object. - -## `public Output buildFoundryOutput( FoundryOutputBuilderParams params ) throws ClientException` - -Builds a Foundry output object from the given parameters - -- **Parameters:** `params` — FoundryOutputBuilderParams -- **Returns:** An output object. - -## `public Output buildNftOutput( NftOutputBuilderParams params ) throws ClientException` - -Builds an NFT output - -- **Parameters:** `params` — NftOutputBuilderParams -- **Returns:** Output - -## `public String[] generateAddresses(SecretManager secretManager, GenerateAddressesOptions generateAddressesOptions) throws ClientException` - -Generate addresses for a given secret manager - -- **Parameters:** - - `secretManager` — The secret manager to use for generating the addresses. - - `generateAddressesOptions` — The options for generating addresses. -- **Returns:** A list of addresses - -## `public Map.Entry buildAndPostBlock(SecretManager secretManager, BuildBlockOptions options) throws ClientException` - -Builds a block and posts it to the network - -- **Parameters:** - - `secretManager` — The secret manager to use for signing the block. - - `options` — The options for building the block. -- **Returns:** A map entry with the block id and the block itself. - -## `public Node getNode() throws ClientException` - -Get a node - -- **Returns:** The node object. - -## `public JsonObject getNetworkInfo() throws ClientException` - -Get network information - -- **Returns:** A JsonObject - -## `public int getNetworkId() throws ClientException` - -Get the network ID of the current network - -- **Returns:** The network ID of the current network. - -## `public String getBech32Hrp() throws ClientException` - -Get the Bech32 HRP for the current network - -- **Returns:** The Bech32 Human Readable Part (HRP) for addresses. - -## `public float getMinPowScore() throws ClientException` - -Get the minimum PoW score required for a transaction to be accepted - -- **Returns:** The minimum PoW score. - -## `public int getTipsInterval() throws ClientException` - -Get the tips interval in seconds - -- **Returns:** The interval in seconds. - -## `public boolean getLocalPow() throws ClientException` - -Returns true if the local PoW is enabled, otherwise false. - -- **Returns:** true if the local PoW is enabled, otherwise false. - -## `public boolean getFallbackToLocalPow() throws ClientException` - -Returns true if the client is configured to fallback to local proof of work if the remote proof of work service is unavailable - -- **Returns:** true if the client is configured to fallback to local proof of work, else returns false. - -## `public Node[] getUnhealthyNodes() throws ClientException` - -Get the list of nodes that are not healthy - -- **Returns:** The array of nodes that are not healthy. - -## `public LedgerNanoStatus getLedgerNanoStatus(boolean isSimulator) throws ClientException` - -Get the status of the Ledger Nano device - -- **Parameters:** `isSimulator` — true if you want to use the simulator, false if you want to use the real device. -- **Returns:** LedgerNanoStatus - -## `public PreparedTransactionData prepareTransaction(SecretManager secretManager, BuildBlockOptions buildBlockOptions) throws ClientException` - -Prepares a transaction for signing - -- **Parameters:** - - `secretManager` — The secret manager that holds the secret for the account. - - `buildBlockOptions` — This is the object that contains the transaction details. -- **Returns:** The prepared transaction. - -## `public TransactionPayload signTransaction(SecretManager secretManager, PreparedTransactionData preparedTransactionData) throws ClientException` - -Signs the given prepared transaction using the secret manager - -- **Parameters:** - - `secretManager` — The secret manager that holds the secret key for the account that will sign the transaction. - - `preparedTransactionData` — The transaction data that was prepared by the prepareTransaction method. -- **Returns:** The signed transaction. - -## `public void storeMnemonic(SecretManager secretManager, String mnemonic) throws ClientException` - -Stores the mnemonic in the secret manager - -- **Parameters:** - - `secretManager` — The secret manager to use. - - `mnemonic` — The mnemonic to store. - -## `public Map.Entry postBlockPayload(BlockPayload payload) throws ClientException` - -Automatically builds a block containing the given block payload and broadcasts it to the network. - -- **Parameters:** `payload` — The payload to be posted. -- **Returns:** A map entry of the posted block id and the block. - -## `public String getTokenSupply() throws ClientException` - -Returns the token supply - -- **Returns:** The token supply. - -## `public String getProtocolParameters() throws ClientException` - -Returns the protocol parameters. - -- **Returns:** The protocol parameters. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_01_get_node_info/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_01_get_node_info/_code_sample.mdx deleted file mode 100644 index 234695c5ada..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_01_get_node_info/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/iota.rs/blob/develop/client/bindings/java/examples/src/GetInfo.java -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_01_get_node_info/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_01_get_node_info/_expected_output.md deleted file mode 100644 index 14dc07d0184..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_01_get_node_info/_expected_output.md +++ /dev/null @@ -1,48 +0,0 @@ -```json -{ - "name": "HORNET", - "version": "2.0.0-beta.5", - "status": { - "isHealthy": true, - "latestMilestone": { - "index": 747006, - "timestamp": 1661869119, - "milestoneId": "0x34559d7ba255d1b1127529cf4e28ccc9d5a8da4fcc811d465a8fce8107a0ef53" - }, - "confirmedMilestone": { - "index": 747006, - "timestamp": 1661869119, - "milestoneId": "0x34559d7ba255d1b1127529cf4e28ccc9d5a8da4fcc811d465a8fce8107a0ef53" - }, - "pruningIndex": 0 - }, - "supportedProtocolVersions": [2], - "protocol": { - "version": 2, - "networkName": "testnet-1", - "bech32Hrp": "rms", - "minPowScore": 1500.0, - "rentStructure": { - "vByteCost": 100, - "vByteFactorKey": 10, - "vByteFactorData": 1 - }, - "tokenSupply": "1450896407249092" - }, - "pendingProtocolParameters": [], - "baseToken": { - "name": "Shimmer", - "tickerSymbol": "SMR", - "unit": "SMR", - "subunit": "glow", - "decimals": 6, - "useMetricPrefix": false - }, - "metrics": { - "blocksPerSecond": 9.0, - "referencedBlocksPerSecond": 8.6, - "referencedRate": 95.55555555555556 - }, - "features": [] -} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_02_generate_mnemonic/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_02_generate_mnemonic/_code_sample.mdx deleted file mode 100644 index a259e450e7a..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_02_generate_mnemonic/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/java/examples/src/GenerateMnemonic.java -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_02_generate_mnemonic/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_02_generate_mnemonic/_expected_output.md deleted file mode 100644 index 0923fdcd690..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_02_generate_mnemonic/_expected_output.md +++ /dev/null @@ -1,3 +0,0 @@ -```plaintext -glance zoo dove legend razor season evoke twenty flush solution essence destroy loud traffic friend decorate emotion total borrow expect actor switch shock zer -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_03_generate_addresses/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_03_generate_addresses/_code_sample.mdx deleted file mode 100644 index 3129a06df7b..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_03_generate_addresses/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/java/examples/src/GenerateAddresses.java -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_03_generate_addresses/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_03_generate_addresses/_expected_output.md deleted file mode 100644 index 9a506537054..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_03_generate_addresses/_expected_output.md +++ /dev/null @@ -1,42 +0,0 @@ -```plaintext -List of generated public addresses: -rms1qpllaj0pyveqfkwxmnngz2c488hfdtmfrj3wfkgxtk4gtyrax0jaxzt70zy -rms1qzzk86qv30l4e85ljtccxa0ruy8y7u8zn2dle3g8dv2tl2m4cu227a7n2wj -rms1qqjrtmslm36l3lyd8086w9qdxd9mudu2z2qyywlltpycn2ftxsdmu9ulj47 -rms1qzz75j5h7vd5melxwersz49jja36m2vvnawedu0l6rlhg70ylzqp52lx8zf -rms1qzvs2rvq5ef79vhuel354mnvzfz049gyyf808zmjculuatt56u92vc4v4p3 -rms1qpk0dj5lmv5r8d64f3x0qwx3jccredwa42xscdreqma73f3dxymaqdy645t -rms1qqlp6nurrz459jvvvuhv6t965v6cmlata57kf6auv6955uyp77uyw0egzgn -rms1qq2tu523zqzjxgdl69au8a9yewmd9ztctssv40dsv7lfd0tp36w4xdfzcyr -rms1qpw904c253cc9yn2dkhxx89u6r5j9vzezfatchrlugrkcvvhed3hckx6h2u -rms1qpa646cegkqsx9eht793nmux2vjwa63jrenqe87xq8j5wysfhu4l28k4ep9 -rms1qq02yzamyu2z4rflv48cpt86kclcqr0rkxx748cf7l08l75gwtlcw54udc6 -rms1qpulq7ldsux06s92n33pwk92mmllw07lqkkdfy5g9td0v2thhx2wxmd4lec -rms1qr0wl256lkfj7gdy8x5hqpvyrwtx98flyns3l7aehheg5c04kxj0cwy9eff -rms1qq8mmsdwrt809wl6dgn2rmt7ak6082enmnqapy59xfqtyenrwsxtghxgmch -rms1qqj7667kh0fmykdc65kwad5mvhhv9sxe8kdj0wenp6nwwnf0qkdwk7v07vu -rms1qpcwqlmu2n42fvht7fufztdg2k4hhtwzzrhsvucktrhk6mlr3cpvk7q75pf -rms1qppssdyxxsfa3c2ln47ccxryh68w3jret6zx6v9r43ptr4n7fks9g3l4eup -rms1qrkq9nv9uhafnduvfgtmru99532yhqpmqugf9x9x90ptzpceujkwgj2yaj4 -rms1qptssvmyhfas223m542ayqagn06urq8v0yad770fxsj3grftqe4jzq3sh6m -rms1qr98trzs2snaeawklxnrpe3a3hahvkeydqdt3s6hps36lp8uxfzlcfx0pj6 - -List of generated public addresses: -rms1qpllaj0pyveqfkwxmnngz2c488hfdtmfrj3wfkgxtk4gtyrax0jaxzt70zy -rms1qzzk86qv30l4e85ljtccxa0ruy8y7u8zn2dle3g8dv2tl2m4cu227a7n2wj -rms1qqjrtmslm36l3lyd8086w9qdxd9mudu2z2qyywlltpycn2ftxsdmu9ulj47 -rms1qzz75j5h7vd5melxwersz49jja36m2vvnawedu0l6rlhg70ylzqp52lx8zf - -List of generated internal addresses: -rms1qp6w3v03qwtwkh52avtdvejpdqp8yfpk4z94m5dg3evuzu9hynyucvmxd59 -rms1qqv993w400a6j7darw3v5h6tevk7qx534lr8tcu47zdrazhz0z2zstmj4da -rms1qzelrg0560t52g2wjpkyyesfg7wzcm8wa89akf6eux88xtupjaqazsw7jyy -rms1qp385r3f8k64cphft8lde9emrqarfwshnlwdnguw3qr62q32dmx6wt8e0sv - -List of offline generated public addresses: -rms1qpllaj0pyveqfkwxmnngz2c488hfdtmfrj3wfkgxtk4gtyrax0jaxzt70zy -rms1qzzk86qv30l4e85ljtccxa0ruy8y7u8zn2dle3g8dv2tl2m4cu227a7n2wj -rms1qqjrtmslm36l3lyd8086w9qdxd9mudu2z2qyywlltpycn2ftxsdmu9ulj47 -rms1qzz75j5h7vd5melxwersz49jja36m2vvnawedu0l6rlhg70ylzqp52lx8zf - -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_04_get_output/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_04_get_output/_code_sample.mdx deleted file mode 100644 index 8c0cee1de22..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_04_get_output/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/java/examples/src/GetOutputs.java -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_04_get_output/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_04_get_output/_expected_output.md deleted file mode 100644 index fd3596a1fb2..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_04_get_output/_expected_output.md +++ /dev/null @@ -1,23 +0,0 @@ -```json -{ - "type": 3, - "amount": "1000000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0xf11b9d362a332263e7773350b0214b742ccffd364d678626bd15556514617058" - } - } - ] -}{ - "blockId": "0xb6e74f8a623756b26d6146ef34612890b6c858088482620eddaaf4ecb9c8b9fb", - "transactionId": "0xc66155c2bbbd8f22cb55940642aa65a8c5cd07fb1f93c7c4ff53414d45daa577", - "outputIndex": 0, - "isSpent": false, - "milestoneIndexBooked": 949, - "milestoneTimestampBooked": 1658138754, - "ledgerIndex": 749811 -} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_05_build_output/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_05_build_output/_code_sample.mdx deleted file mode 100644 index 0ca8f81c3b0..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_05_build_output/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/java/examples/src/BuildBasicOutput.java -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_05_build_output/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_05_build_output/_expected_output.md deleted file mode 100644 index 1982d5315a9..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_05_build_output/_expected_output.md +++ /dev/null @@ -1,93 +0,0 @@ -```json -{ - "type": 3, - "amount": "1000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - } - ] -} -{ - "type": 3, - "amount": "1000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - } - ], - "features": [ - { - "type": 2, - "data": "0x48656c6c6f2c20576f726c6421" - } - ] -} -{ - "type": 3, - "amount": "1000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - }, - { - "type": 1, - "returnAddress": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - }, - "amount": "1000000" - } - ] -} -{ - "type": 3, - "amount": "1000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - }, - { - "type": 3, - "returnAddress": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - }, - "unixTime": 1 - } - ] -} -{ - "type": 3, - "amount": "1000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - }, - { - "type": 2, - "unixTime": 1 - } - ] -} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_06_get_address_balances/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_06_get_address_balances/_code_sample.mdx deleted file mode 100644 index ff316d0369f..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_06_get_address_balances/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/java/examples/src/GetAddressBalance.java -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_06_get_address_balances/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_06_get_address_balances/_expected_output.md deleted file mode 100644 index 56dc4fe0e82..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_06_get_address_balances/_expected_output.md +++ /dev/null @@ -1,4 +0,0 @@ -```text -total balance: 1900755293 -native tokens: {0x0833b41872b4ef228c10a99456fb08088a52a71f3ff23330287f6c8978bc5dd6df0100000000=100, 0x089c130fa264a23492f5876e4c2673154689fa8e30945c7b60c59050b20336d2b70100000000=50, 0x083c39ef7bd9a2eb640df6a36319a7fd51d4ca190ffd5d14572c9ebb54bdc6ecab0200000000=69, 0x083118235071d4013edd2315210626ca85cf27e961a9670d81c30716dd0058a8220100000000=50, 0x08f708a29e9619e847916de76c2e167e87a704c235dcbd7cda018865be7f561b5a0200000000=32, 0x08f7763ffc30099b089045e06a4a24047787510cd01310b42fec9ca006267d4be80100000000=50} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_07_create_block/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_07_create_block/_code_sample.mdx deleted file mode 100644 index d640a48f9ca..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_07_create_block/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/java/examples/src/CreateBlock.java -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_07_create_block/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_07_create_block/_expected_output.md deleted file mode 100644 index 93e32cfc3e6..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_07_create_block/_expected_output.md +++ /dev/null @@ -1,15 +0,0 @@ -```json -{ - "type": 3, - "amount": "1000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - } - ] -} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_08_post_block/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_08_post_block/_code_sample.mdx deleted file mode 100644 index 9a9b758a463..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_08_post_block/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/java/examples/src/PostBlock.java -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_08_post_block/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_08_post_block/_expected_output.md deleted file mode 100644 index e37e5735d8a..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_08_post_block/_expected_output.md +++ /dev/null @@ -1,3 +0,0 @@ -```plaintext -0x40223bd63a8fce5065920b68af00d34813de3c8593416b3e90f27fad5cd77520 -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_08_post_raw_block/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_08_post_raw_block/_code_sample.mdx deleted file mode 100644 index 4ea0c705cec..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_08_post_raw_block/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/java/examples/src/PostBlockRaw.java -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_08_post_raw_block/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_08_post_raw_block/_expected_output.md deleted file mode 100644 index 816b77b24d5..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_08_post_raw_block/_expected_output.md +++ /dev/null @@ -1,3 +0,0 @@ -```plaintext -0x601aab8d3b391923f44528e54caff74f1e869ba8c587ddf99d277dd140289f89 -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_09_get_block/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_09_get_block/_code_sample.mdx deleted file mode 100644 index fe93a73fd60..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_09_get_block/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/java/examples/src/GetBlock.java -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_09_get_block/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_09_get_block/_expected_output.md deleted file mode 100644 index f1c1e5f7ed3..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_09_get_block/_expected_output.md +++ /dev/null @@ -1,17 +0,0 @@ -```json -{ - "protocolVersion": 2, - "parents": [ - "0x452105dc88c4c4c927dcf9b3658a99d82331583cc84e84caf58669f0fcce4588", - "0xb8d06ee5dfcf512cc782facaaf54eaac77942ff529f69b8d129fb4009b38f68f", - "0xbd2792748becac463beba3e1ad952453dd225edd6d68ddd91bb41f9a88eb5a3e", - "0xbf22b0a595927f5c44f1991662f5c0a3702f38a851c0a37dd58f8977cda102d8" - ], - "payload": { - "type": 5, - "tag": "0x484f524e4554205370616d6d6572", - "data": "0x57652061726520616c6c206d616465206f662073746172647573742e0a436f756e743a20313332343432300a54696d657374616d703a20323032322d30392d30315431343a32393a32345a0a54697073656c656374696f6e3a20343032c2b573" - }, - "nonce": "341022" -} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_10_prepare_signed_transaction/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_10_prepare_signed_transaction/_code_sample.mdx deleted file mode 100644 index 9c24d030535..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_10_prepare_signed_transaction/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/java/examples/src/PrepareAndSignTransaction.java -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_10_prepare_signed_transaction/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_10_prepare_signed_transaction/_expected_output.md deleted file mode 100644 index 6daf277ea65..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_10_prepare_signed_transaction/_expected_output.md +++ /dev/null @@ -1,3 +0,0 @@ -```plaintext -0x7ba03b57da610bc2f3b0361b8e00f82416ce7755113c789ef3c7978bf3356f23 -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_11_nft_output/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_11_nft_output/_code_sample.mdx deleted file mode 100644 index dd9feef2eb1..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_11_nft_output/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/java/examples/src/BuildNftOutput.java -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_11_nft_output/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_11_nft_output/_expected_output.md deleted file mode 100644 index e980ceb0fec..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_11_nft_output/_expected_output.md +++ /dev/null @@ -1,16 +0,0 @@ -```json -{ - "type": 6, - "amount": "45900", - "nftId": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - } - ] -} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_12_foundry_output/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_12_foundry_output/_code_sample.mdx deleted file mode 100644 index dbbe03aa8c4..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_12_foundry_output/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/java/examples/src/BuildFoundryOutput.java -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_12_foundry_output/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_12_foundry_output/_expected_output.md deleted file mode 100644 index 221dad13c3e..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_12_foundry_output/_expected_output.md +++ /dev/null @@ -1,28 +0,0 @@ -```json -{ - "type": 5, - "amount": "59800", - "nativeTokens": [ - { - "id": "0x081e6439529b020328c08224b43172f282cb16649d50c891fa156365323667e47a0100000000", - "amount": "0x32" - } - ], - "serialNumber": 1, - "tokenScheme": { - "type": 0, - "mintedTokens": "0x32", - "meltedTokens": "0x0", - "maximumSupply": "0x64" - }, - "unlockConditions": [ - { - "type": 6, - "address": { - "type": 8, - "aliasId": "0xa5c28d5baa951de05e375fb19134ea51a918f03acc2d0cee011a42b298d3effa" - } - } - ] -} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_13_alias_output/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_13_alias_output/_code_sample.mdx deleted file mode 100644 index f5be6d08d83..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_13_alias_output/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/iota.rs/blob/develop/client/bindings/java/examples/src/BuildAliasOutput.java -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_13_alias_output/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_13_alias_output/_expected_output.md deleted file mode 100644 index b839929cb92..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_13_alias_output/_expected_output.md +++ /dev/null @@ -1,54 +0,0 @@ -```json -{ - "jsonObject": { - "type": 4, - "amount": "59200", - "aliasId": "0x0000000000000000000000000000000000000000000000000000000000000000", - "stateIndex": 0, - "stateMetadata": "0x68656c6c6f", - "foundryCounter": 0, - "unlockConditions": [ - { - "type": 4, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - }, - { - "type": 5, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - } - ], - "features": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - }, - { - "type": 2, - "data": "0x68656c6c6f" - } - ], - "immutableFeatures": [ - { - "type": 1, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - }, - { - "type": 2, - "data": "0x68656c6c6f" - } - ] - } -} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_run_how_tos.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_run_how_tos.mdx deleted file mode 100644 index 7d6bf2c92f6..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/java/how_to/_run_how_tos.mdx +++ /dev/null @@ -1,25 +0,0 @@ -### Clone the Repository - -To run the examples, you will first need to clone the repository. You can do so by running the following command: - -```bash -git clone git@github.com:iotaledger/iota.rs.git -``` - -Then, move into the Java examples folder by running the following command: - -```bash -cd iota.rs/client/bindings/java/examples -``` - -## Run Code Examples - -The IOTA Client Java library has numerous [examples](https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/java/examples/src) -you can run to get acquainted with the library. You can run any example with the following -command from the `examples` directory: - -```bash -.././gradlew run -Pexample=GetInfo -``` - -To run another example of your choice, replace `GetInfo` with the name of any other example from the [Java examples directory](https://github.com/iotaledger/iota.rs/tree/develop/bindings/java/examples/src). diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_01_get_node_info/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_01_get_node_info/_code_sample.mdx deleted file mode 100644 index 07c9d7290d9..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_01_get_node_info/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```ts reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/nodejs/examples/00_get_info.ts -``` - -You can run the example by running the following command from the `bindings/node/examples/` folder: - -```bash -node dist/00_get_info.js -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_01_get_node_info/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_01_get_node_info/_expected_output.md deleted file mode 100644 index 841881a5a79..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_01_get_node_info/_expected_output.md +++ /dev/null @@ -1,39 +0,0 @@ -```json -Node info: { - nodeInfo: { - name: 'HORNET', - version: '2.0.0-beta.5', - status: { - isHealthy: true, - latestMilestone: [Object], - confirmedMilestone: [Object], - pruningIndex: 0 - }, - supportedProtocolVersions: [ 2 ], - protocol: { - version: 2, - networkName: 'testnet-1', - bech32Hrp: 'rms', - minPowScore: 1500, - rentStructure: [Object], - tokenSupply: '1450896407249092' - }, - pendingProtocolParameters: [], - baseToken: { - name: 'Shimmer', - tickerSymbol: 'SMR', - unit: 'SMR', - subunit: 'glow', - decimals: 6, - useMetricPrefix: false - }, - metrics: { - blocksPerSecond: 10.4, - referencedBlocksPerSecond: 10, - referencedRate: 96.15384615384616 - }, - features: [] - }, - url: 'https://api.testnet.shimmer.network' -} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_01_get_node_info/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_01_get_node_info/_key_api_ref_links.md deleted file mode 100644 index 60c881f7720..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_01_get_node_info/_key_api_ref_links.md +++ /dev/null @@ -1,22 +0,0 @@ -### Build a `Client` - -You can build [`Client`](./../libraries/nodejs/references/classes/Client) by instantiating it and passing -your [IClientOptions](./../libraries/nodejs/references/interfaces/IClientOptions). - -#### IClientOptions - -##### Specify your node's URL - -The example uses the node defined in your `.env` file, but you could send any node URL in the `nodes` property. - -##### Enable local proof of work - -The code example enables local proof of work by -sending [`localPow`](./../libraries/nodejs/references/interfaces/IClientOptions#localpow) -as `true`. - -### Get the Node's Info - -Once you have built the `Client`, you can retrieve the node's information by -running [`Client.getInfo()`](./../libraries/nodejs/references/classes/Client#getinfo). This function will target -the `/api/v2/info` endpoint and return the node's information as well as its URL if successful. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_02_generate_mnemonic/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_02_generate_mnemonic/_code_sample.mdx deleted file mode 100644 index acb490f7659..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_02_generate_mnemonic/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```ts reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/nodejs/examples/01_mnemonic.ts -``` - -You can run the example by running the following command from the `bindings/node/examples/` folder: - -```bash -node dist/01_mnemonic.js -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_02_generate_mnemonic/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_02_generate_mnemonic/_expected_output.md deleted file mode 100644 index 0d0490dc64a..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_02_generate_mnemonic/_expected_output.md +++ /dev/null @@ -1,3 +0,0 @@ -```plaintext -Mnemonic: glance zoo dove legend razor season evoke twenty flush solution essence destroy loud traffic friend decorate emotion total borrow expect actor switch shock zer -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_02_generate_mnemonic/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_02_generate_mnemonic/_key_api_ref_links.md deleted file mode 100644 index 2e2dccf984f..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_02_generate_mnemonic/_key_api_ref_links.md +++ /dev/null @@ -1,4 +0,0 @@ -### Generate the Mnemonic - -You can generate a mnemonic by calling -the [`Client.generateMnemonic()`](./../libraries/nodejs/references/classes/Client#generatemnemonic) function. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_03_generate_addresses/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_03_generate_addresses/_code_sample.mdx deleted file mode 100644 index 8f3a91c2373..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_03_generate_addresses/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```ts reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/nodejs/examples/02_generate_addresses.ts -``` - -You can run the example by running the following command from the `bindings/node/examples/` folder: - -```bash -node dist/02_generate_addresses.js -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_03_generate_addresses/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_03_generate_addresses/_expected_output.md deleted file mode 100644 index 63e11fcdb45..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_03_generate_addresses/_expected_output.md +++ /dev/null @@ -1,45 +0,0 @@ -```plaintext -List of generated public addresses: [ - 'rms1qpllaj0pyveqfkwxmnngz2c488hfdtmfrj3wfkgxtk4gtyrax0jaxzt70zy', - 'rms1qzzk86qv30l4e85ljtccxa0ruy8y7u8zn2dle3g8dv2tl2m4cu227a7n2wj', - 'rms1qqjrtmslm36l3lyd8086w9qdxd9mudu2z2qyywlltpycn2ftxsdmu9ulj47', - 'rms1qzz75j5h7vd5melxwersz49jja36m2vvnawedu0l6rlhg70ylzqp52lx8zf', - 'rms1qzvs2rvq5ef79vhuel354mnvzfz049gyyf808zmjculuatt56u92vc4v4p3', - 'rms1qpk0dj5lmv5r8d64f3x0qwx3jccredwa42xscdreqma73f3dxymaqdy645t', - 'rms1qqlp6nurrz459jvvvuhv6t965v6cmlata57kf6auv6955uyp77uyw0egzgn', - 'rms1qq2tu523zqzjxgdl69au8a9yewmd9ztctssv40dsv7lfd0tp36w4xdfzcyr', - 'rms1qpw904c253cc9yn2dkhxx89u6r5j9vzezfatchrlugrkcvvhed3hckx6h2u', - 'rms1qpa646cegkqsx9eht793nmux2vjwa63jrenqe87xq8j5wysfhu4l28k4ep9', - 'rms1qq02yzamyu2z4rflv48cpt86kclcqr0rkxx748cf7l08l75gwtlcw54udc6', - 'rms1qpulq7ldsux06s92n33pwk92mmllw07lqkkdfy5g9td0v2thhx2wxmd4lec', - 'rms1qr0wl256lkfj7gdy8x5hqpvyrwtx98flyns3l7aehheg5c04kxj0cwy9eff', - 'rms1qq8mmsdwrt809wl6dgn2rmt7ak6082enmnqapy59xfqtyenrwsxtghxgmch', - 'rms1qqj7667kh0fmykdc65kwad5mvhhv9sxe8kdj0wenp6nwwnf0qkdwk7v07vu', - 'rms1qpcwqlmu2n42fvht7fufztdg2k4hhtwzzrhsvucktrhk6mlr3cpvk7q75pf', - 'rms1qppssdyxxsfa3c2ln47ccxryh68w3jret6zx6v9r43ptr4n7fks9g3l4eup', - 'rms1qrkq9nv9uhafnduvfgtmru99532yhqpmqugf9x9x90ptzpceujkwgj2yaj4', - 'rms1qptssvmyhfas223m542ayqagn06urq8v0yad770fxsj3grftqe4jzq3sh6m', - 'rms1qr98trzs2snaeawklxnrpe3a3hahvkeydqdt3s6hps36lp8uxfzlcfx0pj6' -] - -List of generated public addresses: [ - 'rms1qpllaj0pyveqfkwxmnngz2c488hfdtmfrj3wfkgxtk4gtyrax0jaxzt70zy', - 'rms1qzzk86qv30l4e85ljtccxa0ruy8y7u8zn2dle3g8dv2tl2m4cu227a7n2wj', - 'rms1qqjrtmslm36l3lyd8086w9qdxd9mudu2z2qyywlltpycn2ftxsdmu9ulj47', - 'rms1qzz75j5h7vd5melxwersz49jja36m2vvnawedu0l6rlhg70ylzqp52lx8zf' -] - -List of generated internal addresses: [ - 'rms1qp6w3v03qwtwkh52avtdvejpdqp8yfpk4z94m5dg3evuzu9hynyucvmxd59', - 'rms1qqv993w400a6j7darw3v5h6tevk7qx534lr8tcu47zdrazhz0z2zstmj4da', - 'rms1qzelrg0560t52g2wjpkyyesfg7wzcm8wa89akf6eux88xtupjaqazsw7jyy', - 'rms1qp385r3f8k64cphft8lde9emrqarfwshnlwdnguw3qr62q32dmx6wt8e0sv' -] - -List of offline generated public addresses: [ - 'rms1qpllaj0pyveqfkwxmnngz2c488hfdtmfrj3wfkgxtk4gtyrax0jaxzt70zy', - 'rms1qzzk86qv30l4e85ljtccxa0ruy8y7u8zn2dle3g8dv2tl2m4cu227a7n2wj', - 'rms1qqjrtmslm36l3lyd8086w9qdxd9mudu2z2qyywlltpycn2ftxsdmu9ulj47', - 'rms1qzz75j5h7vd5melxwersz49jja36m2vvnawedu0l6rlhg70ylzqp52lx8zf' -] -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_03_generate_addresses/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_03_generate_addresses/_key_api_ref_links.md deleted file mode 100644 index 065f46985b5..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_03_generate_addresses/_key_api_ref_links.md +++ /dev/null @@ -1,33 +0,0 @@ -:::danger - -This example uses a mnemonic stored within the `.env` file. This is not safe, so you should not use this in a production -environment. - -::: - -### Generate the Address - -You can generate an address from a [mnemonic](../../../../how_tos/02_generate_mnemonic.mdx) by calling -the [`Client.generateAddresses(secretManager, generateAddressesOptions)`](./../libraries/nodejs/references/classes/Client#generateAddresses) -function. If successful, the function will return a string representing the generated address. - -#### Use a `SecretManager` - -You should not pass the mnemonic as plaintext. Instead, you should create -a [`SecretManager`](./..libraries/nodejs/references/api_ref#secretmanager) instance and pass that to the -`Client.generateAddresses(secretManager, generateAddressesOptions)` function. - -#### Add `generateAddressesOptions` - -You can also pass a list -of [`generateAddressOptions`](./../libraries/nodejs/references/interfaces/IGenerateAddressesOptions) to -the `Client.generateAddresses(secretManager, generateAddressesOptions)` function. - -##### `internal` - -This `generateAddressesOption` indicates if the address you are about to create will be `internal` or `public`. - -##### `bech32Hrp` - -By default, the `Client.generateAddresses(secretManager, generateAddressesOptions)` will get the `bech32Hrp` from the -node's information. If you want to generate an address `offline`, you will need to set this option manually. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_04_get_output/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_04_get_output/_code_sample.mdx deleted file mode 100644 index 79a4a8f487a..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_04_get_output/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```ts reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/nodejs/examples/04_get_output.ts -``` - -You can run the example by running the following command from the `bindings/node/examples/` folder: - -```bash -node dist/04_get_output.js -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_04_get_output/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_04_get_output/_expected_output.md deleted file mode 100644 index f652ac6ef5f..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_04_get_output/_expected_output.md +++ /dev/null @@ -1,61 +0,0 @@ -```json -{ - 'metadata': { - 'blockId': '0xa9f11aba1e9965173dc21a47ec4fbfe5b953a6e60277857a3f7a5c1499e7c454', - 'transactionId': '0x1e857d380f813d8035e487b6dfd2ff4740b6775273ba1b576f01381ba2a1a44c', - 'outputIndex': 0, - 'isSpent': True, - 'milestoneIndexSpent': 249147, - 'milestoneTimestampSpent': 1659379781, - 'transactionIdSpent': '0xa927ea21d3c4a49d5c73169c80302ddb223894c182a4b7cfef0af89568262749', - 'milestoneIndexBooked': 249145, - 'milestoneTimestampBooked': 1659379771, - 'ledgerIndex': 749737 - }, - 'output': { - 'type': 4, - 'amount': '2000000', - 'aliasId': '0x0000000000000000000000000000000000000000000000000000000000000000', - 'stateIndex': 0, - 'foundryCounter': 0, - 'unlockConditions': [ - { - 'type': 4, - 'address': { - 'type': 0, - 'pubKeyHash': '0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3' - } - }, - { - 'type': 5, - 'address': { - 'type': 0, - 'pubKeyHash': '0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3' - } - } - ], - 'features': [ - { - 'type': 0, - 'address': { - 'type': 0, - 'pubKeyHash': '0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3' - } - }, - { - 'type': 2, - 'data': '0x010203' - } - ], - 'immutableFeatures': [ - { - 'type': 1, - 'address': { - 'type': 0, - 'pubKeyHash': '0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3' - } - } - ] - } -} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_04_get_output/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_04_get_output/_key_api_ref_links.md deleted file mode 100644 index daacc3fa9ce..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_04_get_output/_key_api_ref_links.md +++ /dev/null @@ -1,10 +0,0 @@ -## Get an Output by ID - -You can retrieve any output using its `outputId` (transaction id + output index) by calling -the [`Client.getOutput(outputId)`](./../libraries/nodejs/references/classes/Client#getoutput) function and providing a -valid output ID. - -If the function is successful, it will return an `IOutputResponse` with the block's metadata and the -output object. - -This function call will target the `GET /api/core/v2/outputs/{outputId}` endpoint. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_05_build_output/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_05_build_output/_code_sample.mdx deleted file mode 100644 index 3ab39801824..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_05_build_output/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```ts reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/nodejs/examples/11_build_output.ts -``` - -You can run the example by running the following command from the `bindings/node/examples/` folder: - -```bash -node dist/11_build_output.js -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_05_build_output/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_05_build_output/_expected_output.md deleted file mode 100644 index 1982d5315a9..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_05_build_output/_expected_output.md +++ /dev/null @@ -1,93 +0,0 @@ -```json -{ - "type": 3, - "amount": "1000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - } - ] -} -{ - "type": 3, - "amount": "1000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - } - ], - "features": [ - { - "type": 2, - "data": "0x48656c6c6f2c20576f726c6421" - } - ] -} -{ - "type": 3, - "amount": "1000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - }, - { - "type": 1, - "returnAddress": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - }, - "amount": "1000000" - } - ] -} -{ - "type": 3, - "amount": "1000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - }, - { - "type": 3, - "returnAddress": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - }, - "unixTime": 1 - } - ] -} -{ - "type": 3, - "amount": "1000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - }, - { - "type": 2, - "unixTime": 1 - } - ] -} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_05_build_output/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_05_build_output/_key_api_ref_links.md deleted file mode 100644 index 90b3a483df2..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_05_build_output/_key_api_ref_links.md +++ /dev/null @@ -1,10 +0,0 @@ -### Build a Basic Output - -You can create a basic output by calling -the [`Client.buildBasicOutput(options)`](/libraries/nodejs/references/classes/Client#buildbasicoutput) -function. - -#### Available Options - -You can find the list of available `options` in -the [`IBasicOutputBuilderOptions` interface](/libraries/nodejs/references/interfaces/IBasicOutputBuilderOptions). diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_06_get_address_balances/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_06_get_address_balances/_code_sample.mdx deleted file mode 100644 index ca50ba6c59b..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_06_get_address_balances/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```ts reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/nodejs/examples/05_get_address_balance -``` - -You can run the example by running the following command from the `bindings/node/examples/` folder: - -```bash -node dist/05_get_address_balance.js -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_06_get_address_balances/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_06_get_address_balances/_expected_output.md deleted file mode 100644 index 500e874d94c..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_06_get_address_balances/_expected_output.md +++ /dev/null @@ -1,9 +0,0 @@ -```json -Outputs controlled by rms1qpllaj0pyveqfkwxmnngz2c488hfdtmfrj3wfkgxtk4gtyrax0jaxzt70zy have: 2609275800 glow and native tokens: { - '0x0808fb702d67fdb320b5959f152c0f962630515d904c71ed09447c341a6cc171de0100000000': 100, - '0x0822ceb3166ad125d310e6660f5fc292356f87f2f9566e982ea22154cec3847b3f0100000000': 100, - '0x085c6b799750bdf7e5a5c81144465a0676bc11dab74b997444ca369949341720e80100000000': 100, - '0x08f708a29e9619e847916de76c2e167e87a704c235dcbd7cda018865be7f561b5a0100000000': 50, - '0x08f1802858831220b282ccc4c557676d61f79833869de378ce9a81f736976ce39f0100000000': 50 -} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_06_get_address_balances/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_06_get_address_balances/_key_api_ref_links.md deleted file mode 100644 index 9378a7e37c1..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_06_get_address_balances/_key_api_ref_links.md +++ /dev/null @@ -1,32 +0,0 @@ -### `Client.basicOutputIds(queryParameters)` - -You can retrieve outputs from any given address using the [`Client.basicOutputIds(queryParameters)`](./../nodejs/references/classes/Client#basicoutputids) -function. - -This function will query the `api/indexer/v1/outputs/basic` endpoint. - -#### `QueryParameters` - -You should pass the [QueryParameters](./../libraries/nodejs/references/api_ref#queryparameter) as an array of objects. -The following parameters are used in the example: - -##### address - -The Bech32-encoded address that should be searched for. - -##### hasExpiration - -Indicates if the outputs should have an expiration unlock condition or not. - -##### hasTimeLock - -Indicates if the outputs should have a time-locked unlock condition or not. - -##### hasStorageDepositReturn - -Indicates if the outputs should have storage deposit return unlock condition or not. - -### `Client.getOutputs(outputIds)` - -The [`Client.getOutputs(outputIds)`](./../libraries/nodejs/references/classes/Client#getoutputs) will query the node for a list -of `outputIds` in parallel. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_07_create_block/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_07_create_block/_code_sample.mdx deleted file mode 100644 index b08831c60ab..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_07_create_block/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```ts reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/nodejs/examples/06_simple_block.ts -``` - -You can run the example by running the following command from the `bindings/node/examples/` folder: - -```bash -node dist/06_simple_block.js -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_07_create_block/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_07_create_block/_expected_output.md deleted file mode 100644 index 47f9854f81e..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_07_create_block/_expected_output.md +++ /dev/null @@ -1,17 +0,0 @@ -```json -Block: [ - '0x7531a0983f941e50b1764165d8cf1e205605c269f43796d18e38264ddfce8d06', - { - protocolVersion: 2, - parents: [ - '0x649914f510d1f9e8bb54f3ea0c810f7b591377a36edae8698df8a5be7e080e36', - '0x76e0ce892ae9b3f0707ea6c068a3ee4faf98ac66e8089773a6ffe3951c6f111a', - '0x8461d818b5fca64848f475aae434d994592bf0f5648b3ff7470e75437768295d', - '0x994bcacab8bfc939a201e9ccf5a75eec2d047324a8a905cf1a4c1e09f3e1002a' - ], - nonce: '3074457345618276659' - } -] - -Empty block sent: https://explorer.shimmer.network/testnet/block/0x7531a0983f941e50b1764165d8cf1e205605c269f43796d18e38264ddfce8d06 -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_07_create_block/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_07_create_block/_key_api_ref_links.md deleted file mode 100644 index cb7c01215a6..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_07_create_block/_key_api_ref_links.md +++ /dev/null @@ -1,7 +0,0 @@ -### `Client.buildAndPostBlock(secretManager?, options?)` - -You can create a simple empty block by calling -the [`Client.buildAndPostBlock(secretManager?, options?)`](./../libraries/nodejs/references/classes/Client#buildandpostblock) -function. - -If successful, the function will return the created block. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_08_post_block/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_08_post_block/_code_sample.mdx deleted file mode 100644 index 784ca45a160..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_08_post_block/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```ts reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/nodejs/examples/08_data_block.ts -``` - -You can run the example by running the following command from the `bindings/node/examples/` folder: - -```bash -node dist/08_data_block.js -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_08_post_block/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_08_post_block/_expected_output.md deleted file mode 100644 index 85feaf3a864..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_08_post_block/_expected_output.md +++ /dev/null @@ -1,31 +0,0 @@ -```json -Block: [ - '0x0f8c244774ced9003ec0f33f9677fbee849bfebf895f97d4378c881a4d9a9d48', - { - protocolVersion: 2, - parents: [ - '0x5d06623466c838d442eb662774beab3104f389bcf72020936bbd8f7f3bf78a7e', - '0x75ceb6fe9cf7e0ac5a244f6cf6dc9ebd606814006b332740c88db04793ef79f3', - '0x7d46b355780a41c66b483d775842fa7488f87bd7f9d4d438ee85e9ded914dffb', - '0x8f68b3a47424ebeb77c4108096c38b8fbd7201f2e189dcf0a17929109195ec09' - ], - payload: { type: 5, tag: '0x48656c6c6f', data: '0x54616e676c65' }, - nonce: '10760600709663905547' - } -] - -Block sent: https://explorer.shimmer.network/testnet/block/0x0f8c244774ced9003ec0f33f9677fbee849bfebf895f97d4378c881a4d9a9d48 - -Block data: { - protocolVersion: 2, - parents: [ - '0x5d06623466c838d442eb662774beab3104f389bcf72020936bbd8f7f3bf78a7e', - '0x75ceb6fe9cf7e0ac5a244f6cf6dc9ebd606814006b332740c88db04793ef79f3', - '0x7d46b355780a41c66b483d775842fa7488f87bd7f9d4d438ee85e9ded914dffb', - '0x8f68b3a47424ebeb77c4108096c38b8fbd7201f2e189dcf0a17929109195ec09' - ], - payload: { type: 5, tag: '0x48656c6c6f', data: '0x54616e676c65' }, - nonce: '10760600709663905547' -} -Decoded data: Tangle -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_08_post_block/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_08_post_block/_key_api_ref_links.md deleted file mode 100644 index 8427fdb36e6..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_08_post_block/_key_api_ref_links.md +++ /dev/null @@ -1,9 +0,0 @@ -### `Client.postBlock(blockId)` - -You can post a block in JSON format using -the [`Client.postBlock(block)`](./../libraries/nodejs/references/classes/Client#postblock) -function. - -If successful, the function will return the ID of the submitted block. - -This function queries the `POST JSON to /api/core/v2/blocks` endpoint. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_09_get_block/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_09_get_block/_code_sample.mdx deleted file mode 100644 index eba99e0a40e..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_09_get_block/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```ts reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/nodejs/examples/07_get_block_data.ts -``` - -You can run the example by running the following command from the `bindings/node/examples/` folder: - -```bash -node dist/07_get_block_data.js -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_09_get_block/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_09_get_block/_expected_output.md deleted file mode 100644 index 596cdafa2c9..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_09_get_block/_expected_output.md +++ /dev/null @@ -1,39 +0,0 @@ -```json -Block: [ - '0xb6133638cb4653f3d00585e114dc64db22ed2c9402f03ca5e7894e236673662e', - { - protocolVersion: 2, - parents: [ - '0x03191e7d2cea9b2a9c0dc0ff4d43bfd3f95aad7c7d45d7ebd9f7825f0a108c26', - '0x7e914209c791fe529bcae19870c21b1ceab8b0e529ef884797395ae73d90c318', - '0xdbc196d4e46d0fb9c3a7aba24213840e09b107c1c7510974b19b83ef4ab93b75', - '0xfcae9899666214e0c831e63caaec4030d83380fd2d7194a2ae23abecfd987dc2' - ], - nonce: '1537228672809154665' - } -] - -Block metadata: { - blockId: '0xb6133638cb4653f3d00585e114dc64db22ed2c9402f03ca5e7894e236673662e', - parents: [ - '0x03191e7d2cea9b2a9c0dc0ff4d43bfd3f95aad7c7d45d7ebd9f7825f0a108c26', - '0x7e914209c791fe529bcae19870c21b1ceab8b0e529ef884797395ae73d90c318', - '0xdbc196d4e46d0fb9c3a7aba24213840e09b107c1c7510974b19b83ef4ab93b75', - '0xfcae9899666214e0c831e63caaec4030d83380fd2d7194a2ae23abecfd987dc2' - ], - isSolid: true, - shouldPromote: false, - shouldReattach: false -} - -Block data: { - protocolVersion: 2, - parents: [ - '0x03191e7d2cea9b2a9c0dc0ff4d43bfd3f95aad7c7d45d7ebd9f7825f0a108c26', - '0x7e914209c791fe529bcae19870c21b1ceab8b0e529ef884797395ae73d90c318', - '0xdbc196d4e46d0fb9c3a7aba24213840e09b107c1c7510974b19b83ef4ab93b75', - '0xfcae9899666214e0c831e63caaec4030d83380fd2d7194a2ae23abecfd987dc2' - ], - nonce: '1537228672809154665' -} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_09_get_block/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_09_get_block/_key_api_ref_links.md deleted file mode 100644 index 476d1392fc1..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_09_get_block/_key_api_ref_links.md +++ /dev/null @@ -1,19 +0,0 @@ -### `Client.getBlock(blockId)` - -You can retrieve a block's metadata using its block ID using -the [`Client.getBlock(blockId)`](./../libraries/nodejs/references/classes/Client#getblock) -function. - -If successful, the function will return the block's as JSON. - -This function queries the `GET /api/core/v2/blocks/{BlockId}` endpoint. - -### `Client.getBlockMetadata(blockId)` - -You can retrieve a block's metadata using its block ID using -the [`Client.getBlockMetadata(blockId)`](./../libraries/nodejs/references/classes/Client#getblockmetadata) -function. - -If successful, the function will return the block's metadata as JSON. - -This function queries the `GET /api/core/v2/blocks/{BlockId}/metadata` endpoint. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_10_prepare_signed_transaction/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_10_prepare_signed_transaction/_code_sample.mdx deleted file mode 100644 index ddf66679e41..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_10_prepare_signed_transaction/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```ts reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/nodejs/examples/09_transaction.ts -``` - -You can run the example by running the following command from the `bindings/node/examples/` folder: - -```bash -node dist/09_transaction.js -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_10_prepare_signed_transaction/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_10_prepare_signed_transaction/_expected_output.md deleted file mode 100644 index ebf9f3e6535..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_10_prepare_signed_transaction/_expected_output.md +++ /dev/null @@ -1,19 +0,0 @@ -```json -Block: [ - '0x8c48950b2796c5d60e5aafd481c34ef6395d078f28b69c3001372b89142a729a', - { - protocolVersion: 2, - parents: [ - '0x0b367672968b2ae56e2f8e90dc669489776a914e37f3c31f862cd61261ca58d5', - '0x72034b2c23c772af077dc3fba9d60eb6363efe18f1fe32292baa529867e41947', - '0x85f6b7ba90b46e706cba223142475a1b0da41a333ff2bc84b1031c093eebdecf', - '0xb365c2c7e05c9a0edc7c7a1351711cf09f92b3fdb09957b5e7cac5577b395f63' - ], - payload: { type: 6, essence: [Object], unlocks: [Array] }, - nonce: '4611686018427398146' - } -] - -Transaction sent: https://explorer.shimmer.network/testnet/block/0x8c48950b2796c5d60e5aafd481c34ef6395d078f28b69c3001372b89142a729a - -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_10_prepare_signed_transaction/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_10_prepare_signed_transaction/_key_api_ref_links.md deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_11_nft_output/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_11_nft_output/_code_sample.mdx deleted file mode 100644 index fb422b00c6f..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_11_nft_output/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```ts reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/nodejs/examples/15_build_nft_output.ts -``` - -You can run the example by running the following command from the `bindings/node/examples/` folder: - -```bash -node dist/15_build_nft_output.js -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_11_nft_output/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_11_nft_output/_expected_output.md deleted file mode 100644 index bfa65f345dd..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_11_nft_output/_expected_output.md +++ /dev/null @@ -1,9 +0,0 @@ -```json -{ - type: 6, - amount: '1000000', - nftId: '0x0000000000000000000000000000000000000000000000000000000000000000', - unlockConditions: [ { type: 0, address: [Object] } ], - immutableFeatures: [ { type: 2, data: '0x68656c6c6f' } ] -} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_11_nft_output/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_11_nft_output/_key_api_ref_links.md deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_12_foundry_output/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_12_foundry_output/_code_sample.mdx deleted file mode 100644 index ea25c796138..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_12_foundry_output/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```ts reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/nodejs/examples/14_build_foundry_output.ts -``` - -You can run the example by running the following command from the `bindings/node/examples/` folder: - -```bash -node dist/14_build_foundry_output.js -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_12_foundry_output/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_12_foundry_output/_expected_output.md deleted file mode 100644 index 7546eeb5cec..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_12_foundry_output/_expected_output.md +++ /dev/null @@ -1,14 +0,0 @@ -```json -{ - type: 5, - amount: '1000000', - serialNumber: 0, - tokenScheme: { - type: 0, - mintedTokens: '0xa', - meltedTokens: '0x0', - maximumSupply: '0xa' - }, - unlockConditions: [ { type: 6, address: [Object] } ] -} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_12_foundry_output/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_12_foundry_output/_key_api_ref_links.md deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_13_alias_output/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_13_alias_output/_code_sample.mdx deleted file mode 100644 index 13eaca6586d..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_13_alias_output/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```ts reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/nodejs/examples/13_build_alias_output.ts -``` - -You can run the example by running the following command from the `bindings/node/examples/` folder: - -```bash -node dist/13_build_alias_output.js -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_13_alias_output/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_13_alias_output/_expected_output.md deleted file mode 100644 index 08ee7d63c51..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_13_alias_output/_expected_output.md +++ /dev/null @@ -1,52 +0,0 @@ -```json -{ - "type": 4, - "amount": "59200", - "aliasId": "0x0000000000000000000000000000000000000000000000000000000000000000", - "stateIndex": 0, - "stateMetadata": "0x68656c6c6f", - "foundryCounter": 0, - "unlockConditions": [ - { - "type": 4, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - }, - { - "type": 5, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - } - ], - "features": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - }, - { - "type": 2, - "data": "0x68656c6c6f" - } - ], - "immutableFeatures": [ - { - "type": 1, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - }, - { - "type": 2, - "data": "0x68656c6c6f" - } - ] -} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_13_alias_output/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_13_alias_output/_key_api_ref_links.md deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_14_mqtt/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_14_mqtt/_code_sample.mdx deleted file mode 100644 index 3cb4c365118..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_14_mqtt/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```ts reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/nodejs/examples/10_mqtt.ts -``` - -You can run the example by running the following command from the `bindings/node/examples/` folder: - -```bash -node dist/10_mqtt.js -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_14_mqtt/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_14_mqtt/_expected_output.md deleted file mode 100644 index e6ee3698d30..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_14_mqtt/_expected_output.md +++ /dev/null @@ -1,23 +0,0 @@ -```json -{ - topic: 'blocks', - payload: { - "protocolVersion": 2, - "parents": [ - "0x7298db112c825c949ae399b26fa01e6147e916c1dcaff2a2fc487f3beca37f3e", - "0x7d052b5938882ed514a8419f0daaa567e029fd26bb8384a782fadc73bf4197e1", - "0xb732a27feb1817bee363efdeb88fa4d3c7ff3ebf44ff72f2e3decc6bf26bfc6e", - "0xc24af5a4ebdbd4e5be7b0858ca5d3b3333d482c336cd4df3a69a487df31039c6" - ], - "payload": { - "type": 5, - "tag": "0x484f524e4554205370616d6d6572", - "data": "0x57652061726520616c6c206d616465206f662073746172647573742e0a436f756e743a20353339323036340a54696d657374616d703a20323032322d30392d30325431333a34383a31375a0a54697073656c656374696f6e3a20393131c2b573" - }, - "nonce": "187545" - } -}, -[ - ... -] -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_14_mqtt/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_14_mqtt/_key_api_ref_links.md deleted file mode 100644 index 78305a81d3e..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_14_mqtt/_key_api_ref_links.md +++ /dev/null @@ -1,3 +0,0 @@ -import ComingSoon from "../../../../\_admonitions/\_guide_coming_soon.md" - - diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_run_how_tos.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_run_how_tos.mdx deleted file mode 100644 index ee3ff261cec..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/how_to/_run_how_tos.mdx +++ /dev/null @@ -1,44 +0,0 @@ -## Prerequisites - -Before you can run the examples, please refer to the [Node.js Getting Started guide](./../../../getting_started/nodejs.mdx) to install -the library. - -## Build the Examples - -### Set Up Your `.env` File - -The examples use variables from a `.env` file. Though you can create your own, for the examples you can simply copy the -existing [`.env.example`](https://github.com/iotaledger/iota.rs/blob/develop/bindings/nodejs/.env.example) file. You can -do this running the following command from the `bindings/nodejs` directory: - -```bash -cp .env.example .env -``` - -### Build All the Examples - -Since the [examples](https://github.com/iotaledger/iota.rs/tree/develop/bindings/nodejs/examples) are written in -TypeScript, they first need to be compiled to JavaScript, before you can run them. To do this run the following commands -in the [examples folder](https://github.com/iotaledger/iota.rs/tree/develop/bindings/nodejs/examples) : - -```bash -npm i -npm run build -``` - -After you have run this command, you should have a newly create `dist` folder within the `examples` folder with all the -compiled examples. - -### Build a Single Example - -You can also use `tsc exampleName.js` from the `examples` folder to compile a specific example. - -## Run the Examples - -To run any Node.js example, you need to select any of the -[Node.js examples](https://github.com/iotaledger/iota.rs/tree/dev/bindings/nodejs/examples) and run it with your local -Node.js interpreter. The following snippet runs `00_get_info.js` from the project root: - -```bash -node client/bindings/nodejs/examples/dist/00_get_info.js -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/api_ref.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/api_ref.md deleted file mode 100644 index bb21eba31bb..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/api_ref.md +++ /dev/null @@ -1,179 +0,0 @@ -# @iota/client - -## Table of contents - -### Classes - -- [Client](classes/Client.md) -- [MessageHandler](classes/MessageHandler.md) - -### Enumerations - -- [CoinType](enums/CoinType.md) -- [LedgerDeviceType](enums/LedgerDeviceType.md) -- [Network](enums/Network.md) - -### Functions - -- [initLogger](api_ref.md#initlogger) -- [utf8ToBytes](api_ref.md#utf8tobytes) -- [hexToUtf8](api_ref.md#hextoutf8) -- [utf8ToHex](api_ref.md#utf8tohex) - -### Type Aliases - -- [BlockId](api_ref.md#blockid) -- [QueryParameter](api_ref.md#queryparameter) -- [AliasQueryParameter](api_ref.md#aliasqueryparameter) -- [FoundryQueryParameter](api_ref.md#foundryqueryparameter) -- [NftQueryParameter](api_ref.md#nftqueryparameter) -- [SecretManager](api_ref.md#secretmanager) - -### Interfaces - -- [IBuildBlockOptions](interfaces/IBuildBlockOptions.md) -- [IClientBlockBuilderOutputAddress](interfaces/IClientBlockBuilderOutputAddress.md) -- [Burn](interfaces/Burn.md) -- [IClientOptions](interfaces/IClientOptions.md) -- [IDuration](interfaces/IDuration.md) -- [IGenerateAddressesOptions](interfaces/IGenerateAddressesOptions.md) -- [IGenerateAddressOptions](interfaces/IGenerateAddressOptions.md) -- [LedgerNanoStatus](interfaces/LedgerNanoStatus.md) -- [LedgerApp](interfaces/LedgerApp.md) -- [IAuth](interfaces/IAuth.md) -- [IMqttBrokerOptions](interfaces/IMqttBrokerOptions.md) -- [INode](interfaces/INode.md) -- [INetworkInfo](interfaces/INetworkInfo.md) -- [INodeInfoWrapper](interfaces/INodeInfoWrapper.md) -- [IAliasOutputBuilderOptions](interfaces/IAliasOutputBuilderOptions.md) -- [IBasicOutputBuilderOptions](interfaces/IBasicOutputBuilderOptions.md) -- [IFoundryOutputBuilderOptions](interfaces/IFoundryOutputBuilderOptions.md) -- [INftOutputBuilderOptions](interfaces/INftOutputBuilderOptions.md) -- [OutputIdsResponse](interfaces/OutputIdsResponse.md) -- [IPreparedTransactionData](interfaces/IPreparedTransactionData.md) -- [IInputSigningData](interfaces/IInputSigningData.md) -- [IRange](interfaces/IRange.md) -- [LedgerNanoSecretManager](interfaces/LedgerNanoSecretManager.md) -- [MnemonicSecretManager](interfaces/MnemonicSecretManager.md) -- [StrongholdSecretManager](interfaces/StrongholdSecretManager.md) - -## Functions - -### initLogger - -▸ **initLogger**(`config?`): `any` - -Initialize logger, if no arguments are provided a default config will be used. - -#### Parameters - -| Name | Type | Default value | -| :------- | :-------------- | :-------------------- | -| `config` | `ILoggerConfig` | `defaultLoggerConfig` | - -#### Returns - -`any` - ---- - -### utf8ToBytes - -▸ **utf8ToBytes**(`utf8`): `number`[] - -Convert UTF8 string to an array of bytes - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `utf8` | `string` | - -#### Returns - -`number`[] - ---- - -### hexToUtf8 - -▸ **hexToUtf8**(`hex`): `string` - -Convert hex encoded string to UTF8 string - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `hex` | `string` | - -#### Returns - -`string` - ---- - -### utf8ToHex - -▸ **utf8ToHex**(`utf8`): `string` - -Convert UTF8 string to hex encoded string - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `utf8` | `string` | - -#### Returns - -`string` - -## Type Aliases - -### BlockId - -Ƭ **BlockId**: `string` - -A block identifier, the BLAKE2b-256 hash of the block bytes. -See for more information. - ---- - -### QueryParameter - -Ƭ **QueryParameter**: `Address` \| `AliasAddress` \| `HasStorageDepositReturn` \| `StorageDepositReturnAddress` \| `HasTimelock` \| `TimelockedBefore` \| `TimelockedAfter` \| `HasExpiration` \| `ExpiresBefore` \| `ExpiresAfter` \| `ExpirationReturnAddress` \| `Sender` \| `Tag` \| `Issuer` \| `StateController` \| `Governor` \| `CommonQueryParameters` - -Query parameter for filtering output requests - ---- - -### AliasQueryParameter - -Ƭ **AliasQueryParameter**: `StateController` \| `Governor` \| `Issuer` \| `Sender` \| `CommonQueryParameters` - -Query parameters for filtering Alias Outputs - ---- - -### FoundryQueryParameter - -Ƭ **FoundryQueryParameter**: `AliasAddress` \| `CommonQueryParameters` - -Query parameters for filtering Foundry Outputs - ---- - -### NftQueryParameter - -Ƭ **NftQueryParameter**: `Address` \| `AliasAddress` \| `HasStorageDepositReturn` \| `StorageDepositReturnAddress` \| `HasTimelock` \| `TimelockedBefore` \| `TimelockedAfter` \| `HasExpiration` \| `ExpiresBefore` \| `ExpiresAfter` \| `ExpirationReturnAddress` \| `Sender` \| `Tag` \| `CommonQueryParameters` - -Query parameters for filtering Nft Outputs - ---- - -### SecretManager - -Ƭ **SecretManager**: [`LedgerNanoSecretManager`](interfaces/LedgerNanoSecretManager.md) \| [`MnemonicSecretManager`](interfaces/MnemonicSecretManager.md) \| [`StrongholdSecretManager`](interfaces/StrongholdSecretManager.md) - -Supported secret managers diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/classes/Client.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/classes/Client.md deleted file mode 100644 index 8be2e2fc77e..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/classes/Client.md +++ /dev/null @@ -1,1419 +0,0 @@ -# Class: Client - -The Client to interact with nodes. - -## Table of contents - -### Methods - -- [getInfo](Client.md#getinfo) -- [getNetworkInfo](Client.md#getnetworkinfo) -- [basicOutputIds](Client.md#basicoutputids) -- [getOutput](Client.md#getoutput) -- [getOutputs](Client.md#getoutputs) -- [generateMnemonic](Client.md#generatemnemonic) -- [mnemonicToHexSeed](Client.md#mnemonictohexseed) -- [computeAliasId](Client.md#computealiasid) -- [computeNftId](Client.md#computenftid) -- [computeFoundryId](Client.md#computefoundryid) -- [generateAddresses](Client.md#generateaddresses) -- [buildAndPostBlock](Client.md#buildandpostblock) -- [getTips](Client.md#gettips) -- [postBlock](Client.md#postblock) -- [getBlock](Client.md#getblock) -- [getBlockMetadata](Client.md#getblockmetadata) -- [findInputs](Client.md#findinputs) -- [findOutputs](Client.md#findoutputs) -- [getLedgerNanoStatus](Client.md#getledgernanostatus) -- [prepareTransaction](Client.md#preparetransaction) -- [storeMnemonic](Client.md#storemnemonic) -- [signTransaction](Client.md#signtransaction) -- [signatureUnlock](Client.md#signatureunlock) -- [postBlockPayload](Client.md#postblockpayload) -- [parseBech32Address](Client.md#parsebech32address) -- [blockId](Client.md#blockid) -- [getNode](Client.md#getnode) -- [getNetworkId](Client.md#getnetworkid) -- [getBech32Hrp](Client.md#getbech32hrp) -- [getMinPowScore](Client.md#getminpowscore) -- [getTipsInterval](Client.md#gettipsinterval) -- [getTokenSupply](Client.md#gettokensupply) -- [getProtocolParameters](Client.md#getprotocolparameters) -- [getLocalPow](Client.md#getlocalpow) -- [getFallbackToLocalPow](Client.md#getfallbacktolocalpow) -- [getHealth](Client.md#gethealth) -- [getNodeInfo](Client.md#getnodeinfo) -- [getPeers](Client.md#getpeers) -- [postBlockRaw](Client.md#postblockraw) -- [getBlockRaw](Client.md#getblockraw) -- [getMilestoneById](Client.md#getmilestonebyid) -- [getUtxoChangesById](Client.md#getutxochangesbyid) -- [getMilestoneByIndex](Client.md#getmilestonebyindex) -- [getUtxoChangesByIndex](Client.md#getutxochangesbyindex) -- [getReceipts](Client.md#getreceipts) -- [getReceiptsMigratedAt](Client.md#getreceiptsmigratedat) -- [getTreasury](Client.md#gettreasury) -- [getIncludedBlock](Client.md#getincludedblock) -- [getIncludedBlockMetadata](Client.md#getincludedblockmetadata) -- [bech32ToHex](Client.md#bech32tohex) -- [hexToBech32](Client.md#hextobech32) -- [aliasIdToBech32](Client.md#aliasidtobech32) -- [nftIdToBech32](Client.md#nftidtobech32) -- [hexPublicKeyToBech32Address](Client.md#hexpublickeytobech32address) -- [isAddressValid](Client.md#isaddressvalid) -- [aliasOutputIds](Client.md#aliasoutputids) -- [aliasOutputId](Client.md#aliasoutputid) -- [nftOutputIds](Client.md#nftoutputids) -- [nftOutputId](Client.md#nftoutputid) -- [foundryOutputIds](Client.md#foundryoutputids) -- [foundryOutputId](Client.md#foundryoutputid) -- [tryGetOutputs](Client.md#trygetoutputs) -- [findBlocks](Client.md#findblocks) -- [retry](Client.md#retry) -- [retryUntilIncluded](Client.md#retryuntilincluded) -- [consolidateFunds](Client.md#consolidatefunds) -- [reattach](Client.md#reattach) -- [reattachUnchecked](Client.md#reattachunchecked) -- [promote](Client.md#promote) -- [promoteUnchecked](Client.md#promoteunchecked) -- [unhealthyNodes](Client.md#unhealthynodes) -- [buildBasicOutput](Client.md#buildbasicoutput) -- [buildAliasOutput](Client.md#buildaliasoutput) -- [buildFoundryOutput](Client.md#buildfoundryoutput) -- [buildNftOutput](Client.md#buildnftoutput) -- [hashTransactionEssence](Client.md#hashtransactionessence) -- [listen](Client.md#listen) -- [clearListeners](Client.md#clearlisteners) - -## Methods - -### getInfo - -▸ **getInfo**(): `Promise`<[`INodeInfoWrapper`](../interfaces/INodeInfoWrapper.md)\> - -Returns the node information together with the url of the used node - -#### Returns - -`Promise`<[`INodeInfoWrapper`](../interfaces/INodeInfoWrapper.md)\> - -. - ---- - -### getNetworkInfo - -▸ **getNetworkInfo**(): `Promise`<[`INetworkInfo`](../interfaces/INetworkInfo.md)\> - -Gets the network related information such as network_id and min_pow_score - -#### Returns - -`Promise`<[`INetworkInfo`](../interfaces/INetworkInfo.md)\> - ---- - -### basicOutputIds - -▸ **basicOutputIds**(`queryParameters`): `Promise`<[`OutputIdsResponse`](../interfaces/OutputIdsResponse.md)\> - -Fetch basic output IDs based on query parameters - -#### Parameters - -| Name | Type | -| :---------------- | :------------------------------------------------- | -| `queryParameters` | [`QueryParameter`](../api_ref.md#queryparameter)[] | - -#### Returns - -`Promise`<[`OutputIdsResponse`](../interfaces/OutputIdsResponse.md)\> - ---- - -### getOutput - -▸ **getOutput**(`outputId`): `Promise`<`IOutputResponse`\> - -Get output from a known outputID - -#### Parameters - -| Name | Type | -| :--------- | :------- | -| `outputId` | `string` | - -#### Returns - -`Promise`<`IOutputResponse`\> - ---- - -### getOutputs - -▸ **getOutputs**(`outputIds`): `Promise`<`IOutputResponse`[]\> - -Fetch OutputResponse from provided OutputIds (requests are sent in parallel) - -#### Parameters - -| Name | Type | -| :---------- | :--------- | -| `outputIds` | `string`[] | - -#### Returns - -`Promise`<`IOutputResponse`[]\> - ---- - -### generateMnemonic - -▸ **generateMnemonic**(): `Promise`<`string`\> - -Generates a new mnemonic. - -#### Returns - -`Promise`<`string`\> - ---- - -### mnemonicToHexSeed - -▸ **mnemonicToHexSeed**(`mnemonic`): `Promise`<`string`\> - -Returns a hex encoded seed for a mnemonic. - -#### Parameters - -| Name | Type | -| :--------- | :------- | -| `mnemonic` | `string` | - -#### Returns - -`Promise`<`string`\> - ---- - -### computeAliasId - -▸ **computeAliasId**(`outputId`): `Promise`<`string`\> - -Computes the alias id for the given alias output id. - -#### Parameters - -| Name | Type | -| :--------- | :------- | -| `outputId` | `string` | - -#### Returns - -`Promise`<`string`\> - ---- - -### computeNftId - -▸ **computeNftId**(`outputId`): `Promise`<`string`\> - -Computes the NFT id for the given NFT output id. - -#### Parameters - -| Name | Type | -| :--------- | :------- | -| `outputId` | `string` | - -#### Returns - -`Promise`<`string`\> - ---- - -### computeFoundryId - -▸ **computeFoundryId**(`aliasAddress`, `serialNumber`, `tokenSchemeKind`): `Promise`<`string`\> - -Computes the foundry id. - -#### Parameters - -| Name | Type | -| :---------------- | :------- | -| `aliasAddress` | `string` | -| `serialNumber` | `number` | -| `tokenSchemeKind` | `number` | - -#### Returns - -`Promise`<`string`\> - ---- - -### generateAddresses - -▸ **generateAddresses**(`secretManager`, `generateAddressesOptions`): `Promise`<`string`[]\> - -Generate addresses - -#### Parameters - -| Name | Type | -| :------------------------- | :------------------------------------------------------------------------ | -| `secretManager` | [`SecretManager`](../api_ref.md#secretmanager) | -| `generateAddressesOptions` | [`IGenerateAddressesOptions`](../interfaces/IGenerateAddressesOptions.md) | - -#### Returns - -`Promise`<`string`[]\> - ---- - -### buildAndPostBlock - -▸ **buildAndPostBlock**(`secretManager?`, `options?`): `Promise`<[`string`, `IBlock`]\> - -Build and post a block - -#### Parameters - -| Name | Type | -| :--------------- | :---------------------------------------------------------- | -| `secretManager?` | [`SecretManager`](../api_ref.md#secretmanager) | -| `options?` | [`IBuildBlockOptions`](../interfaces/IBuildBlockOptions.md) | - -#### Returns - -`Promise`<[`string`, `IBlock`]\> - ---- - -### getTips - -▸ **getTips**(): `Promise`<`string`[]\> - -Returns tips that are ideal for attaching a block. -The tips can be considered as non-lazy and are therefore ideal for attaching a block. - -#### Returns - -`Promise`<`string`[]\> - ---- - -### postBlock - -▸ **postBlock**(`block`): `Promise`<`string`\> - -Post block in JSON format, returns the block ID. - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `block` | `IBlock` | - -#### Returns - -`Promise`<`string`\> - ---- - -### getBlock - -▸ **getBlock**(`blockId`): `Promise`<`IBlock`\> - -Get block as JSON. - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `blockId` | `string` | - -#### Returns - -`Promise`<`IBlock`\> - ---- - -### getBlockMetadata - -▸ **getBlockMetadata**(`blockId`): `Promise`<`IBlockMetadata`\> - -Get block metadata. - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `blockId` | `string` | - -#### Returns - -`Promise`<`IBlockMetadata`\> - ---- - -### findInputs - -▸ **findInputs**(`addresses`, `amount`): `Promise`<`IUTXOInput`[]\> - -Find inputs from addresses for a provided amount (useful for offline signing) - -#### Parameters - -| Name | Type | -| :---------- | :--------- | -| `addresses` | `string`[] | -| `amount` | `number` | - -#### Returns - -`Promise`<`IUTXOInput`[]\> - ---- - -### findOutputs - -▸ **findOutputs**(`outputIds`, `addresses`): `Promise`<`IOutputResponse`[]\> - -Find all outputs based on the requests criteria. This method will try to query multiple nodes if -the request amount exceeds individual node limit. - -#### Parameters - -| Name | Type | -| :---------- | :--------- | -| `outputIds` | `string`[] | -| `addresses` | `string`[] | - -#### Returns - -`Promise`<`IOutputResponse`[]\> - ---- - -### getLedgerNanoStatus - -▸ **getLedgerNanoStatus**(`isSimulator`): `Promise`<[`LedgerNanoStatus`](../interfaces/LedgerNanoStatus.md)\> - -Get the status of a Ledger Nano - -#### Parameters - -| Name | Type | -| :------------ | :-------- | -| `isSimulator` | `boolean` | - -#### Returns - -`Promise`<[`LedgerNanoStatus`](../interfaces/LedgerNanoStatus.md)\> - ---- - -### prepareTransaction - -▸ **prepareTransaction**(`secretManager?`, `options?`): `Promise`<[`IPreparedTransactionData`](../interfaces/IPreparedTransactionData.md)\> - -Prepare a transaction for signing - -#### Parameters - -| Name | Type | -| :--------------- | :---------------------------------------------------------- | -| `secretManager?` | [`SecretManager`](../api_ref.md#secretmanager) | -| `options?` | [`IBuildBlockOptions`](../interfaces/IBuildBlockOptions.md) | - -#### Returns - -`Promise`<[`IPreparedTransactionData`](../interfaces/IPreparedTransactionData.md)\> - ---- - -### storeMnemonic - -▸ **storeMnemonic**(`secretManager`, `mnemonic`): `Promise`<`void`\> - -Store a mnemonic in the Stronghold vault - -#### Parameters - -| Name | Type | -| :-------------- | :--------------------------------------------- | -| `secretManager` | [`SecretManager`](../api_ref.md#secretmanager) | -| `mnemonic` | `string` | - -#### Returns - -`Promise`<`void`\> - ---- - -### signTransaction - -▸ **signTransaction**(`secretManager`, `preparedTransactionData`): `Promise`<`PayloadTypes`\> - -Sign a transaction - -#### Parameters - -| Name | Type | -| :------------------------ | :---------------------------------------------------------------------- | -| `secretManager` | [`SecretManager`](../api_ref.md#secretmanager) | -| `preparedTransactionData` | [`IPreparedTransactionData`](../interfaces/IPreparedTransactionData.md) | - -#### Returns - -`Promise`<`PayloadTypes`\> - ---- - -### signatureUnlock - -▸ **signatureUnlock**(`secretManager`, `inputSigningData`, `transactionEssenceHash`): `Promise`<`UnlockTypes`\> - -Create a signature unlock using the provided `secretManager`. - -#### Parameters - -| Name | Type | -| :----------------------- | :-------------------------------------------------------- | -| `secretManager` | [`SecretManager`](../api_ref.md#secretmanager) | -| `inputSigningData` | [`IInputSigningData`](../interfaces/IInputSigningData.md) | -| `transactionEssenceHash` | `number`[] | - -#### Returns - -`Promise`<`UnlockTypes`\> - ---- - -### postBlockPayload - -▸ **postBlockPayload**(`payload`): `Promise`<[`string`, `IBlock`]\> - -Submit a payload in a block - -#### Parameters - -| Name | Type | -| :-------- | :------------- | -| `payload` | `PayloadTypes` | - -#### Returns - -`Promise`<[`string`, `IBlock`]\> - ---- - -### parseBech32Address - -▸ **parseBech32Address**(`address`): `Promise`<`AddressTypes`\> - -Returns a valid Address parsed from a String. - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `address` | `string` | - -#### Returns - -`Promise`<`AddressTypes`\> - ---- - -### blockId - -▸ **blockId**(`block`): `Promise`<`string`\> - -Returns a block ID (Blake2b256 hash of the block bytes) - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `block` | `IBlock` | - -#### Returns - -`Promise`<`string`\> - ---- - -### getNode - -▸ **getNode**(): `Promise`<[`INode`](../interfaces/INode.md)\> - -Get a node candidate from the healthy node pool. - -#### Returns - -`Promise`<[`INode`](../interfaces/INode.md)\> - ---- - -### getNetworkId - -▸ **getNetworkId**(): `Promise`<`number`\> - -Get the network id of the node we're connecting to. - -#### Returns - -`Promise`<`number`\> - ---- - -### getBech32Hrp - -▸ **getBech32Hrp**(): `Promise`<`string`\> - -Returns the bech32_hrp. - -#### Returns - -`Promise`<`string`\> - ---- - -### getMinPowScore - -▸ **getMinPowScore**(): `Promise`<`number`\> - -Returns the min PoW score. - -#### Returns - -`Promise`<`number`\> - ---- - -### getTipsInterval - -▸ **getTipsInterval**(): `Promise`<`number`\> - -Returns the tips interval. - -#### Returns - -`Promise`<`number`\> - ---- - -### getTokenSupply - -▸ **getTokenSupply**(): `Promise`<`string`\> - -Returns the token supply. - -#### Returns - -`Promise`<`string`\> - ---- - -### getProtocolParameters - -▸ **getProtocolParameters**(): `Promise`<`INodeInfoProtocol`\> - -Returns the protocol parameters. - -#### Returns - -`Promise`<`INodeInfoProtocol`\> - ---- - -### getLocalPow - -▸ **getLocalPow**(): `Promise`<`boolean`\> - -Returns if local pow should be used or not. - -#### Returns - -`Promise`<`boolean`\> - ---- - -### getFallbackToLocalPow - -▸ **getFallbackToLocalPow**(): `Promise`<`boolean`\> - -Get fallback to local proof of work timeout. - -#### Returns - -`Promise`<`boolean`\> - ---- - -### getHealth - -▸ **getHealth**(`url`): `Promise`<`boolean`\> - -Get health of node by input url. - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `url` | `string` | - -#### Returns - -`Promise`<`boolean`\> - ---- - -### getNodeInfo - -▸ **getNodeInfo**(`url`, `auth?`): `Promise`<`INodeInfo`\> - -Get info of node with input url. - -#### Parameters - -| Name | Type | -| :------ | :-------------------------------- | -| `url` | `string` | -| `auth?` | [`IAuth`](../interfaces/IAuth.md) | - -#### Returns - -`Promise`<`INodeInfo`\> - ---- - -### getPeers - -▸ **getPeers**(): `Promise`<`IPeer`[]\> - -Get peers. - -#### Returns - -`Promise`<`IPeer`[]\> - ---- - -### postBlockRaw - -▸ **postBlockRaw**(`block`): `Promise`<`string`\> - -Post block as raw bytes, returns the block ID. - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `block` | `IBlock` | - -#### Returns - -`Promise`<`string`\> - ---- - -### getBlockRaw - -▸ **getBlockRaw**(`blockId`): `Promise`<`Uint8Array`\> - -Get block as raw bytes. - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `blockId` | `string` | - -#### Returns - -`Promise`<`Uint8Array`\> - ---- - -### getMilestoneById - -▸ **getMilestoneById**(`milestoneId`): `Promise`<`IMilestonePayload`\> - -Look up a milestone by a given milestone index. - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `milestoneId` | `string` | - -#### Returns - -`Promise`<`IMilestonePayload`\> - ---- - -### getUtxoChangesById - -▸ **getUtxoChangesById**(`milestoneId`): `Promise`<`IMilestoneUtxoChangesResponse`\> - -Returns all UTXO changes that happened at a specific milestone. - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `milestoneId` | `string` | - -#### Returns - -`Promise`<`IMilestoneUtxoChangesResponse`\> - ---- - -### getMilestoneByIndex - -▸ **getMilestoneByIndex**(`index`): `Promise`<`IMilestonePayload`\> - -Look up a milestone by a given milestone index. - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `index` | `number` | - -#### Returns - -`Promise`<`IMilestonePayload`\> - ---- - -### getUtxoChangesByIndex - -▸ **getUtxoChangesByIndex**(`index`): `Promise`<`IMilestoneUtxoChangesResponse`\> - -Returns all UTXO changes that happened at a specific milestone. - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `index` | `number` | - -#### Returns - -`Promise`<`IMilestoneUtxoChangesResponse`\> - ---- - -### getReceipts - -▸ **getReceipts**(): `Promise`<`IReceiptsResponse`\> - -Get receipts. - -#### Returns - -`Promise`<`IReceiptsResponse`\> - ---- - -### getReceiptsMigratedAt - -▸ **getReceiptsMigratedAt**(`milestoneIndex`): `Promise`<`IReceiptsResponse`[]\> - -Get the receipts by the given milestone index. - -#### Parameters - -| Name | Type | -| :--------------- | :------- | -| `milestoneIndex` | `number` | - -#### Returns - -`Promise`<`IReceiptsResponse`[]\> - ---- - -### getTreasury - -▸ **getTreasury**(): `Promise`<`ITreasury`\> - -Get the treasury output. - -#### Returns - -`Promise`<`ITreasury`\> - ---- - -### getIncludedBlock - -▸ **getIncludedBlock**(`transactionId`): `Promise`<`IBlock`\> - -Returns the included block of the transaction. - -#### Parameters - -| Name | Type | -| :-------------- | :------- | -| `transactionId` | `string` | - -#### Returns - -`Promise`<`IBlock`\> - ---- - -### getIncludedBlockMetadata - -▸ **getIncludedBlockMetadata**(`transactionId`): `Promise`<`IBlock`\> - -Returns the metadata of the included block of the transaction. - -#### Parameters - -| Name | Type | -| :-------------- | :------- | -| `transactionId` | `string` | - -#### Returns - -`Promise`<`IBlock`\> - ---- - -### bech32ToHex - -▸ **bech32ToHex**(`bech32`): `Promise`<`string`\> - -Transforms bech32 to hex. - -#### Parameters - -| Name | Type | -| :------- | :------- | -| `bech32` | `string` | - -#### Returns - -`Promise`<`string`\> - ---- - -### hexToBech32 - -▸ **hexToBech32**(`hex`, `bech32Hrp?`): `Promise`<`string`\> - -Transforms a hex encoded address to a bech32 encoded address. - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `hex` | `string` | -| `bech32Hrp?` | `string` | - -#### Returns - -`Promise`<`string`\> - ---- - -### aliasIdToBech32 - -▸ **aliasIdToBech32**(`aliasId`, `bech32Hrp?`): `Promise`<`string`\> - -Transforms an alias id to a bech32 encoded address. - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `aliasId` | `string` | -| `bech32Hrp?` | `string` | - -#### Returns - -`Promise`<`string`\> - ---- - -### nftIdToBech32 - -▸ **nftIdToBech32**(`nftId`, `bech32Hrp?`): `Promise`<`string`\> - -Transforms an nft id to a bech32 encoded address. - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `nftId` | `string` | -| `bech32Hrp?` | `string` | - -#### Returns - -`Promise`<`string`\> - ---- - -### hexPublicKeyToBech32Address - -▸ **hexPublicKeyToBech32Address**(`hex`, `bech32Hrp?`): `Promise`<`string`\> - -Transforms a hex encoded public key to a bech32 encoded address. - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `hex` | `string` | -| `bech32Hrp?` | `string` | - -#### Returns - -`Promise`<`string`\> - ---- - -### isAddressValid - -▸ **isAddressValid**(`address`): `Promise`<`boolean`\> - -Checks if a String is a valid bech32 encoded address. - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - ---- - -### aliasOutputIds - -▸ **aliasOutputIds**(`queryParameters`): `Promise`<[`OutputIdsResponse`](../interfaces/OutputIdsResponse.md)\> - -Fetch alias output IDs - -#### Parameters - -| Name | Type | -| :---------------- | :----------------------------------------------------------- | -| `queryParameters` | [`AliasQueryParameter`](../api_ref.md#aliasqueryparameter)[] | - -#### Returns - -`Promise`<[`OutputIdsResponse`](../interfaces/OutputIdsResponse.md)\> - ---- - -### aliasOutputId - -▸ **aliasOutputId**(`aliasId`): `Promise`<`string`\> - -Fetch alias output ID - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `aliasId` | `string` | - -#### Returns - -`Promise`<`string`\> - ---- - -### nftOutputIds - -▸ **nftOutputIds**(`queryParameters`): `Promise`<[`OutputIdsResponse`](../interfaces/OutputIdsResponse.md)\> - -Fetch NFT output IDs - -#### Parameters - -| Name | Type | -| :---------------- | :------------------------------------------------------- | -| `queryParameters` | [`NftQueryParameter`](../api_ref.md#nftqueryparameter)[] | - -#### Returns - -`Promise`<[`OutputIdsResponse`](../interfaces/OutputIdsResponse.md)\> - ---- - -### nftOutputId - -▸ **nftOutputId**(`nftId`): `Promise`<`string`\> - -Fetch NFT output ID - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `nftId` | `string` | - -#### Returns - -`Promise`<`string`\> - ---- - -### foundryOutputIds - -▸ **foundryOutputIds**(`queryParameters`): `Promise`<[`OutputIdsResponse`](../interfaces/OutputIdsResponse.md)\> - -Fetch Foundry Output IDs - -#### Parameters - -| Name | Type | -| :---------------- | :--------------------------------------------------------------- | -| `queryParameters` | [`FoundryQueryParameter`](../api_ref.md#foundryqueryparameter)[] | - -#### Returns - -`Promise`<[`OutputIdsResponse`](../interfaces/OutputIdsResponse.md)\> - ---- - -### foundryOutputId - -▸ **foundryOutputId**(`foundryId`): `Promise`<`string`\> - -Fetch Foundry Output ID - -#### Parameters - -| Name | Type | -| :---------- | :------- | -| `foundryId` | `string` | - -#### Returns - -`Promise`<`string`\> - ---- - -### tryGetOutputs - -▸ **tryGetOutputs**(`outputIds`): `Promise`<`IOutputResponse`[]\> - -Try to get OutputResponse from provided OutputIds (requests are sent -in parallel and errors are ignored, can be useful for spent outputs) - -#### Parameters - -| Name | Type | -| :---------- | :--------- | -| `outputIds` | `string`[] | - -#### Returns - -`Promise`<`IOutputResponse`[]\> - ---- - -### findBlocks - -▸ **findBlocks**(`blockIds`): `Promise`<`IBlock`[]\> - -Find all blocks by provided block IDs. - -#### Parameters - -| Name | Type | -| :--------- | :--------- | -| `blockIds` | `string`[] | - -#### Returns - -`Promise`<`IBlock`[]\> - ---- - -### retry - -▸ **retry**(`blockId`): `Promise`<[`string`, `IBlock`]\> - -Retries (promotes or reattaches) a block for provided block id. Block should be -retried only if they are valid and haven't been confirmed for a while. - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `blockId` | `string` | - -#### Returns - -`Promise`<[`string`, `IBlock`]\> - ---- - -### retryUntilIncluded - -▸ **retryUntilIncluded**(`blockId`, `interval?`, `maxAttempts?`): `Promise`<[`string`, `IBlock`][]\> - -Retries (promotes or reattaches) a block for provided block id until it's included (referenced by a -milestone). Default interval is 5 seconds and max attempts is 40. Returns the included block at first -position and additional reattached blocks - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `blockId` | `string` | -| `interval?` | `number` | -| `maxAttempts?` | `number` | - -#### Returns - -`Promise`<[`string`, `IBlock`][]\> - ---- - -### consolidateFunds - -▸ **consolidateFunds**(`secretManager`, `generateAddressesOptions`): `Promise`<`string`\> - -Function to consolidate all funds from a range of addresses to the address with the lowest index in that range -Returns the address to which the funds got consolidated, if any were available - -#### Parameters - -| Name | Type | -| :------------------------- | :------------------------------------------------------------------------ | -| `secretManager` | [`SecretManager`](../api_ref.md#secretmanager) | -| `generateAddressesOptions` | [`IGenerateAddressesOptions`](../interfaces/IGenerateAddressesOptions.md) | - -#### Returns - -`Promise`<`string`\> - ---- - -### reattach - -▸ **reattach**(`blockId`): `Promise`<[`string`, `IBlock`]\> - -Reattaches blocks for provided block id. Blocks can be reattached only if they are valid and haven't been -confirmed for a while. - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `blockId` | `string` | - -#### Returns - -`Promise`<[`string`, `IBlock`]\> - ---- - -### reattachUnchecked - -▸ **reattachUnchecked**(`blockId`): `Promise`<[`string`, `IBlock`]\> - -Reattach a block without checking if it should be reattached - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `blockId` | `string` | - -#### Returns - -`Promise`<[`string`, `IBlock`]\> - ---- - -### promote - -▸ **promote**(`blockId`): `Promise`<[`string`, `IBlock`]\> - -Promotes a block. The method should validate if a promotion is necessary through get_block. If not, the -method should error out and should not allow unnecessary promotions. - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `blockId` | `string` | - -#### Returns - -`Promise`<[`string`, `IBlock`]\> - ---- - -### promoteUnchecked - -▸ **promoteUnchecked**(`blockId`): `Promise`<[`string`, `IBlock`]\> - -Promote a block without checking if it should be promoted - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `blockId` | `string` | - -#### Returns - -`Promise`<[`string`, `IBlock`]\> - ---- - -### unhealthyNodes - -▸ **unhealthyNodes**(): `Promise`<`Set`<[`INode`](../interfaces/INode.md)\>\> - -Returns the unhealthy nodes. - -#### Returns - -`Promise`<`Set`<[`INode`](../interfaces/INode.md)\>\> - ---- - -### buildBasicOutput - -▸ **buildBasicOutput**(`options`): `Promise`<`IBasicOutput`\> - -Build a Basic Output. - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------- | -| `options` | [`IBasicOutputBuilderOptions`](../interfaces/IBasicOutputBuilderOptions.md) | - -#### Returns - -`Promise`<`IBasicOutput`\> - ---- - -### buildAliasOutput - -▸ **buildAliasOutput**(`options`): `Promise`<`IAliasOutput`\> - -Build an Alias Output. - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------- | -| `options` | [`IAliasOutputBuilderOptions`](../interfaces/IAliasOutputBuilderOptions.md) | - -#### Returns - -`Promise`<`IAliasOutput`\> - ---- - -### buildFoundryOutput - -▸ **buildFoundryOutput**(`options`): `Promise`<`IFoundryOutput`\> - -Build a Foundry Output. - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------ | -| `options` | [`IFoundryOutputBuilderOptions`](../interfaces/IFoundryOutputBuilderOptions.md) | - -#### Returns - -`Promise`<`IFoundryOutput`\> - ---- - -### buildNftOutput - -▸ **buildNftOutput**(`options`): `Promise`<`INftOutput`\> - -Build an Nft Output. - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------- | -| `options` | [`INftOutputBuilderOptions`](../interfaces/INftOutputBuilderOptions.md) | - -#### Returns - -`Promise`<`INftOutput`\> - ---- - -### hashTransactionEssence - -▸ **hashTransactionEssence**(`essence`): `Promise`<`string`\> - -Compute the hash of a transaction essence. - -#### Parameters - -| Name | Type | -| :-------- | :-------------------- | -| `essence` | `ITransactionEssence` | - -#### Returns - -`Promise`<`string`\> - ---- - -### listen - -▸ **listen**(`topics`, `callback`): `Promise`<`void`\> - -Listen to MQTT topics. - -#### Parameters - -| Name | Type | -| :--------- | :----------------------------------------------- | -| `topics` | `string`[] | -| `callback` | (`error`: `Error`, `result`: `string`) => `void` | - -#### Returns - -`Promise`<`void`\> - ---- - -### clearListeners - -▸ **clearListeners**(`topics`): `Promise`<`void`\> - -Stop listening for provided MQTT topics. - -#### Parameters - -| Name | Type | -| :------- | :--------- | -| `topics` | `string`[] | - -#### Returns - -`Promise`<`void`\> diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/classes/MessageHandler.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/classes/MessageHandler.md deleted file mode 100644 index cb36aaaa2c5..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/classes/MessageHandler.md +++ /dev/null @@ -1,3 +0,0 @@ -# Class: MessageHandler - -The MessageHandler which sends the commands to the Rust side. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/enums/CoinType.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/enums/CoinType.md deleted file mode 100644 index 4a9587ed0c4..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/enums/CoinType.md +++ /dev/null @@ -1,22 +0,0 @@ -# Enumeration: CoinType - -BIP44 Coin Types for IOTA and Shimmer. - -## Table of contents - -### Enumeration Members - -- [IOTA](CoinType.md#iota) -- [Shimmer](CoinType.md#shimmer) - -## Enumeration Members - -### IOTA - -• **IOTA** = `4218` - ---- - -### Shimmer - -• **Shimmer** = `4219` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/enums/LedgerDeviceType.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/enums/LedgerDeviceType.md deleted file mode 100644 index 2501a99809e..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/enums/LedgerDeviceType.md +++ /dev/null @@ -1,29 +0,0 @@ -# Enumeration: LedgerDeviceType - -The Ledger Device Type - -## Table of contents - -### Enumeration Members - -- [LedgerNanoS](LedgerDeviceType.md#ledgernanos) -- [LedgerNanoX](LedgerDeviceType.md#ledgernanox) -- [LedgerNanoSPlus](LedgerDeviceType.md#ledgernanosplus) - -## Enumeration Members - -### LedgerNanoS - -• **LedgerNanoS** = `"ledgerNanoS"` - ---- - -### LedgerNanoX - -• **LedgerNanoX** = `"ledgerNanoX"` - ---- - -### LedgerNanoSPlus - -• **LedgerNanoSPlus** = `"ledgerNanoSPlus"` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/enums/Network.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/enums/Network.md deleted file mode 100644 index 9929d49c3d1..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/enums/Network.md +++ /dev/null @@ -1,22 +0,0 @@ -# Enumeration: Network - -Network types. - -## Table of contents - -### Enumeration Members - -- [Mainnet](Network.md#mainnet) -- [Testnet](Network.md#testnet) - -## Enumeration Members - -### Mainnet - -• **Mainnet** = `0` - ---- - -### Testnet - -• **Testnet** = `1` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/Burn.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/Burn.md deleted file mode 100644 index 01601f7786b..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/Burn.md +++ /dev/null @@ -1,44 +0,0 @@ -# Interface: Burn - -A DTO for [`Burn`] - -## Table of contents - -### Properties - -- [aliases](Burn.md#aliases) -- [nfts](Burn.md#nfts) -- [foundries](Burn.md#foundries) -- [nativeTokens](Burn.md#nativetokens) - -## Properties - -### aliases - -• `Optional` **aliases**: `string`[] - -Aliases to burn - ---- - -### nfts - -• `Optional` **nfts**: `string`[] - -NFTs to burn - ---- - -### foundries - -• `Optional` **foundries**: `string`[] - -Foundries to burn - ---- - -### nativeTokens - -• `Optional` **nativeTokens**: `INativeToken`[] - -Amounts of native tokens to burn diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IAliasOutputBuilderOptions.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IAliasOutputBuilderOptions.md deleted file mode 100644 index e123e9dd723..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IAliasOutputBuilderOptions.md +++ /dev/null @@ -1,66 +0,0 @@ -# Interface: IAliasOutputBuilderOptions - -Options for building an Alias Output - -## Hierarchy - -- [`IBasicOutputBuilderOptions`](IBasicOutputBuilderOptions.md) - - ↳ **`IAliasOutputBuilderOptions`** - -## Table of contents - -### Properties - -- [amount](IAliasOutputBuilderOptions.md#amount) -- [nativeTokens](IAliasOutputBuilderOptions.md#nativetokens) -- [unlockConditions](IAliasOutputBuilderOptions.md#unlockconditions) -- [features](IAliasOutputBuilderOptions.md#features) - -## Properties - -### amount - -• `Optional` **amount**: `string` - -If not provided, minimum storage deposit will be used - -#### Inherited from - -[IBasicOutputBuilderOptions](IBasicOutputBuilderOptions.md).[amount](IBasicOutputBuilderOptions.md#amount) - ---- - -### nativeTokens - -• `Optional` **nativeTokens**: `INativeToken`[] - -The native tokens to be held by the output. - -#### Inherited from - -[IBasicOutputBuilderOptions](IBasicOutputBuilderOptions.md).[nativeTokens](IBasicOutputBuilderOptions.md#nativetokens) - ---- - -### unlockConditions - -• **unlockConditions**: `UnlockConditionTypes`[] - -The unlock conditions for the output. - -#### Inherited from - -[IBasicOutputBuilderOptions](IBasicOutputBuilderOptions.md).[unlockConditions](IBasicOutputBuilderOptions.md#unlockconditions) - ---- - -### features - -• `Optional` **features**: `FeatureTypes`[] - -Features to be contained by the output. - -#### Inherited from - -[IBasicOutputBuilderOptions](IBasicOutputBuilderOptions.md).[features](IBasicOutputBuilderOptions.md#features) diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IAuth.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IAuth.md deleted file mode 100644 index 5b07d5f14d0..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IAuth.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: IAuth - -Basic Auth or JWT. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IBasicOutputBuilderOptions.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IBasicOutputBuilderOptions.md deleted file mode 100644 index e16c83a2af1..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IBasicOutputBuilderOptions.md +++ /dev/null @@ -1,54 +0,0 @@ -# Interface: IBasicOutputBuilderOptions - -Options for building a Basic Output - -## Hierarchy - -- **`IBasicOutputBuilderOptions`** - - ↳ [`IAliasOutputBuilderOptions`](IAliasOutputBuilderOptions.md) - - ↳ [`IFoundryOutputBuilderOptions`](IFoundryOutputBuilderOptions.md) - - ↳ [`INftOutputBuilderOptions`](INftOutputBuilderOptions.md) - -## Table of contents - -### Properties - -- [amount](IBasicOutputBuilderOptions.md#amount) -- [nativeTokens](IBasicOutputBuilderOptions.md#nativetokens) -- [unlockConditions](IBasicOutputBuilderOptions.md#unlockconditions) -- [features](IBasicOutputBuilderOptions.md#features) - -## Properties - -### amount - -• `Optional` **amount**: `string` - -If not provided, minimum storage deposit will be used - ---- - -### nativeTokens - -• `Optional` **nativeTokens**: `INativeToken`[] - -The native tokens to be held by the output. - ---- - -### unlockConditions - -• **unlockConditions**: `UnlockConditionTypes`[] - -The unlock conditions for the output. - ---- - -### features - -• `Optional` **features**: `FeatureTypes`[] - -Features to be contained by the output. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IBuildBlockOptions.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IBuildBlockOptions.md deleted file mode 100644 index 3a1133145c7..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IBuildBlockOptions.md +++ /dev/null @@ -1,44 +0,0 @@ -# Interface: IBuildBlockOptions - -Options to build a new block, possibly with payloads - -## Table of contents - -### Properties - -- [output](IBuildBlockOptions.md#output) -- [outputHex](IBuildBlockOptions.md#outputhex) -- [parents](IBuildBlockOptions.md#parents) -- [burn](IBuildBlockOptions.md#burn) - -## Properties - -### output - -• `Optional` **output**: [`IClientBlockBuilderOutputAddress`](IClientBlockBuilderOutputAddress.md) - -Bech32 encoded output address and amount - ---- - -### outputHex - -• `Optional` **outputHex**: [`IClientBlockBuilderOutputAddress`](IClientBlockBuilderOutputAddress.md) - -Hex encoded output address and amount - ---- - -### parents - -• `Optional` **parents**: `string`[] - -Parent block IDs - ---- - -### burn - -• `Optional` **burn**: [`Burn`](Burn.md) - -Explicit burning of aliases, nfts, foundries and native tokens diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IClientBlockBuilderOutputAddress.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IClientBlockBuilderOutputAddress.md deleted file mode 100644 index 03304e4b96c..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IClientBlockBuilderOutputAddress.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: IClientBlockBuilderOutputAddress - -Address with base coin amount diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IClientOptions.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IClientOptions.md deleted file mode 100644 index 8039fcf0926..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IClientOptions.md +++ /dev/null @@ -1,126 +0,0 @@ -# Interface: IClientOptions - -Options for the client builder - -## Table of contents - -### Properties - -- [primaryNode](IClientOptions.md#primarynode) -- [primaryPowNode](IClientOptions.md#primarypownode) -- [ignoreNodeHealth](IClientOptions.md#ignorenodehealth) -- [nodeSyncInterval](IClientOptions.md#nodesyncinterval) -- [quorum](IClientOptions.md#quorum) -- [minQuorumSize](IClientOptions.md#minquorumsize) -- [quorumThreshold](IClientOptions.md#quorumthreshold) -- [networkInfo](IClientOptions.md#networkinfo) -- [brokerOptions](IClientOptions.md#brokeroptions) -- [apiTimeout](IClientOptions.md#apitimeout) -- [remotePowTimeout](IClientOptions.md#remotepowtimeout) -- [powWorkerCount](IClientOptions.md#powworkercount) -- [localPow](IClientOptions.md#localpow) - -## Properties - -### primaryNode - -• `Optional` **primaryNode**: `string` \| [`INode`](INode.md) - -Node which will be tried first for all requests - ---- - -### primaryPowNode - -• `Optional` **primaryPowNode**: `string` \| [`INode`](INode.md) - -Node which will be tried first when using remote PoW, even before the primary_node - ---- - -### ignoreNodeHealth - -• `Optional` **ignoreNodeHealth**: `boolean` - -If the node health status should be ignored - ---- - -### nodeSyncInterval - -• `Optional` **nodeSyncInterval**: [`IDuration`](IDuration.md) - -Interval in which nodes will be checked for their sync status and the NetworkInfo gets updated - ---- - -### quorum - -• `Optional` **quorum**: `boolean` - -If node quorum is enabled. Will compare the responses from multiple nodes and only returns the -response if quorum_threshold of the nodes return the same one - ---- - -### minQuorumSize - -• `Optional` **minQuorumSize**: `number` - -Minimum amount of nodes required for request when quorum is enabled - ---- - -### quorumThreshold - -• `Optional` **quorumThreshold**: `number` - -% of nodes that have to return the same response so it gets accepted - ---- - -### networkInfo - -• `Optional` **networkInfo**: [`INetworkInfo`](INetworkInfo.md) - -Data related to the used network - ---- - -### brokerOptions - -• `Optional` **brokerOptions**: [`IMqttBrokerOptions`](IMqttBrokerOptions.md) - -Options for the MQTT broker - ---- - -### apiTimeout - -• `Optional` **apiTimeout**: [`IDuration`](IDuration.md) - -Timeout for API requests - ---- - -### remotePowTimeout - -• `Optional` **remotePowTimeout**: [`IDuration`](IDuration.md) - -Timeout when sending a block that requires remote proof of work - ---- - -### powWorkerCount - -• `Optional` **powWorkerCount**: `number` - -The amount of threads to be used for proof of work - ---- - -### localPow - -• `Optional` **localPow**: `boolean` - -Whether the PoW should be done locally or remotely. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IDuration.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IDuration.md deleted file mode 100644 index 7a086f2d5c8..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IDuration.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: IDuration - -Time duration diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IFoundryOutputBuilderOptions.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IFoundryOutputBuilderOptions.md deleted file mode 100644 index 1c0e5ffec6e..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IFoundryOutputBuilderOptions.md +++ /dev/null @@ -1,75 +0,0 @@ -# Interface: IFoundryOutputBuilderOptions - -Options for building a Foundry Output - -## Hierarchy - -- [`IBasicOutputBuilderOptions`](IBasicOutputBuilderOptions.md) - - ↳ **`IFoundryOutputBuilderOptions`** - -## Table of contents - -### Properties - -- [amount](IFoundryOutputBuilderOptions.md#amount) -- [nativeTokens](IFoundryOutputBuilderOptions.md#nativetokens) -- [unlockConditions](IFoundryOutputBuilderOptions.md#unlockconditions) -- [features](IFoundryOutputBuilderOptions.md#features) -- [serialNumber](IFoundryOutputBuilderOptions.md#serialnumber) - -## Properties - -### amount - -• `Optional` **amount**: `string` - -If not provided, minimum storage deposit will be used - -#### Inherited from - -[IBasicOutputBuilderOptions](IBasicOutputBuilderOptions.md).[amount](IBasicOutputBuilderOptions.md#amount) - ---- - -### nativeTokens - -• `Optional` **nativeTokens**: `INativeToken`[] - -The native tokens to be held by the output. - -#### Inherited from - -[IBasicOutputBuilderOptions](IBasicOutputBuilderOptions.md).[nativeTokens](IBasicOutputBuilderOptions.md#nativetokens) - ---- - -### unlockConditions - -• **unlockConditions**: `UnlockConditionTypes`[] - -The unlock conditions for the output. - -#### Inherited from - -[IBasicOutputBuilderOptions](IBasicOutputBuilderOptions.md).[unlockConditions](IBasicOutputBuilderOptions.md#unlockconditions) - ---- - -### features - -• `Optional` **features**: `FeatureTypes`[] - -Features to be contained by the output. - -#### Inherited from - -[IBasicOutputBuilderOptions](IBasicOutputBuilderOptions.md).[features](IBasicOutputBuilderOptions.md#features) - ---- - -### serialNumber - -• **serialNumber**: `number` - -The serial number of the foundry with respect to the controlling alias. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IGenerateAddressOptions.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IGenerateAddressOptions.md deleted file mode 100644 index c8c88dd67b9..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IGenerateAddressOptions.md +++ /dev/null @@ -1,17 +0,0 @@ -# Interface: IGenerateAddressOptions - -Options provided to Generate Address - -## Table of contents - -### Properties - -- [ledgerNanoPrompt](IGenerateAddressOptions.md#ledgernanoprompt) - -## Properties - -### ledgerNanoPrompt - -• **ledgerNanoPrompt**: `boolean` - -Display the address on ledger devices. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IGenerateAddressesOptions.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IGenerateAddressesOptions.md deleted file mode 100644 index 37332218cbe..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IGenerateAddressesOptions.md +++ /dev/null @@ -1,26 +0,0 @@ -# Interface: IGenerateAddressesOptions - -Input options for GenerateAddresses - -## Table of contents - -### Properties - -- [internal](IGenerateAddressesOptions.md#internal) -- [bech32Hrp](IGenerateAddressesOptions.md#bech32hrp) - -## Properties - -### internal - -• `Optional` **internal**: `boolean` - -Internal addresses - ---- - -### bech32Hrp - -• `Optional` **bech32Hrp**: `string` - -Bech32 human readable part diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IInputSigningData.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IInputSigningData.md deleted file mode 100644 index 2d3b850e0db..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IInputSigningData.md +++ /dev/null @@ -1,35 +0,0 @@ -# Interface: IInputSigningData - -Data for transaction inputs for signing and ordering of unlock blocks - -## Table of contents - -### Properties - -- [output](IInputSigningData.md#output) -- [outputMetadata](IInputSigningData.md#outputmetadata) -- [chain](IInputSigningData.md#chain) - -## Properties - -### output - -• **output**: `OutputTypes` - -The output - ---- - -### outputMetadata - -• **outputMetadata**: `IOutputMetadataResponse` - -The output metadata - ---- - -### chain - -• `Optional` **chain**: `ISegment`[] - -The chain derived from seed, only for ed25519 addresses diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IMqttBrokerOptions.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IMqttBrokerOptions.md deleted file mode 100644 index db292c7b346..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IMqttBrokerOptions.md +++ /dev/null @@ -1,17 +0,0 @@ -# Interface: IMqttBrokerOptions - -Options for the MQTT broker. - -## Table of contents - -### Properties - -- [timeout](IMqttBrokerOptions.md#timeout) - -## Properties - -### timeout - -• `Optional` **timeout**: `number` - -timeout in seconds diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/INetworkInfo.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/INetworkInfo.md deleted file mode 100644 index 304087f2939..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/INetworkInfo.md +++ /dev/null @@ -1,53 +0,0 @@ -# Interface: INetworkInfo - -Struct containing network and PoW related information - -## Table of contents - -### Properties - -- [protocolParameters](INetworkInfo.md#protocolparameters) -- [minPowScore](INetworkInfo.md#minpowscore) -- [localPow](INetworkInfo.md#localpow) -- [fallbackToLocalPow](INetworkInfo.md#fallbacktolocalpow) -- [tipsInterval](INetworkInfo.md#tipsinterval) - -## Properties - -### protocolParameters - -• **protocolParameters**: `INodeInfoProtocol` - -Protocol parameters - ---- - -### minPowScore - -• **minPowScore**: `number` - -Minimum proof of work score - ---- - -### localPow - -• **localPow**: `boolean` - -Local proof of work - ---- - -### fallbackToLocalPow - -• **fallbackToLocalPow**: `boolean` - -Fallback to local proof of work if the node doesn't support remote Pow - ---- - -### tipsInterval - -• **tipsInterval**: `number` - -Tips request interval during PoW in seconds diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/INftOutputBuilderOptions.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/INftOutputBuilderOptions.md deleted file mode 100644 index 86f648af8de..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/INftOutputBuilderOptions.md +++ /dev/null @@ -1,66 +0,0 @@ -# Interface: INftOutputBuilderOptions - -Options for building an Nft Output - -## Hierarchy - -- [`IBasicOutputBuilderOptions`](IBasicOutputBuilderOptions.md) - - ↳ **`INftOutputBuilderOptions`** - -## Table of contents - -### Properties - -- [amount](INftOutputBuilderOptions.md#amount) -- [nativeTokens](INftOutputBuilderOptions.md#nativetokens) -- [unlockConditions](INftOutputBuilderOptions.md#unlockconditions) -- [features](INftOutputBuilderOptions.md#features) - -## Properties - -### amount - -• `Optional` **amount**: `string` - -If not provided, minimum storage deposit will be used - -#### Inherited from - -[IBasicOutputBuilderOptions](IBasicOutputBuilderOptions.md).[amount](IBasicOutputBuilderOptions.md#amount) - ---- - -### nativeTokens - -• `Optional` **nativeTokens**: `INativeToken`[] - -The native tokens to be held by the output. - -#### Inherited from - -[IBasicOutputBuilderOptions](IBasicOutputBuilderOptions.md).[nativeTokens](IBasicOutputBuilderOptions.md#nativetokens) - ---- - -### unlockConditions - -• **unlockConditions**: `UnlockConditionTypes`[] - -The unlock conditions for the output. - -#### Inherited from - -[IBasicOutputBuilderOptions](IBasicOutputBuilderOptions.md).[unlockConditions](IBasicOutputBuilderOptions.md#unlockconditions) - ---- - -### features - -• `Optional` **features**: `FeatureTypes`[] - -Features to be contained by the output. - -#### Inherited from - -[IBasicOutputBuilderOptions](IBasicOutputBuilderOptions.md).[features](IBasicOutputBuilderOptions.md#features) diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/INode.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/INode.md deleted file mode 100644 index 8e124034c0c..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/INode.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: INode - -A node object for the client. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/INodeInfoWrapper.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/INodeInfoWrapper.md deleted file mode 100644 index de8d2e3ba7a..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/INodeInfoWrapper.md +++ /dev/null @@ -1,26 +0,0 @@ -# Interface: INodeInfoWrapper - -NodeInfo wrapper which contains the node info and the url from the node (useful when multiple nodes are used) - -## Table of contents - -### Properties - -- [nodeInfo](INodeInfoWrapper.md#nodeinfo) -- [url](INodeInfoWrapper.md#url) - -## Properties - -### nodeInfo - -• **nodeInfo**: `INodeInfo` - -The node info - ---- - -### url - -• **url**: `string` - -The url of the node diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IPreparedTransactionData.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IPreparedTransactionData.md deleted file mode 100644 index 5ec44352d5f..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IPreparedTransactionData.md +++ /dev/null @@ -1,35 +0,0 @@ -# Interface: IPreparedTransactionData - -Helper struct for offline signing - -## Table of contents - -### Properties - -- [essence](IPreparedTransactionData.md#essence) -- [inputsData](IPreparedTransactionData.md#inputsdata) -- [remainder](IPreparedTransactionData.md#remainder) - -## Properties - -### essence - -• **essence**: `ITransactionEssence` - -Transaction essence - ---- - -### inputsData - -• **inputsData**: [`IInputSigningData`](IInputSigningData.md)[] - -Required address information for signing - ---- - -### remainder - -• `Optional` **remainder**: `IRemainder` - -Optional remainder output information diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IRange.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IRange.md deleted file mode 100644 index 5564901414a..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/IRange.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: IRange - -A range with start and end values. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/LedgerApp.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/LedgerApp.md deleted file mode 100644 index 047b35ab872..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/LedgerApp.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: LedgerApp - -The current opened app diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/LedgerNanoSecretManager.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/LedgerNanoSecretManager.md deleted file mode 100644 index f1d89c496a4..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/LedgerNanoSecretManager.md +++ /dev/null @@ -1,17 +0,0 @@ -# Interface: LedgerNanoSecretManager - -Secret manager that uses a Ledger Nano hardware wallet or Speculos simulator. - -## Table of contents - -### Properties - -- [ledgerNano](LedgerNanoSecretManager.md#ledgernano) - -## Properties - -### ledgerNano - -• **ledgerNano**: `boolean` - -boolean indicates whether it's a simulator or not. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/LedgerNanoStatus.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/LedgerNanoStatus.md deleted file mode 100644 index 2db2b7b002b..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/LedgerNanoStatus.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: LedgerNanoStatus - -The status of a Ledger Nano diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/MnemonicSecretManager.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/MnemonicSecretManager.md deleted file mode 100644 index ca968f3e148..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/MnemonicSecretManager.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: MnemonicSecretManager - -Secret manager that uses a mnemonic in plain memory. It's not recommended for production use. Use LedgerNano or Stronghold instead.. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/OutputIdsResponse.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/OutputIdsResponse.md deleted file mode 100644 index cd9a11c9372..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/OutputIdsResponse.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: OutputIdsResponse - -OutputIdsResponse. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/StrongholdSecretManager.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/StrongholdSecretManager.md deleted file mode 100644 index d3e361b1b0c..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/nodejs/references/interfaces/StrongholdSecretManager.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: StrongholdSecretManager - -Secret manager that uses Stronghold. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/overview.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/overview.md deleted file mode 100644 index 7242827ccf6..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/overview.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -description: There are Node.js, Python and Java bindings for the iota.rs client Rust library. -image: /img/logo/iota_mark_light.png -keywords: - - Rust - - Node.js - - Java - - Python - - bindings ---- - -# IOTA Client libraries - -Choose your programming language: - -- [Rust](../getting_started/rust.mdx) -- [Node.js](../getting_started/nodejs.mdx) -- [Java](../getting_started/java.mdx) -- [Python](../getting_started/python.mdx) - -## Connect to the Testnet API - -We recommended that you start your interactions with Shimmer on a _testnet_ network. The _testnet_ will allow you to safely -get acquainted with the library, without the risk of losing any funds if you make a mistake along the way. -You can use this Shimmer Testnet API load balancer: - -```plaintext -https://api.testnet.shimmer.network -``` - -## Explore the Network - -You can use the [Shimmer Tangle Explorer](https://explorer.shimmer.network/testnet) to view transactions and data stored in the Tangle. - -## Get Test Tokens - -If you plan on managing funds in your application, take a look at -our [wallet.rs library](/wallet.rs/welcome) instead. - -In any case, to properly test value-based transactions on testnet network, you are going to need some tokens. You can get some testnet tokens through the [Shimmer Faucet](https://faucet.testnet.shimmer.network). diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/api_reference.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/api_reference.md deleted file mode 100644 index b0f5827d82f..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/api_reference.md +++ /dev/null @@ -1,925 +0,0 @@ - - -# iota_client - - - -# iota_client.\_utils - - - -## Utils Objects - -```python -class Utils(BaseAPI) -``` - - - -#### bech32_to_hex - -```python -def bech32_to_hex(bech32) -``` - -Transforms bech32 to hex. - - - -#### hex_to_bech32 - -```python -def hex_to_bech32(hex, bech32_hrp) -``` - -Transforms a hex encoded address to a bech32 encoded address. - - - -#### alias_id_to_bech32 - -```python -def alias_id_to_bech32(alias_id, bech32_hrp) -``` - -Transforms an alias id to a bech32 encoded address. - - - -#### nft_id_to_bech32 - -```python -def nft_id_to_bech32(nft_id, bech32_hrp) -``` - -Transforms an nft id to a bech32 encoded address. - - - -#### hex_public_key_to_bech32_address - -```python -def hex_public_key_to_bech32_address(hex, bech32_hrp=None) -``` - -Transforms a hex encoded public key to a bech32 encoded address. - - - -#### parse_bech32_address - -```python -def parse_bech32_address(address) -``` - -Returns a valid Address parsed from a String. - - - -#### is_address_valid - -```python -def is_address_valid(address) -``` - -Checks if a String is a valid bech32 encoded address. - - - -#### generate_mnemonic - -```python -def generate_mnemonic() -``` - -Generates a new mnemonic. - - - -#### mnemonic_to_hex_seed - -```python -def mnemonic_to_hex_seed(mnemonic) -``` - -Returns a hex encoded seed for a mnemonic. - - - -#### compute_alias_id - -```python -def compute_alias_id(output_id) -``` - -Computes the alias id for the given alias output id. - - - -#### compute_nft_id - -```python -def compute_nft_id(output_id) -``` - -Computes the NFT id for the given NFT output id. - - - -#### compute_foundry_id - -```python -def compute_foundry_id(alias_address, serial_number, token_scheme_kind) -``` - -Computes the foundry id. - - - -#### block_id - -```python -def block_id(block) -``` - -Returns a block ID (Blake2b256 hash of block bytes) from a block. - - - -# iota_client.secret_manager - - - -## LedgerNanoSecretManager Objects - -```python -class LedgerNanoSecretManager(dict) -``` - -Secret manager that uses a Ledger Nano hardware wallet or Speculos simulator. - - - -#### \_\_init\_\_ - -```python -def __init__(is_simulator) -``` - -Initialize a ledger nano secret manager. - - - -## MnemonicSecretManager Objects - -```python -class MnemonicSecretManager(dict) -``` - -Secret manager that uses a mnemonic in plain memory. It's not recommended for production use. Use LedgerNano or Stronghold instead. - - - -#### \_\_init\_\_ - -```python -def __init__(mnemonic) -``` - -Initialize a mnemonic secret manager. - - - -## StrongholdSecretManager Objects - -```python -class StrongholdSecretManager(dict) -``` - -Secret manager that uses Stronghold. - - - -#### \_\_init\_\_ - -```python -def __init__(snapshot_path, password) -``` - -Initialize a stronghold secret manager. - - - -# iota_client.client - - - -## IotaClient Objects - -```python -class IotaClient(NodeCoreAPI, NodeIndexerAPI, HighLevelAPI, Utils) -``` - - - -#### \_\_init\_\_ - -```python -def __init__(client_config=None) -``` - -Initialize the IOTA Client. - - - -#### build_alias_output - -```python -def build_alias_output(alias_id, - unlock_conditions, - amount=None, - native_tokens=None, - state_index=None, - state_metadata=None, - foundry_counter=None, - features=None, - immutable_features=None) -``` - -Build an AliasOutput. - - - -#### build_basic_output - -```python -def build_basic_output(unlock_conditions, - amount=None, - native_tokens=None, - features=None) -``` - -Build a BasicOutput. - - - -#### build_foundry_output - -```python -def build_foundry_output(serial_number, - token_scheme, - unlock_conditions, - amount=None, - native_tokens=None, - features=None, - immutable_features=None) -``` - -Build a FoundryOutput. - - - -#### build_nft_output - -```python -def build_nft_output(nft_id, - unlock_conditions, - amount=None, - native_tokens=None, - features=None, - immutable_features=None) -``` - -Build an NftOutput. - - - -#### generate_addresses - -```python -def generate_addresses(secret_manager, options) -``` - -Generate addresses. - - - -#### build_and_post_block - -```python -def build_and_post_block(secret_manager=None, options=None) -``` - -Build and post a block. - - - -#### get_node - -```python -def get_node() -``` - -Get a node candidate from the healthy node pool. - - - -#### get_network_info - -```python -def get_network_info() -``` - -Gets the network related information such as network_id and min_pow_score. - - - -#### get_network_id - -```python -def get_network_id() -``` - -Gets the network id of the node we're connecting to. - - - -#### get_bech32_hrp - -```python -def get_bech32_hrp() -``` - -Returns the bech32_hrp. - - - -#### get_min_pow_score - -```python -def get_min_pow_score() -``` - -Returns the min pow score. - - - -#### get_tips_interval - -```python -def get_tips_interval() -``` - -Returns the tips interval. - - - -#### get_local_pow - -```python -def get_local_pow() -``` - -Returns if local pow should be used or not. - - - -#### get_fall_back_to_local_pow - -```python -def get_fall_back_to_local_pow() -``` - -Get fallback to local proof of work timeout. - - - -#### unhealthy_nodes - -```python -def unhealthy_nodes() -``` - -Returns the unhealthy nodes. - - - -#### get_ledger_nano_status - -```python -def get_ledger_nano_status(is_simulator) -``` - -Returns the Ledger Status. - - - -#### prepare_transaction - -```python -def prepare_transaction(secret_manager=None, options=None) -``` - -Prepare a transaction for signing. - - - -#### sign_transaction - -```python -def sign_transaction(secret_manager, prepared_transaction_data) -``` - -Sign a transaction. - - - -#### store_mnemonic - -```python -def store_mnemonic(secret_manager, mnemonic) -``` - -Store a mnemonic in the Stronghold vault. - - - -#### submit_payload - -```python -def submit_payload(payload_dto) -``` - -Submit a payload in a block. - - - -# iota_client.\_high_level_api - - - -## HighLevelAPI Objects - -```python -class HighLevelAPI(BaseAPI) -``` - - - -#### get_outputs - -```python -def get_outputs(output_ids) -``` - -Fetch OutputResponse from provided OutputIds (requests are sent in parallel). - - - -#### try_get_outputs - -```python -def try_get_outputs(output_ids) -``` - -Try to get OutputResponse from provided OutputIds. -Requests are sent in parallel and errors are ignored, can be useful for spent outputs. - - - -#### find_blocks - -```python -def find_blocks(block_ids) -``` - -Find all blocks by provided block IDs. - - - -#### retry - -```python -def retry(block_id) -``` - -Retries (promotes or reattaches) a block for provided block id. Block should only be -retried only if they are valid and haven't been confirmed for a while. - - - -#### retry_until_included - -```python -def retry_until_included(block_id, interval=None, max_attempts=None) -``` - -Retries (promotes or reattaches) a block for provided block id until it's included (referenced by a -milestone). Default interval is 5 seconds and max attempts is 40. Returns the included block at first -position and additional reattached blocks. - - - -#### consolidate_funds - -```python -def consolidate_funds(secret_manager, generate_addresses_options) -``` - -Function to consolidate all funds from a range of addresses to the address with the lowest index in that range -Returns the address to which the funds got consolidated, if any were available. - - - -#### find_inputs - -```python -def find_inputs(addresses, amount) -``` - -Function to find inputs from addresses for a provided amount (useful for offline signing) - - - -#### find_outputs - -```python -def find_outputs(output_ids, addresses) -``` - -Find all outputs based on the requests criteria. This method will try to query multiple nodes if -the request amount exceeds individual node limit. - - - -#### reattach - -```python -def reattach(block_id) -``` - -Reattaches blocks for provided block id. Blocks can be reattached only if they are valid and haven't been -confirmed for a while. - - - -#### reattach_unchecked - -```python -def reattach_unchecked(block_id) -``` - -Reattach a block without checking if it should be reattached. - - - -#### promote - -```python -def promote(block_id) -``` - -Promotes a block. The method should validate if a promotion is necessary through get_block. If not, the -method should error out and should not allow unnecessary promotions. - - - -#### promote_unchecked - -```python -def promote_unchecked(block_id) -``` - -Promote a block without checking if it should be promoted. - - - -# iota_client.\_node_indexer_api - - - -## NodeIndexerAPI Objects - -```python -class NodeIndexerAPI(BaseAPI) -``` - - - -#### basic_output_ids - -```python -def basic_output_ids(query_parameters) -``` - -Fetch basic output IDs. - - - -#### alias_output_ids - -```python -def alias_output_ids(query_parameters) -``` - -Fetch alias output IDs. - - - -#### alias_output_id - -```python -def alias_output_id(alias_id) -``` - -Fetch alias output ID. - - - -#### nft_output_ids - -```python -def nft_output_ids(query_parameters) -``` - -Fetch NFT output IDs. - - - -#### nft_output_id - -```python -def nft_output_id(nft_id) -``` - -Fetch NFT output ID. - - - -#### foundry_output_ids - -```python -def foundry_output_ids(query_parameters) -``` - -Fetch foundry Output IDs. - - - -#### foundry_output_id - -```python -def foundry_output_id(foundry_id) -``` - -Fetch foundry Output ID. - - - -# iota_client.\_node_core_api - - - -## NodeCoreAPI Objects - -```python -class NodeCoreAPI(BaseAPI) -``` - - - -#### get_node_health - -```python -def get_node_health(url) -``` - -Get node health. - - - -#### get_node_info - -```python -def get_node_info(url, auth=None) -``` - -Get node info. - - - -#### get_info - -```python -def get_info() -``` - -Returns the node information together with the url of the used node. - - - -#### get_peers - -```python -def get_peers() -``` - -Get peers. - - - -#### get_tips - -```python -def get_tips() -``` - -Get tips. - - - -#### post_block - -```python -def post_block(block) -``` - -Post block. - - - -#### get_block_data - -```python -def get_block_data(block_id) -``` - -Post block. - - - -#### get_block_metadata - -```python -def get_block_metadata(block_id) -``` - -Get block metadata with block_id. - - - -#### get_block_raw - -```python -def get_block_raw(block_id) -``` - -Get block raw. - - - -#### get_output - -```python -def get_output(output_id) -``` - -Get output. - - - -#### get_output_metadata - -```python -def get_output_metadata(output_id) -``` - -Get output metadata. - - - -#### get_milestone_by_id - -```python -def get_milestone_by_id(milestone_id) -``` - -Get the milestone by the given milestone id. - - - -#### get_milestone_by_id_raw - -```python -def get_milestone_by_id_raw(milestone_id) -``` - -Get the raw milestone by the given milestone id. - - - -#### get_milestone_by_index - -```python -def get_milestone_by_index(index) -``` - -Get the milestone by the given index. - - - -#### get_milestone_by_index_raw - -```python -def get_milestone_by_index_raw(index) -``` - -Get the milestone by the given index. - - - -#### get_utxo_changes_by_id - -```python -def get_utxo_changes_by_id(milestone_id) -``` - -Get the UTXO changes by the given milestone id. - - - -#### get_utxo_changes_by_index - -```python -def get_utxo_changes_by_index(index) -``` - -Get the UTXO changes by the given milestone index. - - - -#### get_receipts - -```python -def get_receipts() -``` - -Get all receipts. - - - -#### get_receipts_migrated_at - -```python -def get_receipts_migrated_at(milestone_index) -``` - -Get the receipts by the given milestone index. - - - -#### get_treasury - -```python -def get_treasury() -``` - -Get the treasury output. - - - -#### get_included_block - -```python -def get_included_block(transaction_id) -``` - -Returns the included block of the transaction. - - - -# iota_client.common - - - -#### send_message_routine - -```python -def send_message_routine(func) -``` - -The routine of dump json string and call send_message() - - - -## IotaClientError Objects - -```python -class IotaClientError(Exception) -``` - -iota-client error - - - -# iota_client.\_base_api diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_01_get_node_info/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_01_get_node_info/_code_sample.mdx deleted file mode 100644 index 00562553ea7..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_01_get_node_info/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/python/examples/00_get_info.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 00_get_info.py -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_01_get_node_info/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_01_get_node_info/_expected_output.md deleted file mode 100644 index c83de4c92f7..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_01_get_node_info/_expected_output.md +++ /dev/null @@ -1,57 +0,0 @@ -```json -{ - 'nodeInfo': { - 'name': 'HORNET', - 'version': '2.0.0-beta.5', - 'status': { - 'isHealthy': True, - 'latestMilestone': { - 'index': 746844, - 'timestamp': 1661868309, - 'milestoneId': '0xee26fb7ff5b4bed7b89a761ca3d75a9c99f8c4589e55d3ec0598c9a37717a61b' - }, - 'confirmedMilestone': { - 'index': 746844, - 'timestamp': 1661868309, - 'milestoneId': '0xee26fb7ff5b4bed7b89a761ca3d75a9c99f8c4589e55d3ec0598c9a37717a61b' - }, - 'pruningIndex': 0 - }, - 'supportedProtocolVersions': [ - 2 - ], - 'protocol': { - 'version': 2, - 'networkName': 'testnet-1', - 'bech32Hrp': 'rms', - 'minPowScore': 1500.0, - 'rentStructure': { - 'vByteCost': 100, - 'vByteFactorKey': 10, - 'vByteFactorData': 1 - }, - 'tokenSupply': '1450896407249092' - }, - 'pendingProtocolParameters': [ - - ], - 'baseToken': { - 'name': 'Shimmer', - 'tickerSymbol': 'SMR', - 'unit': 'SMR', - 'subunit': 'glow', - 'decimals': 6, - 'useMetricPrefix': False - }, - 'metrics': { - 'blocksPerSecond': 9.8, - 'referencedBlocksPerSecond': 8.4, - 'referencedRate': 85.71428571428571 - }, - 'features': [ - - ] - }, - 'url': 'https://api.testnet.shimmer.network' -} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_01_get_node_info/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_01_get_node_info/_key_api_ref_links.md deleted file mode 100644 index 4a25c50cc21..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_01_get_node_info/_key_api_ref_links.md +++ /dev/null @@ -1,10 +0,0 @@ -### Build a `Client` - -You can build an [`IotaClient`](./../libraries/python/api_reference#iotaclient-objects) by instantiating it and -specifying your desired nodes URL in the `client_config`. - -### Get the Node's Info - -Once you have built the `IotaClient`, you can retrieve the node's information by -running [`IotaClient.get_Info()`](./../libraries/python/api_reference#get_info). This function will target -the `/api/v2/info` endpoint and return the node's information as well as its URL if successful. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_02_generate_mnemonic/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_02_generate_mnemonic/_code_sample.mdx deleted file mode 100644 index 9fe5396f25b..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_02_generate_mnemonic/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/python/examples/01_mnemonic.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 01_mnemonic.py -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_02_generate_mnemonic/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_02_generate_mnemonic/_expected_output.md deleted file mode 100644 index 0d0490dc64a..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_02_generate_mnemonic/_expected_output.md +++ /dev/null @@ -1,3 +0,0 @@ -```plaintext -Mnemonic: glance zoo dove legend razor season evoke twenty flush solution essence destroy loud traffic friend decorate emotion total borrow expect actor switch shock zer -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_02_generate_mnemonic/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_02_generate_mnemonic/_key_api_ref_links.md deleted file mode 100644 index d7691bfb4e5..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_02_generate_mnemonic/_key_api_ref_links.md +++ /dev/null @@ -1,4 +0,0 @@ -### Generate the Mnemonic - -You can generate a mnemonic by calling -the [`IotaClient.generate_mnemonic()`](./../libraries/python/api_reference#generate_mnemonic) function. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_03_generate_addresses/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_03_generate_addresses/_code_sample.mdx deleted file mode 100644 index 499128158d5..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_03_generate_addresses/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/python/examples/02_generate_addresses.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 02_generate_addresses.py -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_03_generate_addresses/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_03_generate_addresses/_expected_output.md deleted file mode 100644 index 9a506537054..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_03_generate_addresses/_expected_output.md +++ /dev/null @@ -1,42 +0,0 @@ -```plaintext -List of generated public addresses: -rms1qpllaj0pyveqfkwxmnngz2c488hfdtmfrj3wfkgxtk4gtyrax0jaxzt70zy -rms1qzzk86qv30l4e85ljtccxa0ruy8y7u8zn2dle3g8dv2tl2m4cu227a7n2wj -rms1qqjrtmslm36l3lyd8086w9qdxd9mudu2z2qyywlltpycn2ftxsdmu9ulj47 -rms1qzz75j5h7vd5melxwersz49jja36m2vvnawedu0l6rlhg70ylzqp52lx8zf -rms1qzvs2rvq5ef79vhuel354mnvzfz049gyyf808zmjculuatt56u92vc4v4p3 -rms1qpk0dj5lmv5r8d64f3x0qwx3jccredwa42xscdreqma73f3dxymaqdy645t -rms1qqlp6nurrz459jvvvuhv6t965v6cmlata57kf6auv6955uyp77uyw0egzgn -rms1qq2tu523zqzjxgdl69au8a9yewmd9ztctssv40dsv7lfd0tp36w4xdfzcyr -rms1qpw904c253cc9yn2dkhxx89u6r5j9vzezfatchrlugrkcvvhed3hckx6h2u -rms1qpa646cegkqsx9eht793nmux2vjwa63jrenqe87xq8j5wysfhu4l28k4ep9 -rms1qq02yzamyu2z4rflv48cpt86kclcqr0rkxx748cf7l08l75gwtlcw54udc6 -rms1qpulq7ldsux06s92n33pwk92mmllw07lqkkdfy5g9td0v2thhx2wxmd4lec -rms1qr0wl256lkfj7gdy8x5hqpvyrwtx98flyns3l7aehheg5c04kxj0cwy9eff -rms1qq8mmsdwrt809wl6dgn2rmt7ak6082enmnqapy59xfqtyenrwsxtghxgmch -rms1qqj7667kh0fmykdc65kwad5mvhhv9sxe8kdj0wenp6nwwnf0qkdwk7v07vu -rms1qpcwqlmu2n42fvht7fufztdg2k4hhtwzzrhsvucktrhk6mlr3cpvk7q75pf -rms1qppssdyxxsfa3c2ln47ccxryh68w3jret6zx6v9r43ptr4n7fks9g3l4eup -rms1qrkq9nv9uhafnduvfgtmru99532yhqpmqugf9x9x90ptzpceujkwgj2yaj4 -rms1qptssvmyhfas223m542ayqagn06urq8v0yad770fxsj3grftqe4jzq3sh6m -rms1qr98trzs2snaeawklxnrpe3a3hahvkeydqdt3s6hps36lp8uxfzlcfx0pj6 - -List of generated public addresses: -rms1qpllaj0pyveqfkwxmnngz2c488hfdtmfrj3wfkgxtk4gtyrax0jaxzt70zy -rms1qzzk86qv30l4e85ljtccxa0ruy8y7u8zn2dle3g8dv2tl2m4cu227a7n2wj -rms1qqjrtmslm36l3lyd8086w9qdxd9mudu2z2qyywlltpycn2ftxsdmu9ulj47 -rms1qzz75j5h7vd5melxwersz49jja36m2vvnawedu0l6rlhg70ylzqp52lx8zf - -List of generated internal addresses: -rms1qp6w3v03qwtwkh52avtdvejpdqp8yfpk4z94m5dg3evuzu9hynyucvmxd59 -rms1qqv993w400a6j7darw3v5h6tevk7qx534lr8tcu47zdrazhz0z2zstmj4da -rms1qzelrg0560t52g2wjpkyyesfg7wzcm8wa89akf6eux88xtupjaqazsw7jyy -rms1qp385r3f8k64cphft8lde9emrqarfwshnlwdnguw3qr62q32dmx6wt8e0sv - -List of offline generated public addresses: -rms1qpllaj0pyveqfkwxmnngz2c488hfdtmfrj3wfkgxtk4gtyrax0jaxzt70zy -rms1qzzk86qv30l4e85ljtccxa0ruy8y7u8zn2dle3g8dv2tl2m4cu227a7n2wj -rms1qqjrtmslm36l3lyd8086w9qdxd9mudu2z2qyywlltpycn2ftxsdmu9ulj47 -rms1qzz75j5h7vd5melxwersz49jja36m2vvnawedu0l6rlhg70ylzqp52lx8zf - -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_03_generate_addresses/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_03_generate_addresses/_key_api_ref_links.md deleted file mode 100644 index 13ebd3a867c..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_03_generate_addresses/_key_api_ref_links.md +++ /dev/null @@ -1,44 +0,0 @@ -### Generate the Address - -You can generate an address from a [mnemonic](../../../../how_tos/02_generate_mnemonic.mdx) by calling -the [`Client.generate_addresses(secret_manager, options)`](./../libraries/python/api_reference#generate_addresses) -function. If successful, the function will return a list of addresses from the secret manager. - -#### Use a `SecretManager` - -You should not pass the mnemonic as plaintext. Instead, you should create a `SecretManager`instance and pass that to -the `Client.generate_addresses(secret_manager, options)` function. This example uses -a [`MnemonicSecretManager`](./../libraries/python/api_reference#mnemonicsecretmanager-objects) - -#### Add Options - -You can customize the address by adding `options` to the `Client.generate_addresses(secret_manager, options)` function -call in the form of a JSON object. - -##### accountIndex - -You can set the account index by adding the `accountIndex` option. - -##### Example - -```json -{ - "accountIndex": 0 -} -``` - -##### range - -You can set the account builder range by specifying the `range` option. You will need to specify both a `start` and -an `end`. - -##### Example - -```json -{ - "range": { - "start": 0, - "end": 1 - } -}) -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_04_get_output/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_04_get_output/_code_sample.mdx deleted file mode 100644 index c4774ce8030..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_04_get_output/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/python/examples/04_get_output.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 04_get_output.py -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_04_get_output/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_04_get_output/_expected_output.md deleted file mode 100644 index f652ac6ef5f..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_04_get_output/_expected_output.md +++ /dev/null @@ -1,61 +0,0 @@ -```json -{ - 'metadata': { - 'blockId': '0xa9f11aba1e9965173dc21a47ec4fbfe5b953a6e60277857a3f7a5c1499e7c454', - 'transactionId': '0x1e857d380f813d8035e487b6dfd2ff4740b6775273ba1b576f01381ba2a1a44c', - 'outputIndex': 0, - 'isSpent': True, - 'milestoneIndexSpent': 249147, - 'milestoneTimestampSpent': 1659379781, - 'transactionIdSpent': '0xa927ea21d3c4a49d5c73169c80302ddb223894c182a4b7cfef0af89568262749', - 'milestoneIndexBooked': 249145, - 'milestoneTimestampBooked': 1659379771, - 'ledgerIndex': 749737 - }, - 'output': { - 'type': 4, - 'amount': '2000000', - 'aliasId': '0x0000000000000000000000000000000000000000000000000000000000000000', - 'stateIndex': 0, - 'foundryCounter': 0, - 'unlockConditions': [ - { - 'type': 4, - 'address': { - 'type': 0, - 'pubKeyHash': '0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3' - } - }, - { - 'type': 5, - 'address': { - 'type': 0, - 'pubKeyHash': '0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3' - } - } - ], - 'features': [ - { - 'type': 0, - 'address': { - 'type': 0, - 'pubKeyHash': '0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3' - } - }, - { - 'type': 2, - 'data': '0x010203' - } - ], - 'immutableFeatures': [ - { - 'type': 1, - 'address': { - 'type': 0, - 'pubKeyHash': '0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3' - } - } - ] - } -} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_04_get_output/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_04_get_output/_key_api_ref_links.md deleted file mode 100644 index 8fa5a85fdbf..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_04_get_output/_key_api_ref_links.md +++ /dev/null @@ -1,10 +0,0 @@ -## Get an Output by ID - -You can retrieve any output using its `outputId` (transaction id + output index) by calling -the [`Client.get_output(output_id)`](./../libraries/python/api_reference#get_output) function and providing a -valid output ID. - -If the function is successful, it will return an object with the block's metadata and the -output object. - -This function call will target the `GET /api/core/v2/outputs/{outputId}` endpoint. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_05_build_output/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_05_build_output/_code_sample.mdx deleted file mode 100644 index 9318276867e..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_05_build_output/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/python/examples/11_build_output.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 11_build_output.py -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_05_build_output/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_05_build_output/_expected_output.md deleted file mode 100644 index 1982d5315a9..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_05_build_output/_expected_output.md +++ /dev/null @@ -1,93 +0,0 @@ -```json -{ - "type": 3, - "amount": "1000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - } - ] -} -{ - "type": 3, - "amount": "1000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - } - ], - "features": [ - { - "type": 2, - "data": "0x48656c6c6f2c20576f726c6421" - } - ] -} -{ - "type": 3, - "amount": "1000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - }, - { - "type": 1, - "returnAddress": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - }, - "amount": "1000000" - } - ] -} -{ - "type": 3, - "amount": "1000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - }, - { - "type": 3, - "returnAddress": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - }, - "unixTime": 1 - } - ] -} -{ - "type": 3, - "amount": "1000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - }, - { - "type": 2, - "unixTime": 1 - } - ] -} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_05_build_output/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_05_build_output/_key_api_ref_links.md deleted file mode 100644 index fcccf6dc136..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_05_build_output/_key_api_ref_links.md +++ /dev/null @@ -1,5 +0,0 @@ -### Build a Basic Output - -You can create a basic output by calling -the [`Client.build_basic_output(unlock_conditions, amount=None, native_tokens=None, features=None)`](./../libraries/python/api_reference#build_basic_output) -function. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_06_get_address_balances/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_06_get_address_balances/_code_sample.mdx deleted file mode 100644 index e002f4f9b82..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_06_get_address_balances/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/python/examples/05_get_address_balance.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 05_get_address_balance.py -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_06_get_address_balances/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_06_get_address_balances/_expected_output.md deleted file mode 100644 index ed7e0078735..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_06_get_address_balances/_expected_output.md +++ /dev/null @@ -1,29 +0,0 @@ -```json -Outputs controlled by rms1qpllaj0pyveqfkwxmnngz2c488hfdtmfrj3wfkgxtk4gtyrax0jaxzt70zy have -2609275800 glow and nativetokens: [ - [ - { - 'id': '0x0808fb702d67fdb320b5959f152c0f962630515d904c71ed09447c341a6cc171de0100000000', - 'amount': '0x64' - }, - { - 'id': '0x0822ceb3166ad125d310e6660f5fc292356f87f2f9566e982ea22154cec3847b3f0100000000', - 'amount': '0x64' - }, - { - 'id': '0x085c6b799750bdf7e5a5c81144465a0676bc11dab74b997444ca369949341720e80100000000', - 'amount': '0x64' - }, - { - 'id': '0x08f708a29e9619e847916de76c2e167e87a704c235dcbd7cda018865be7f561b5a0100000000', - 'amount': '0x32' - } - ], - [ - { - 'id': '0x08f1802858831220b282ccc4c557676d61f79833869de378ce9a81f736976ce39f0100000000', - 'amount': '0x32' - } - ] -] -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_06_get_address_balances/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_06_get_address_balances/_key_api_ref_links.md deleted file mode 100644 index cd7421a04ff..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_06_get_address_balances/_key_api_ref_links.md +++ /dev/null @@ -1,31 +0,0 @@ -### `Client.basic_output_ids(query_parameters)` - -You can retrieve outputs from any given address using the [`Client.basic_output_ids(query_parameters)`](./../libraries/python/api_reference#build_basic_output) -function. - -This function will query the `api/indexer/v1/outputs/basic` endpoint. - -#### `query_parameters` - -You should pass the parameters as an array of objects. The following objects are used in the example: - -##### address - -The Bech32-encoded address that should be searched for. - -##### hasExpiration - -Indicates if the outputs should have an expiration unlock condition or not. - -##### hasTimeLock - -Indicates if the outputs should have a time-locked unlock condition or not. - -##### hasStorageDepositReturn - -Indicates if the outputs should have storage deposit return unlock condition or not. - -### `Client.get_outputs(output_ids)` - -The [`Client.get_outputs(output_ids)`](./../libraries/python/api_reference#get_outputs) will query the node for a list -of `output_ids` in parallel. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_07_create_block/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_07_create_block/_code_sample.mdx deleted file mode 100644 index 57eaaeda7e9..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_07_create_block/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/python/examples/06_simple_block.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 06_simple_block.py -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_07_create_block/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_07_create_block/_expected_output.md deleted file mode 100644 index 9bb46e86cc9..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_07_create_block/_expected_output.md +++ /dev/null @@ -1,15 +0,0 @@ -```json -[ - "0xa76b3551777d24fd20a045b2ebae11346c9f7ce76e2351eccb044b8842769250", - { - "protocolVersion": 2, - "parents": [ - "0x485f44a5528b341a179db493fdd19138096f823fc034ba207a9ed85ebee5a109", - "0x4a77573beb29edfa67ec00ee10577b31fe6a9e50b19ace0c833cfd1166069f7a", - "0xa8edca4bda2db44e7bd29dd9282eff6011ff73fc1e318ba5950a67387be562da", - "0xac283aa0ea563f81d7be39d2ae78bbadae838142e6d81280aeae02e96e35f013" - ], - "nonce": "12297829382473042444" - } -] -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_07_create_block/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_07_create_block/_key_api_ref_links.md deleted file mode 100644 index 7350dbfbdd2..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_07_create_block/_key_api_ref_links.md +++ /dev/null @@ -1,7 +0,0 @@ -### `Client.build_and_post_block(secret_manager=None, options=None)` - -You can create a simple empty block by calling -the [`Client.build_and_post_block(secret_manager=None, options=None)`](./../libraries/python/api_reference#build_and_post_block) -function. - -If successful, the function will return the created block. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_08_post_block/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_08_post_block/_code_sample.mdx deleted file mode 100644 index 03fce3260f0..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_08_post_block/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/python/examples/08_data_block.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 08_data_block.py -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_08_post_block/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_08_post_block/_expected_output.md deleted file mode 100644 index 32e77903407..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_08_post_block/_expected_output.md +++ /dev/null @@ -1,20 +0,0 @@ -```json -[ - "0x97379a9baae8541834d5fdd4757b9ed145f3fae6af729d37f2d5cc026c3ec69f", - { - "protocolVersion": 2, - "parents": [ - "0x151e3afa885362540bbe0696e7eacd4beeb009cb545fa4ab7124a9b0fad9c147", - "0x594b367a064ca9342fb255b9495f42e9a30d8426dbf7f2a6883aa0cb8ac08100", - "0x7d4533d18880170c6082a64f71466edbc1cb0c15f526fac75d436b4fbe05a2a8", - "0xc675b08d064bd20f7e2a061646ed9dccf7c0c8edd6f364541cbcbd5564e35a30" - ], - "payload": { - "type": 5, - "tag": "0x68656c6c6f", - "data": "0x68656c6c6f" - }, - "nonce": "12297829382473068203" - } -] -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_08_post_block/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_08_post_block/_key_api_ref_links.md deleted file mode 100644 index 092a77ce80c..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_08_post_block/_key_api_ref_links.md +++ /dev/null @@ -1,9 +0,0 @@ -### `Client.post_block(block)` - -You can post a block in JSON format using -the [`Client.post_block(block)`](./../libraries/python/api_reference#get_block_data) -function. - -If successful, the function will return the ID of the submitted block. - -This function queries the `POST JSON to /api/core/v2/blocks` endpoint. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_09_get_block/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_09_get_block/_code_sample.mdx deleted file mode 100644 index d7dd3a660cb..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_09_get_block/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/python/examples/07_get_block_data.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 07_get_block_data.py -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_09_get_block/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_09_get_block/_expected_output.md deleted file mode 100644 index 91a70dfb67c..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_09_get_block/_expected_output.md +++ /dev/null @@ -1,38 +0,0 @@ -```json -[ - '0xd1cb2c76a7ebbab78336dc185e565920aa165590e9f8a1f4b94d9dc381f24a81', - { - 'protocolVersion': 2, - 'parents': [ - '0x2cb6a30010b7b108262504545f2ff23da9c2fe7bf7e09f200140dd4edebcd0c9', - '0x4c145b3e311ea1a37b1601efb80f19ca3e3ee431dad9aeebfa18976b67646fac', - '0x5de1ab132cf00d590ca4bfd8f8c06fc576ac9dbd56d1fa4be5720f8583978533', - '0xc4838f69b7f5f7d4860341bd7483d19d814ce6df8dc60b72245d94d938970404' - ], - 'nonce': '13835058055282164293' - } -] -{ - 'blockId': '0xd1cb2c76a7ebbab78336dc185e565920aa165590e9f8a1f4b94d9dc381f24a81', - 'parents': [ - '0x2cb6a30010b7b108262504545f2ff23da9c2fe7bf7e09f200140dd4edebcd0c9', - '0x4c145b3e311ea1a37b1601efb80f19ca3e3ee431dad9aeebfa18976b67646fac', - '0x5de1ab132cf00d590ca4bfd8f8c06fc576ac9dbd56d1fa4be5720f8583978533', - '0xc4838f69b7f5f7d4860341bd7483d19d814ce6df8dc60b72245d94d938970404' - ], - 'isSolid': True, - 'shouldPromote': False, - 'shouldReattach': False -} -{ - 'protocolVersion': 2, - 'parents': [ - '0x2cb6a30010b7b108262504545f2ff23da9c2fe7bf7e09f200140dd4edebcd0c9', - '0x4c145b3e311ea1a37b1601efb80f19ca3e3ee431dad9aeebfa18976b67646fac', - '0x5de1ab132cf00d590ca4bfd8f8c06fc576ac9dbd56d1fa4be5720f8583978533', - '0xc4838f69b7f5f7d4860341bd7483d19d814ce6df8dc60b72245d94d938970404' - ], - 'nonce': '13835058055282164293' -} - -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_09_get_block/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_09_get_block/_key_api_ref_links.md deleted file mode 100644 index b22131b0b9b..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_09_get_block/_key_api_ref_links.md +++ /dev/null @@ -1,19 +0,0 @@ -### `Client.get_block_data(block_id)` - -You can retrieve a block's metadata using its block ID using -the [`Client.get_block_data(block_id)`](./../libraries/python/api_reference#get_block_data) -function. - -If successful, the function will return the block's as JSON. - -This function queries the `GET /api/core/v2/blocks/{BlockId}` endpoint. - -### `Client.get_block_metadata(block_id)` - -You can retrieve a block's metadata using its block ID using -the [`Client.get_block_metadata(block_id)`](./../libraries/python/api_reference#get_block_metadata) -function. - -If successful, the function will return the block's metadata as JSON. - -This function queries the `GET /api/core/v2/blocks/{BlockId}/metadata` endpoint. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_10_prepare_signed_transaction/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_10_prepare_signed_transaction/_code_sample.mdx deleted file mode 100644 index b4b86591460..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_10_prepare_signed_transaction/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/python/examples/09_transaction.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 09_transaction.py -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_10_prepare_signed_transaction/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_10_prepare_signed_transaction/_expected_output.md deleted file mode 100644 index 83e37b95b41..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_10_prepare_signed_transaction/_expected_output.md +++ /dev/null @@ -1,86 +0,0 @@ -```json -[ - "0x1f275f75b31471ab88b12522c5d1bb8ae9294e7aa24fda5845272440d6cec151", - { - "protocolVersion": 2, - "parents": [ - "0x29d95dae99c84a62a29939b0da590eea51d6eee69596ab9b8d7547b765c996a0", - "0x6c6a7909aa7075f69be9e1b86469dc54b37e446a31ad130ad96081a5eb1426a2", - "0x9898a2148e28caa76861f69cf8b044ab86f458ddea5b8378f43777410387ba3e", - "0xbcc5f3cab065451107b6df603e0d3d8a99a3627147cacba90ed7f260a635e4a4" - ], - "payload": { - "type": 6, - "essence": { - "type": 1, - "networkId": "1856588631910923207", - "inputs": [ - { - "type": 0, - "transactionId": "0x3b6cba154609957899bbcaafafa4354b2207ab95ef27bdda92f86fbe06194c47", - "transactionOutputIndex": 0 - }, - { - "type": 0, - "transactionId": "0x3c0fc948789431e1a86b378fe3bd847f8c0634176e70986aa05a6dacba9a137a", - "transactionOutputIndex": 0 - }, - { - "type": 0, - "transactionId": "0x43380de68c5ca72f4ab2ee276c297d1ffb05330068373a9714d3a57a019a0cd3", - "transactionOutputIndex": 127 - } - ], - "inputsCommitment": "0x5e3b2fa09083546c2218b3e56b1c35225ba8df0dc027ae62e70f44d3e09af919", - "outputs": [ - { - "type": 3, - "amount": "1000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x8297ac4149c80cca8225e5f2da36df89a93cd2998d7f6d488c97250a881e65af" - } - } - ] - }, - { - "type": 3, - "amount": "97335202", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x8297ac4149c80cca8225e5f2da36df89a93cd2998d7f6d488c97250a881e65af" - } - } - ] - } - ] - }, - "unlocks": [ - { - "type": 0, - "signature": { - "type": 0, - "publicKey": "0xe62838fda7e8b77bf80e49967f0f089ae2a7230547d5231649732952f6336fae", - "signature": "0x9bacfc3064e458994e19253eac4b1d299d0b1dc27ea7910228a6b8fe77022ed7a9296541ad9c159e688a9b7943eb5494d433e32eb56c7afbf14282a12a927d06" - } - }, - { - "type": 1, - "reference": 0 - }, - { - "type": 1, - "reference": 0 - } - ] - }, - "nonce": "6148914691236584594" - } -] -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_10_prepare_signed_transaction/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_10_prepare_signed_transaction/_key_api_ref_links.md deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_11_nft_output/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_11_nft_output/_code_sample.mdx deleted file mode 100644 index 53c480492a6..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_11_nft_output/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/python/examples/10_mint_nft.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 10_mint_nft.py -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_11_nft_output/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_11_nft_output/_expected_output.md deleted file mode 100644 index fde26efea89..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_11_nft_output/_expected_output.md +++ /dev/null @@ -1,90 +0,0 @@ -```json -[ - "0xa05ab7a0ab2842dedda5bd788b30ad98e32e32a35951896093de40833e9719fa", - { - "protocolVersion": 2, - "parents": [ - "0x5031f5dd9defa4a663c33183f32259e35013d940b8453cb2f985f49363a905af", - "0x9a1692a4976bafb78318cdfcb0277e12f80f0db1fc441765503095ec6d326071", - "0xaeb154db6b9f32cd56bb622f209dec6565645296650c132c957d31139dd01ded", - "0xd28cfe9950c7a7be8eceb921107fc5fb6ac5c67013e59ea23e30a39d45a459f2" - ], - "payload": { - "type": 6, - "essence": { - "type": 1, - "networkId": "1856588631910923207", - "inputs": [ - { - "type": 0, - "transactionId": "0x434e6b652e801b80841d72f29ba7ea82c6222118c8e18177e16225e7e3668252", - "transactionOutputIndex": 0 - }, - { - "type": 0, - "transactionId": "0x470d590d4a747e52db3e7d908a732311b10ffebe5cad65030c8b7a57484ba125", - "transactionOutputIndex": 0 - } - ], - "inputsCommitment": "0x6dd5e1990b10aa6cd458cf88d0febfbe5d4b97ab50ead3059a6f1338e93f6892", - "outputs": [ - { - "type": 6, - "amount": "1000000", - "nftId": "0x0000000000000000000000000000000000000000000000000000000000000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x8297ac4149c80cca8225e5f2da36df89a93cd2998d7f6d488c97250a881e65af" - } - } - ], - "features": [ - { - "type": 2, - "data": "0x68656c6c6f" - } - ], - "immutableFeatures": [ - { - "type": 2, - "data": "0x68656c6c6f" - } - ] - }, - { - "type": 3, - "amount": "50600", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x8297ac4149c80cca8225e5f2da36df89a93cd2998d7f6d488c97250a881e65af" - } - } - ] - } - ] - }, - "unlocks": [ - { - "type": 0, - "signature": { - "type": 0, - "publicKey": "0xe62838fda7e8b77bf80e49967f0f089ae2a7230547d5231649732952f6336fae", - "signature": "0x044689897d08227e0134489c4c29398e8ae745727a99dcad7ceb36e4228a0b9a71939ece341f17c6d62c9bef93f9fc72c426c4fae159dcca24bdfed1182e3903" - } - }, - { - "type": 1, - "reference": 0 - } - ] - }, - "nonce": "13835058055282177567" - } -] -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_11_nft_output/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_11_nft_output/_key_api_ref_links.md deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_12_foundry_output/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_12_foundry_output/_code_sample.mdx deleted file mode 100644 index 4d06552b91a..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_12_foundry_output/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/python/examples/build_foundry.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 build_foundry.py -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_12_foundry_output/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_12_foundry_output/_expected_output.md deleted file mode 100644 index 221dad13c3e..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_12_foundry_output/_expected_output.md +++ /dev/null @@ -1,28 +0,0 @@ -```json -{ - "type": 5, - "amount": "59800", - "nativeTokens": [ - { - "id": "0x081e6439529b020328c08224b43172f282cb16649d50c891fa156365323667e47a0100000000", - "amount": "0x32" - } - ], - "serialNumber": 1, - "tokenScheme": { - "type": 0, - "mintedTokens": "0x32", - "meltedTokens": "0x0", - "maximumSupply": "0x64" - }, - "unlockConditions": [ - { - "type": 6, - "address": { - "type": 8, - "aliasId": "0xa5c28d5baa951de05e375fb19134ea51a918f03acc2d0cee011a42b298d3effa" - } - } - ] -} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_13_alias_output/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_13_alias_output/_code_sample.mdx deleted file mode 100644 index c261be2cf76..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_13_alias_output/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/python/examples/build_alias.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 build_alias.py -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_13_alias_output/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_13_alias_output/_expected_output.md deleted file mode 100644 index 08ee7d63c51..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_13_alias_output/_expected_output.md +++ /dev/null @@ -1,52 +0,0 @@ -```json -{ - "type": 4, - "amount": "59200", - "aliasId": "0x0000000000000000000000000000000000000000000000000000000000000000", - "stateIndex": 0, - "stateMetadata": "0x68656c6c6f", - "foundryCounter": 0, - "unlockConditions": [ - { - "type": 4, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - }, - { - "type": 5, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - } - ], - "features": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - }, - { - "type": 2, - "data": "0x68656c6c6f" - } - ], - "immutableFeatures": [ - { - "type": 1, - "address": { - "type": 0, - "pubKeyHash": "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3" - } - }, - { - "type": 2, - "data": "0x68656c6c6f" - } - ] -} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_14_post_raw_block/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_14_post_raw_block/_code_sample.mdx deleted file mode 100644 index 7c93cc0eca5..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_14_post_raw_block/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/python/examples/post_raw_block.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 post_raw_block.py -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_14_post_raw_block/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_14_post_raw_block/_expected_output.md deleted file mode 100644 index 1561bd6271a..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_14_post_raw_block/_expected_output.md +++ /dev/null @@ -1,3 +0,0 @@ -```plaintext -0x1004a5dee96c69a6951d71ce6c86dea378220a82a0202a20ec9163547e6fb4e2 -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_run_how_tos.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_run_how_tos.md deleted file mode 100644 index 119ae300515..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/how_to/_run_how_tos.md +++ /dev/null @@ -1,26 +0,0 @@ -## Prerequisites - -Before you can run the examples, please refer to the [Python Getting Started guide](./../../../getting_started/python.mdx) to install -the library. - -## Run Code Examples - -The iota.rs library has numerous [examples](https://github.com/iotaledger/iota.rs/tree/develop/client/bindings/python/examples) -you can run to get acquainted with the library. After you have followed the instructions to -[install the library](./../../../getting_started/python.mdx#install-the-library), you can run any example with the following -command from the `bindings/python` directory: - -```bash -python3 example/[example file name] -``` - -Where [example file name] is one of the -[examples](https://github.com/iotaledger/iota.rs/tree/develop/bindings/python/examples). - -For instance, to run -[`00_get_info.py`](https://github.com/iotaledger/iota.rs/blob/develop/bindings/python/examples/00_get_info.py), -you should run: - -```bash -python3 examples/00_get_info.py -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/client.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/client.md deleted file mode 100644 index f339b330b31..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/client.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -sidebar_label: client -title: iota_client.client ---- - -## IotaClient Objects - -```python -class IotaClient(NodeCoreAPI, NodeIndexerAPI, HighLevelAPI, Utils) -``` - -### \_\_init\_\_ - -```python -def __init__(client_config=None) -``` - -Initialize the IOTA Client. - -### build_alias_output - -```python -def build_alias_output(alias_id, - unlock_conditions, - amount=None, - native_tokens=None, - state_index=None, - state_metadata=None, - foundry_counter=None, - features=None, - immutable_features=None) -``` - -Build an AliasOutput. - -### build_basic_output - -```python -def build_basic_output(unlock_conditions, - amount=None, - native_tokens=None, - features=None) -``` - -Build a BasicOutput. - -### build_foundry_output - -```python -def build_foundry_output(serial_number, - token_scheme, - unlock_conditions, - amount=None, - native_tokens=None, - features=None, - immutable_features=None) -``` - -Build a FoundryOutput. - -### build_nft_output - -```python -def build_nft_output(nft_id, - unlock_conditions, - amount=None, - native_tokens=None, - features=None, - immutable_features=None) -``` - -Build an NftOutput. - -### generate_addresses - -```python -def generate_addresses(secret_manager, options) -``` - -Generate addresses. - -### build_and_post_block - -```python -def build_and_post_block(secret_manager=None, options=None) -``` - -Build and post a block. - -### get_node - -```python -def get_node() -``` - -Get a node candidate from the healthy node pool. - -### get_network_info - -```python -def get_network_info() -``` - -Gets the network related information such as network_id and min_pow_score. - -### get_network_id - -```python -def get_network_id() -``` - -Gets the network id of the node we're connecting to. - -### get_bech32_hrp - -```python -def get_bech32_hrp() -``` - -Returns the bech32_hrp. - -### get_min_pow_score - -```python -def get_min_pow_score() -``` - -Returns the min pow score. - -### get_tips_interval - -```python -def get_tips_interval() -``` - -Returns the tips interval. - -### get_local_pow - -```python -def get_local_pow() -``` - -Returns if local pow should be used or not. - -### get_fall_back_to_local_pow - -```python -def get_fall_back_to_local_pow() -``` - -Get fallback to local proof of work timeout. - -### unhealthy_nodes - -```python -def unhealthy_nodes() -``` - -Returns the unhealthy nodes. - -### get_ledger_nano_status - -```python -def get_ledger_nano_status(is_simulator) -``` - -Returns the Ledger Status. - -### prepare_transaction - -```python -def prepare_transaction(secret_manager=None, options=None) -``` - -Prepare a transaction for signing. - -### sign_transaction - -```python -def sign_transaction(secret_manager, prepared_transaction_data) -``` - -Sign a transaction. - -### store_mnemonic - -```python -def store_mnemonic(secret_manager, mnemonic) -``` - -Store a mnemonic in the Stronghold vault. - -### submit_payload - -```python -def submit_payload(payload_dto) -``` - -Submit a payload in a block. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/common.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/common.md deleted file mode 100644 index 49a64e1a689..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/common.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -sidebar_label: common -title: iota_client.common ---- - -### send_message_routine - -```python -def send_message_routine(func) -``` - -The routine of dump json string and call send_message() - -## IotaClientError Objects - -```python -class IotaClientError(Exception) -``` - -iota-client error diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/high_level_api.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/high_level_api.md deleted file mode 100644 index 6f93f03013b..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/high_level_api.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -sidebar_label: high_level_api -title: iota_client.high_level_api ---- - -## HighLevelAPI Objects - -```python -class HighLevelAPI(BaseAPI) -``` - -### get_outputs - -```python -def get_outputs(output_ids) -``` - -Fetch OutputResponse from provided OutputIds (requests are sent in parallel). - -### try_get_outputs - -```python -def try_get_outputs(output_ids) -``` - -Try to get OutputResponse from provided OutputIds. -Requests are sent in parallel and errors are ignored, can be useful for spent outputs. - -### find_blocks - -```python -def find_blocks(block_ids) -``` - -Find all blocks by provided block IDs. - -### retry - -```python -def retry(block_id) -``` - -Retries (promotes or reattaches) a block for provided block id. Block should only be -retried only if they are valid and haven't been confirmed for a while. - -### retry_until_included - -```python -def retry_until_included(block_id, interval=None, max_attempts=None) -``` - -Retries (promotes or reattaches) a block for provided block id until it's included (referenced by a -milestone). Default interval is 5 seconds and max attempts is 40. Returns the included block at first -position and additional reattached blocks. - -### consolidate_funds - -```python -def consolidate_funds(secret_manager, generate_addresses_options) -``` - -Function to consolidate all funds from a range of addresses to the address with the lowest index in that range -Returns the address to which the funds got consolidated, if any were available. - -### find_inputs - -```python -def find_inputs(addresses, amount) -``` - -Function to find inputs from addresses for a provided amount (useful for offline signing) - -### find_outputs - -```python -def find_outputs(output_ids, addresses) -``` - -Find all outputs based on the requests criteria. This method will try to query multiple nodes if -the request amount exceeds individual node limit. - -### reattach - -```python -def reattach(block_id) -``` - -Reattaches blocks for provided block id. Blocks can be reattached only if they are valid and haven't been -confirmed for a while. - -### reattach_unchecked - -```python -def reattach_unchecked(block_id) -``` - -Reattach a block without checking if it should be reattached. - -### promote - -```python -def promote(block_id) -``` - -Promotes a block. The method should validate if a promotion is necessary through get_block. If not, the -method should error out and should not allow unnecessary promotions. - -### promote_unchecked - -```python -def promote_unchecked(block_id) -``` - -Promote a block without checking if it should be promoted. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/node_core_api.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/node_core_api.md deleted file mode 100644 index de38bbc4426..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/node_core_api.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -sidebar_label: node_core_api -title: iota_client.node_core_api ---- - -## NodeCoreAPI Objects - -```python -class NodeCoreAPI(BaseAPI) -``` - -### get_node_health - -```python -def get_node_health(url) -``` - -Get node health. - -### get_node_info - -```python -def get_node_info(url, auth=None) -``` - -Get node info. - -### get_info - -```python -def get_info() -``` - -Returns the node information together with the url of the used node. - -### get_peers - -```python -def get_peers() -``` - -Get peers. - -### get_tips - -```python -def get_tips() -``` - -Get tips. - -### post_block - -```python -def post_block(block) -``` - -Post block. - -### get_block_data - -```python -def get_block_data(block_id) -``` - -Post block. - -### get_block_metadata - -```python -def get_block_metadata(block_id) -``` - -Get block metadata with block_id. - -### get_block_raw - -```python -def get_block_raw(block_id) -``` - -Get block raw. - -### post_block_raw - -```python -def post_block_raw(block_bytes) -``` - -Post block raw. - -### get_output - -```python -def get_output(output_id) -``` - -Get output. - -### get_output_metadata - -```python -def get_output_metadata(output_id) -``` - -Get output metadata. - -### get_milestone_by_id - -```python -def get_milestone_by_id(milestone_id) -``` - -Get the milestone by the given milestone id. - -### get_milestone_by_id_raw - -```python -def get_milestone_by_id_raw(milestone_id) -``` - -Get the raw milestone by the given milestone id. - -### get_milestone_by_index - -```python -def get_milestone_by_index(index) -``` - -Get the milestone by the given index. - -### get_milestone_by_index_raw - -```python -def get_milestone_by_index_raw(index) -``` - -Get the milestone by the given index. - -### get_utxo_changes_by_id - -```python -def get_utxo_changes_by_id(milestone_id) -``` - -Get the UTXO changes by the given milestone id. - -### get_utxo_changes_by_index - -```python -def get_utxo_changes_by_index(index) -``` - -Get the UTXO changes by the given milestone index. - -### get_receipts - -```python -def get_receipts() -``` - -Get all receipts. - -### get_receipts_migrated_at - -```python -def get_receipts_migrated_at(milestone_index) -``` - -Get the receipts by the given milestone index. - -### get_treasury - -```python -def get_treasury() -``` - -Get the treasury output. - -### get_included_block - -```python -def get_included_block(transaction_id) -``` - -Returns the included block of the transaction. - -### get_included_block_metadata - -```python -def get_included_block_metadata(transaction_id) -``` - -Returns the metadata of the included block of the transaction. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/node_indexer_api.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/node_indexer_api.md deleted file mode 100644 index f48d95d4a6e..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/node_indexer_api.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_label: node_indexer_api -title: iota_client.node_indexer_api ---- - -## NodeIndexerAPI Objects - -```python -class NodeIndexerAPI(BaseAPI) -``` - -### basic_output_ids - -```python -def basic_output_ids(query_parameters) -``` - -Fetch basic output IDs. - -### alias_output_ids - -```python -def alias_output_ids(query_parameters) -``` - -Fetch alias output IDs. - -### alias_output_id - -```python -def alias_output_id(alias_id) -``` - -Fetch alias output ID. - -### nft_output_ids - -```python -def nft_output_ids(query_parameters) -``` - -Fetch NFT output IDs. - -### nft_output_id - -```python -def nft_output_id(nft_id) -``` - -Fetch NFT output ID. - -### foundry_output_ids - -```python -def foundry_output_ids(query_parameters) -``` - -Fetch foundry Output IDs. - -### foundry_output_id - -```python -def foundry_output_id(foundry_id) -``` - -Fetch foundry Output ID. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/secret_manager.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/secret_manager.md deleted file mode 100644 index 0d63c7ce0d8..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/secret_manager.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_label: secret_manager -title: iota_client.secret_manager ---- - -## LedgerNanoSecretManager Objects - -```python -class LedgerNanoSecretManager(dict) -``` - -Secret manager that uses a Ledger Nano hardware wallet or Speculos simulator. - -### \_\_init\_\_ - -```python -def __init__(is_simulator) -``` - -Initialize a ledger nano secret manager. - -## MnemonicSecretManager Objects - -```python -class MnemonicSecretManager(dict) -``` - -Secret manager that uses a mnemonic in plain memory. It's not recommended for production use. Use LedgerNano or Stronghold instead. - -### \_\_init\_\_ - -```python -def __init__(mnemonic) -``` - -Initialize a mnemonic secret manager. - -## SeedSecretManager Objects - -```python -class SeedSecretManager(dict) -``` - -### \_\_init\_\_ - -```python -def __init__(seed) -``` - -Initialize a seed secret manager. - -## StrongholdSecretManager Objects - -```python -class StrongholdSecretManager(dict) -``` - -Secret manager that uses Stronghold. - -### \_\_init\_\_ - -```python -def __init__(snapshot_path, password) -``` - -Initialize a stronghold secret manager. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/utils.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/utils.md deleted file mode 100644 index 355783d9a8f..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/iota_client/utils.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -sidebar_label: utils -title: iota_client.utils ---- - -## Utils Objects - -```python -class Utils(BaseAPI) -``` - -### bech32_to_hex - -```python -def bech32_to_hex(bech32) -``` - -Transforms bech32 to hex. - -### hex_to_bech32 - -```python -def hex_to_bech32(hex, bech32_hrp) -``` - -Transforms a hex encoded address to a bech32 encoded address. - -### alias_id_to_bech32 - -```python -def alias_id_to_bech32(alias_id, bech32_hrp) -``` - -Transforms an alias id to a bech32 encoded address. - -### nft_id_to_bech32 - -```python -def nft_id_to_bech32(nft_id, bech32_hrp) -``` - -Transforms an nft id to a bech32 encoded address. - -### hex_public_key_to_bech32_address - -```python -def hex_public_key_to_bech32_address(hex, bech32_hrp=None) -``` - -Transforms a hex encoded public key to a bech32 encoded address. - -### parse_bech32_address - -```python -def parse_bech32_address(address) -``` - -Returns a valid Address parsed from a String. - -### is_address_valid - -```python -def is_address_valid(address) -``` - -Checks if a String is a valid bech32 encoded address. - -### generate_mnemonic - -```python -def generate_mnemonic() -``` - -Generates a new mnemonic. - -### mnemonic_to_hex_seed - -```python -def mnemonic_to_hex_seed(mnemonic) -``` - -Returns a hex encoded seed for a mnemonic. - -### compute_alias_id - -```python -def compute_alias_id(output_id) -``` - -Computes the alias id for the given alias output id. - -### compute_nft_id - -```python -def compute_nft_id(output_id) -``` - -Computes the NFT id for the given NFT output id. - -### compute_foundry_id - -```python -def compute_foundry_id(alias_address, serial_number, token_scheme_kind) -``` - -Computes the foundry id. - -### block_id - -```python -def block_id(block) -``` - -Returns a block ID (Blake2b256 hash of block bytes) from a block. - -### hash_transaction_essence - -```python -def hash_transaction_essence(essence) -``` - -Compute the hash of a transaction essence. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/sidebar.json b/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/sidebar.json deleted file mode 100644 index cb0d55f21bc..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/python/references/sidebar.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "items": [ - { - "items": [ - "references/iota_client/high_level_api", - "references/iota_client/node_core_api", - "references/iota_client/node_indexer_api", - "references/iota_client/utils", - "references/iota_client/client", - "references/iota_client/common", - "references/iota_client/secret_manager" - ], - "label": "iota_client", - "type": "category" - } - ], - "label": "Reference", - "type": "category" -} diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/api_reference.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/api_reference.md deleted file mode 100644 index e2db810afc0..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/api_reference.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -description: Official IOTA Client Library Rust API reference. -image: /img/logo/iota_mark_light.png -keywords: - - api - - rust - - cargo - - crate ---- - -# API Reference - -API reference - -You can read the [API reference](https://docs.rs/iota-client) here, or generate it yourself. - -If you'd like to explore the implementation in more depth, the following command generates docs for the whole crate, including private modules: - -```bash -cargo doc --document-private-items --no-deps --open -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_01_get_node_info/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_01_get_node_info/_code_sample.mdx deleted file mode 100644 index b115c8d7f7e..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_01_get_node_info/_code_sample.mdx +++ /dev/null @@ -1,17 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```rust reference -https://github.com/iotaledger/iota.rs/tree/develop/client/examples/node_api_core/02_get_info.rs -``` - -### Run the Example - -Run the example by running the following command: - -```bash -cargo run --example node_api_core_get_info --release -- https://api.testnet.shimmer.network -``` - -- You can replace `https://api.testnet.shimmer.network` with any node url. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_01_get_node_info/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_01_get_node_info/_expected_output.md deleted file mode 100644 index 934d7689a96..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_01_get_node_info/_expected_output.md +++ /dev/null @@ -1,55 +0,0 @@ -```json -NodeInfoWrapper { - node_info: InfoResponse { - name: "HORNET", - version: "2.0.0-beta.5", - status: StatusResponse { - is_healthy: true, - latest_milestone: LatestMilestoneResponse { - index: 746869, - timestamp: 1661868434, - milestone_id: "0xbab289ebb1fdcc8516772074c3c465aaad648f234a4c1ff138f16c65a88b1298", - }, - confirmed_milestone: ConfirmedMilestoneResponse { - index: 746869, - timestamp: 1661868434, - milestone_id: "0xbab289ebb1fdcc8516772074c3c465aaad648f234a4c1ff138f16c65a88b1298", - }, - pruning_index: 0, - }, - supported_protocol_versions: [ - 2, - ], - protocol: ProtocolResponse { - version: 2, - network_name: "testnet-1", - bech32_hrp: "rms", - min_pow_score: 1500.0, - rent_structure: RentStructureResponse { - v_byte_cost: 100, - v_byte_factor_key: 10, - v_byte_factor_data: 1, - }, - token_supply: "1450896407249092", - }, - pending_protocol_parameters: [], - base_token: BaseTokenResponse { - name: "Shimmer", - ticker_symbol: "SMR", - unit: "SMR", - subunit: Some( - "glow", - ), - decimals: 6, - use_metric_prefix: false, - }, - metrics: MetricsResponse { - blocks_per_second: 8.4, - referenced_blocks_per_second: 9.2, - referenced_rate: 109.52380952380952, - }, - features: [], - }, - url: "https://api.testnet.shimmer.network", -} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_01_get_node_info/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_01_get_node_info/_key_api_ref_links.md deleted file mode 100644 index 3ede3a7651d..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_01_get_node_info/_key_api_ref_links.md +++ /dev/null @@ -1,24 +0,0 @@ -### Build a `Client` - -You can build a client using -the [`Client::builder`](https://docs.rs/iota-client/latest/iota_client/builder/struct.ClientBuilder.html) -structure. - -#### Chaining calls - -The code example chains the following calls to the `Client::builder`: - -- [`ClientBuilder.with_node(self, url)`](https://docs.rs/iota-client/latest/iota_client/builder/struct.ClientBuilder.html#method.with_node): - This call will add an IOTA node by URL. -- [`ClientBuilder.with_ignore_node_health(self)`](https://docs.rs/iota-client/latest/iota_client/builder/struct.ClientBuilder.html#method.with_ignore_node_health): - This call will ignore the node health status. As every node will be considered healthy, you should not use this call - in a production setting. -- [`ClientBuilder.finish(self)`](https://docs.rs/iota-client/latest/iota_client/builder/struct.ClientBuilder.html#method.finish): - This call will tell the `ClientBuilder` that you have already chained all the calls you need, and it should return - the [Client](https://docs.rs/iota-client/latest/iota_client/client/index.html) instance. - -### Use the `Client` - -After you have [built the client](#build-a-client), you can use it to get the node's information. The code example uses -the [`Client.get_info(&self)`](https://docs.rs/iota-client/latest/iota_client/client/struct.Client.html#method.get_info) -function which will target the `/api/v2/info` endpoint and return the node's information if successful. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_02_generate_mnemonic/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_02_generate_mnemonic/_code_sample.mdx deleted file mode 100644 index 6d5e2eb3ef0..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_02_generate_mnemonic/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```rust reference -https://github.com/iotaledger/iota.rs/tree/develop/client/examples/00_generate_mnemonic.rs -``` - -Run the example by running the following command: - -```bash -cargo run --example generate_mnemonic --release -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_02_generate_mnemonic/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_02_generate_mnemonic/_expected_output.md deleted file mode 100644 index 0d0490dc64a..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_02_generate_mnemonic/_expected_output.md +++ /dev/null @@ -1,3 +0,0 @@ -```plaintext -Mnemonic: glance zoo dove legend razor season evoke twenty flush solution essence destroy loud traffic friend decorate emotion total borrow expect actor switch shock zer -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_02_generate_mnemonic/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_02_generate_mnemonic/_key_api_ref_links.md deleted file mode 100644 index 5271275ac44..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_02_generate_mnemonic/_key_api_ref_links.md +++ /dev/null @@ -1,5 +0,0 @@ -### Generate the Mnemonic - -You can generate a mnemonic by calling -the [`Client::generate_mnemonic()`](https://docs.rs/iota-client/latest/iota_client/client/struct.Client.html#method.generate_mnemonic) -function. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_03_generate_addresses/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_03_generate_addresses/_code_sample.mdx deleted file mode 100644 index 1092519dfdd..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_03_generate_addresses/_code_sample.mdx +++ /dev/null @@ -1,17 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```rust reference -https://github.com/iotaledger/iota.rs/tree/develop/client/examples/01_generate_addresses.rs -``` - -### Run the Example - -Run the example by running the following command: - -```bash -cargo run --example generate_addresses --release -- https://api.testnet.shimmer.network -``` - -- You can replace `https://api.testnet.shimmer.network` with any node url. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_03_generate_addresses/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_03_generate_addresses/_expected_output.md deleted file mode 100644 index 01fa22bdbf5..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_03_generate_addresses/_expected_output.md +++ /dev/null @@ -1,49 +0,0 @@ -```plaintext -List of generated public addresses: -[ - "rms1qpllaj0pyveqfkwxmnngz2c488hfdtmfrj3wfkgxtk4gtyrax0jaxzt70zy", - "rms1qzzk86qv30l4e85ljtccxa0ruy8y7u8zn2dle3g8dv2tl2m4cu227a7n2wj", - "rms1qqjrtmslm36l3lyd8086w9qdxd9mudu2z2qyywlltpycn2ftxsdmu9ulj47", - "rms1qzz75j5h7vd5melxwersz49jja36m2vvnawedu0l6rlhg70ylzqp52lx8zf", - "rms1qzvs2rvq5ef79vhuel354mnvzfz049gyyf808zmjculuatt56u92vc4v4p3", - "rms1qpk0dj5lmv5r8d64f3x0qwx3jccredwa42xscdreqma73f3dxymaqdy645t", - "rms1qqlp6nurrz459jvvvuhv6t965v6cmlata57kf6auv6955uyp77uyw0egzgn", - "rms1qq2tu523zqzjxgdl69au8a9yewmd9ztctssv40dsv7lfd0tp36w4xdfzcyr", - "rms1qpw904c253cc9yn2dkhxx89u6r5j9vzezfatchrlugrkcvvhed3hckx6h2u", - "rms1qpa646cegkqsx9eht793nmux2vjwa63jrenqe87xq8j5wysfhu4l28k4ep9", - "rms1qq02yzamyu2z4rflv48cpt86kclcqr0rkxx748cf7l08l75gwtlcw54udc6", - "rms1qpulq7ldsux06s92n33pwk92mmllw07lqkkdfy5g9td0v2thhx2wxmd4lec", - "rms1qr0wl256lkfj7gdy8x5hqpvyrwtx98flyns3l7aehheg5c04kxj0cwy9eff", - "rms1qq8mmsdwrt809wl6dgn2rmt7ak6082enmnqapy59xfqtyenrwsxtghxgmch", - "rms1qqj7667kh0fmykdc65kwad5mvhhv9sxe8kdj0wenp6nwwnf0qkdwk7v07vu", - "rms1qpcwqlmu2n42fvht7fufztdg2k4hhtwzzrhsvucktrhk6mlr3cpvk7q75pf", - "rms1qppssdyxxsfa3c2ln47ccxryh68w3jret6zx6v9r43ptr4n7fks9g3l4eup", - "rms1qrkq9nv9uhafnduvfgtmru99532yhqpmqugf9x9x90ptzpceujkwgj2yaj4", - "rms1qptssvmyhfas223m542ayqagn06urq8v0yad770fxsj3grftqe4jzq3sh6m", - "rms1qr98trzs2snaeawklxnrpe3a3hahvkeydqdt3s6hps36lp8uxfzlcfx0pj6", -] - -List of generated public addresses: -[ - "rms1qpllaj0pyveqfkwxmnngz2c488hfdtmfrj3wfkgxtk4gtyrax0jaxzt70zy", - "rms1qzzk86qv30l4e85ljtccxa0ruy8y7u8zn2dle3g8dv2tl2m4cu227a7n2wj", - "rms1qqjrtmslm36l3lyd8086w9qdxd9mudu2z2qyywlltpycn2ftxsdmu9ulj47", - "rms1qzz75j5h7vd5melxwersz49jja36m2vvnawedu0l6rlhg70ylzqp52lx8zf", -] - -List of generated internal addresses: -[ - "rms1qp6w3v03qwtwkh52avtdvejpdqp8yfpk4z94m5dg3evuzu9hynyucvmxd59", - "rms1qqv993w400a6j7darw3v5h6tevk7qx534lr8tcu47zdrazhz0z2zstmj4da", - "rms1qzelrg0560t52g2wjpkyyesfg7wzcm8wa89akf6eux88xtupjaqazsw7jyy", - "rms1qp385r3f8k64cphft8lde9emrqarfwshnlwdnguw3qr62q32dmx6wt8e0sv", -] - -List of offline generated public addresses: -[ - "rms1qpllaj0pyveqfkwxmnngz2c488hfdtmfrj3wfkgxtk4gtyrax0jaxzt70zy", - "rms1qzzk86qv30l4e85ljtccxa0ruy8y7u8zn2dle3g8dv2tl2m4cu227a7n2wj", - "rms1qqjrtmslm36l3lyd8086w9qdxd9mudu2z2qyywlltpycn2ftxsdmu9ulj47", - "rms1qzz75j5h7vd5melxwersz49jja36m2vvnawedu0l6rlhg70ylzqp52lx8zf", -] -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_03_generate_addresses/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_03_generate_addresses/_key_api_ref_links.md deleted file mode 100644 index 6eed3e9bebd..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_03_generate_addresses/_key_api_ref_links.md +++ /dev/null @@ -1,38 +0,0 @@ -:::danger - -This example uses a mnemonic stored within the `.env` file. This is not safe, so you should not use this in a production -environment. - -::: - -### Generate the Address - -You can generate an address from a [mnemonic](../../../../how_tos/02_generate_mnemonic.mdx) by calling -the [`Client.get_addresses(self, SecretManager)`](iota_client/client/struct.Client.html#method.get_addresses) -function. If successful, the function will return a list of addresses from the secret manager. - -#### Use a `SecretManager` - -You should not pass the mnemonic as plaintext. Instead, you should create -a [`SecretManager`](iota_client/secret/enum.SecretManager.html) instance and pass that to the -`Client.get_addresses(self, SecretManager)` function. - -#### Chaining Calls - -You can customize the address by chaining calls to the `Client.get_addresses(self, SecretManager)` function. - -##### with_bech32_hrp - -You can set the human-readable part of the Bech32 by chaining a call -to [with_bech32_hrp(self, bech32_hrp)](iota_client/api/address/struct.GetAddressesBuilder.html#method.with_bech32_hrp) - -##### with_account_index - -You can set the account index by chaining a call -to [with_bech32_hrp(self, account_index)](iota_client/api/address/struct.GetAddressesBuilder.html#method.with_account_index) -. - -##### with_range - -You can set the account builder range by chaining a call -to [with_range(self, range)](iota_client/api/address/struct.GetAddressesBuilder.html#method.with_range). diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_04_get_output/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_04_get_output/_code_sample.mdx deleted file mode 100644 index 1df11e770d0..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_04_get_output/_code_sample.mdx +++ /dev/null @@ -1,14 +0,0 @@ -```rust reference -https://github.com/iotaledger/iota.rs/tree/develop/client/examples/node_api_core/09_get_output.rs -``` - -### Run the Example - -Run the example by running the following command: - -```bash -cargo run --example node_api_core_get_output --release -- https://api.testnet.shimmer.network 0x1e857d380f813d8035e487b6dfd2ff4740b6775273ba1b576f01381ba2a1a44c -``` - -- You can replace `https://api.testnet.shimmer.network` with any node url. -- You can replace `0x1e857d380f813d8035e487b6dfd2ff4740b6775273ba1b576f01381ba2a1a44c` with any other OutputID. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_04_get_output/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_04_get_output/_expected_output.md deleted file mode 100644 index e14fa5142be..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_04_get_output/_expected_output.md +++ /dev/null @@ -1,92 +0,0 @@ -```json -OutputResponse { - metadata: OutputMetadataResponse { - block_id: "0xa9f11aba1e9965173dc21a47ec4fbfe5b953a6e60277857a3f7a5c1499e7c454", - transaction_id: "0x1e857d380f813d8035e487b6dfd2ff4740b6775273ba1b576f01381ba2a1a44c", - output_index: 0, - is_spent: true, - milestone_index_spent: Some( - 249147, - ), - milestone_timestamp_spent: Some( - 1659379781, - ), - transaction_id_spent: Some( - "0xa927ea21d3c4a49d5c73169c80302ddb223894c182a4b7cfef0af89568262749", - ), - milestone_index_booked: 249145, - milestone_timestamp_booked: 1659379771, - ledger_index: 918846, - }, - output: Alias( - AliasOutputDto { - kind: 4, - amount: "2000000", - native_tokens: [], - alias_id: AliasIdDto( - "0x0000000000000000000000000000000000000000000000000000000000000000", - ), - state_index: 0, - state_metadata: "", - foundry_counter: 0, - unlock_conditions: [ - StateControllerAddress( - StateControllerAddressUnlockConditionDto { - kind: 4, - address: Ed25519( - Ed25519AddressDto { - kind: 0, - pub_key_hash: "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3", - }, - ), - }, - ), - GovernorAddress( - GovernorAddressUnlockConditionDto { - kind: 5, - address: Ed25519( - Ed25519AddressDto { - kind: 0, - pub_key_hash: "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3", - }, - ), - }, - ), - ], - features: [ - Sender( - SenderFeatureDto { - kind: 0, - address: Ed25519( - Ed25519AddressDto { - kind: 0, - pub_key_hash: "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3", - }, - ), - }, - ), - Metadata( - MetadataFeatureDto { - kind: 2, - data: "0x010203", - }, - ), - ], - immutable_features: [ - Issuer( - IssuerFeatureDto { - kind: 1, - address: Ed25519( - Ed25519AddressDto { - kind: 0, - pub_key_hash: "0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3", - }, - ), - }, - ), - ], - }, - ), -} - -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_04_get_output/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_04_get_output/_key_api_ref_links.md deleted file mode 100644 index c94f97d96cb..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_04_get_output/_key_api_ref_links.md +++ /dev/null @@ -1,10 +0,0 @@ -## Get an Output by ID - -You can retrieve any output using its `outputId` (transaction id + output index) by calling -the [`Client.get_output(output_id)`](.iota_client/client/struct.Client.html#method.get_output) function and providing a -valid output ID. - -If the function is successful, it will return an `OutputResponse` with the block's metadata and the -output object. - -This function call will target the `GET /api/core/v2/outputs/{outputId}` endpoint. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_05_build_output/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_05_build_output/_code_sample.mdx deleted file mode 100644 index 378b0c9501a..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_05_build_output/_code_sample.mdx +++ /dev/null @@ -1,15 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```rust reference -https://github.com/iotaledger/iota.rs/tree/develop/client/examples/output/basic.rs -``` - -### Run the Example - -Run the example by running the following command: - -```bash -cargo run --example basic --release -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_05_build_output/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_05_build_output/_expected_output.md deleted file mode 100644 index 01dc74d76da..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_05_build_output/_expected_output.md +++ /dev/null @@ -1,139 +0,0 @@ -```plaintext -[ - Basic( - BasicOutput { - amount: 1000000, - native_tokens: NativeTokens( - BoxedSlicePrefix([]), - ), - unlock_conditions: UnlockConditions( - BoxedSlicePrefix([ - Address( - AddressUnlockCondition( - Ed25519( - Ed25519Address(0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3), - ), - ), - ), - ]), - ), - features: Features( - BoxedSlicePrefix([]), - ), - }, - ), - Basic( - BasicOutput { - amount: 1000000, - native_tokens: NativeTokens( - BoxedSlicePrefix([]), - ), - unlock_conditions: UnlockConditions( - BoxedSlicePrefix([ - Address( - AddressUnlockCondition( - Ed25519( - Ed25519Address(0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3), - ), - ), - ), - ]), - ), - features: Features( - BoxedSlicePrefix([ - Metadata( - MetadataFeature(0x48656c6c6f2c20576f726c6421), - ), - ]), - ), - }, - ), - Basic( - BasicOutput { - amount: 1000000, - native_tokens: NativeTokens( - BoxedSlicePrefix([]), - ), - unlock_conditions: UnlockConditions( - BoxedSlicePrefix([ - Address( - AddressUnlockCondition( - Ed25519( - Ed25519Address(0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3), - ), - ), - ), - StorageDepositReturn( - StorageDepositReturnUnlockCondition { - return_address: Ed25519( - Ed25519Address(0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3), - ), - amount: 1000000, - }, - ), - ]), - ), - features: Features( - BoxedSlicePrefix([]), - ), - }, - ), - Basic( - BasicOutput { - amount: 1000000, - native_tokens: NativeTokens( - BoxedSlicePrefix([]), - ), - unlock_conditions: UnlockConditions( - BoxedSlicePrefix([ - Address( - AddressUnlockCondition( - Ed25519( - Ed25519Address(0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3), - ), - ), - ), - Expiration( - ExpirationUnlockCondition { - return_address: Ed25519( - Ed25519Address(0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3), - ), - timestamp: 1, - }, - ), - ]), - ), - features: Features( - BoxedSlicePrefix([]), - ), - }, - ), - Basic( - BasicOutput { - amount: 1000000, - native_tokens: NativeTokens( - BoxedSlicePrefix([]), - ), - unlock_conditions: UnlockConditions( - BoxedSlicePrefix([ - Address( - AddressUnlockCondition( - Ed25519( - Ed25519Address(0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3), - ), - ), - ), - Timelock( - TimelockUnlockCondition( - 1, - ), - ), - ]), - ), - features: Features( - BoxedSlicePrefix([]), - ), - }, - ), -] -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_06_get_address_balances/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_06_get_address_balances/_code_sample.mdx deleted file mode 100644 index 32f7b6f2b23..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_06_get_address_balances/_code_sample.mdx +++ /dev/null @@ -1,15 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```rust reference -https://github.com/iotaledger/iota.rs/tree/develop/client/examples/02_get_address_balance.rs -``` - -### Run the Example - -Run the example by running the following command: - -```bash -cargo run --example 02_get_address_balance --release -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_06_get_address_balances/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_06_get_address_balances/_expected_output.md deleted file mode 100644 index 6682252cb28..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_06_get_address_balances/_expected_output.md +++ /dev/null @@ -1,25 +0,0 @@ -```plaintext -Outputs controlled by rms1qpllaj0pyveqfkwxmnngz2c488hfdtmfrj3wfkgxtk4gtyrax0jaxzt70zy -have: 2609275800i and nativetokens: [ - NativeToken{ - token_id: TokenId(0x085c6b799750bdf7e5a5c81144465a0676bc11dab74b997444ca369949341720e80100000000), - amount: 100 - }, - NativeToken{ - token_id: TokenId(0x0822ceb3166ad125d310e6660f5fc292356f87f2f9566e982ea22154cec3847b3f0100000000), - amount: 100 - }, - NativeToken{ - token_id: TokenId(0x08f708a29e9619e847916de76c2e167e87a704c235dcbd7cda018865be7f561b5a0100000000), - amount: 50 - }, - NativeToken{ - token_id: TokenId(0x0808fb702d67fdb320b5959f152c0f962630515d904c71ed09447c341a6cc171de0100000000), - amount: 100 - }, - NativeToken{ - token_id: TokenId(0x08f1802858831220b282ccc4c557676d61f79833869de378ce9a81f736976ce39f0100000000), - amount: 50 - } -] -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_06_get_address_balances/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_06_get_address_balances/_key_api_ref_links.md deleted file mode 100644 index efd2cd6bef5..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_06_get_address_balances/_key_api_ref_links.md +++ /dev/null @@ -1,32 +0,0 @@ -### `Client.basic_output_ids(query_parameters)` - -You can retrieve outputs from any given address using the [`Client.basic_output_ids(query_parameters)`](iota_client/client/struct.Client.html#method.basic_output_ids) -function. - -This function will query the `api/indexer/v1/outputs/basic` endpoint. - -#### `query_parameters` - -You should pass the [QueryParameters](ota_client/node_api/indexer/query_parameters/enum.QueryParameter.html) as an array -of objects. The following objects are used in the example: - -##### address - -The Bech32-encoded address that should be searched for. - -##### hasExpiration - -Indicates if the outputs should have an expiration unlock condition or not. - -##### hasTimeLock - -Indicates if the outputs should have a time-locked unlock condition or not. - -##### hasStorageDepositReturn - -Indicates if the outputs should have storage deposit return unlock condition or not. - -### `Client.get_outputs(output_ids)` - -The [`Client.get_outputs(output_ids)`](iota_client/client/struct.Client.html#method.get_outputs) will query the node for a list -of `output_ids` in parallel. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_07_create_block/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_07_create_block/_code_sample.mdx deleted file mode 100644 index afe38c063d6..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_07_create_block/_code_sample.mdx +++ /dev/null @@ -1,15 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```rust reference -https://github.com/iotaledger/iota.rs/tree/develop/client/examples/block/00_block_no_payload.rs -``` - -### Run the Example - -Run the example by running the following command: - -```bash -cargo run --example simple_block --release -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_07_create_block/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_07_create_block/_expected_output.md deleted file mode 100644 index 0081569b186..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_07_create_block/_expected_output.md +++ /dev/null @@ -1,18 +0,0 @@ -```plaintext -Block { - protocol_version: 2, - parents: Parents( - BoxedSlicePrefix([ - BlockId(0x2f68b25006f0e1b55ada3e9278e69796380971e97587c233d138c593139d255d), - BlockId(0x76d25ac0073d14381d9a38c61ecb9665241d771bd89564e467c7fdf98e770ddd), - BlockId(0xd072addb86a5a59a69b17d0e8fc3368771dc5ea7f7c2257045e508ae37f27a46), - BlockId(0xfea2e90318a1b234569a3d698e97906d2c6a0084eb571971bf9ce9c4d31ee6c9), - ]), - ), - payload: OptionalPayload( - None, - ), - nonce: 4420, -} -Block with no payload sent: https://explorer.shimmer.network/testnet/block/0x9f794dde42c7be9cd209cc992f69e1f8b7b40578303825049079d8ac128aa20f -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_07_create_block/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_07_create_block/_key_api_ref_links.md deleted file mode 100644 index 194e4be75a7..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_07_create_block/_key_api_ref_links.md +++ /dev/null @@ -1,8 +0,0 @@ -### `Client.block(&self)` - -You can create a simple empty block by calling -the [`Client.block(&self)`](iota_client/client/struct.Client.html#method.block) -function. - -If successful, the function will return -a [`ClientBlockBuilder`](iota_client/api/block_builder/struct.ClientBlockBuilder.html). diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_08_post_block/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_08_post_block/_code_sample.mdx deleted file mode 100644 index ef0b4d9a96a..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_08_post_block/_code_sample.mdx +++ /dev/null @@ -1,17 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```rust reference -https://github.com/iotaledger/iota.rs/tree/develop/client/examples/node_api_core/04_post_block.rs -``` - -### Run the Example - -Run the example by running the following command: - -```bash -cargo run --example node_api_core_post_block --release -- https://api.testnet.shimmer.network -``` - -- You can replace `https://api.testnet.shimmer.network` with any node url. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_08_post_block/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_08_post_block/_expected_output.md deleted file mode 100644 index a31a5d57c46..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_08_post_block/_expected_output.md +++ /dev/null @@ -1,3 +0,0 @@ -```plaintext -Posted: BlockId(0x2f1de84a2977afeb413d44d8069c67e2df3f8da9ee6ba9dd62190e5256469169) -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_08_post_block/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_08_post_block/_key_api_ref_links.md deleted file mode 100644 index 9d3580b0e39..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_08_post_block/_key_api_ref_links.md +++ /dev/null @@ -1,9 +0,0 @@ -### `Client.post_block(block)` - -You can post a block in JSON format using -the [`Client.post_block(block)`](./../libraries/nodejs/references/classes/Client#getblock) -function. - -If successful, the function will return the ID of the submitted block. - -This function queries the `POST JSON to /api/core/v2/blocks` endpoint. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_08_post_raw_block/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_08_post_raw_block/_code_sample.mdx deleted file mode 100644 index b8c5b5cab02..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_08_post_raw_block/_code_sample.mdx +++ /dev/null @@ -1,17 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```rust reference -https://github.com/iotaledger/iota.rs/tree/develop/client/examples/node_api_core/05_post_block_raw.rs -``` - -### Run the Example - -Run the example by running the following command: - -```bash -cargo run --example node_api_core_post_block_raw --release -- https://api.testnet.shimmer.network -``` - -- You can replace `https://api.testnet.shimmer.network` with any node url. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_08_post_raw_block/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_08_post_raw_block/_expected_output.md deleted file mode 100644 index 4cba4c16077..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_08_post_raw_block/_expected_output.md +++ /dev/null @@ -1,3 +0,0 @@ -```plaintext -Posted: BlockId(0x9982248af2d1b41f5f9f5b439d113ebe9611b6ace17ae487f2b3104b00b9950e) -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_08_post_raw_block/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_08_post_raw_block/_key_api_ref_links.md deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_09_get_block/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_09_get_block/_code_sample.mdx deleted file mode 100644 index 99cd676341a..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_09_get_block/_code_sample.mdx +++ /dev/null @@ -1,18 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```rust reference -https://github.com/iotaledger/iota.rs/tree/develop/client/examples/node_api_core/06_get_block.rs -``` - -### Run the Example - -Run the example by running the following command: - -```bash -cargo run --example node_api_core_get_block --release -- https://api.testnet.shimmer.network 0xa9f11aba1e9965173dc21a47ec4fbfe5b953a6e60277857a3f7a5c1499e7c454 -``` - -- You can replace `https://api.testnet.shimmer.network` with any node url. -- You can replace `0x78680faa5ee34d77399ad7eff5fec9b9ceb99fea86822a16f57f49aa69771ee5` with any other Block ID. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_09_get_block/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_09_get_block/_expected_output.md deleted file mode 100644 index 3da56f8683f..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_09_get_block/_expected_output.md +++ /dev/null @@ -1,159 +0,0 @@ -```json -Block { - protocol_version: 2, - parents: Parents( - BoxedSlicePrefix([ - BlockId(0x2ec007718ebd1f8dd10be36c76820321fd24fd1739a52a7176f3314f1158ea44), - BlockId(0x536f8b2beba143278bda5074a311c827ef37c5756d80ea90372b2688b92cd5ae), - BlockId(0x6b6bcad97ba4f8d6f75aeea1dfc945425d2d6ead793af302dd5040590f5e409d), - BlockId(0xcff2436f2d65438c7351946fe793af3a8f059b485250d0ee2c5875d0aed71884), - ]), - ), - payload: OptionalPayload( - Some( - Transaction( - TransactionPayload { - essence: Regular( - RegularTransactionEssence { - network_id: 1856588631910923207, - inputs: BoxedSlicePrefix([ - Utxo( - UtxoInput(0xcb664cb88dcb4182df622fb82661e2d82e81ff95f3f04d5f3b071484a10fdc490100), - ), - Utxo( - UtxoInput(0xeede6413d25f1cb1fc68187cda339ec22e66e4fb945b8397c7251d46164a0c495900), - ), - Utxo( - UtxoInput(0x45a6247d6af3214828fcab1206f6b6c8e61a359fec821d48cb578b3f70a291a40000), - ), - Utxo( - UtxoInput(0x71638c38cf0be640f082edf9b1a9dc1ea898932762ede49b164f0894826009703b00), - ), - ]), - inputs_commitment: InputsCommitment(0x10cb15a61c30e10e569f10513834d5fd0ee53049a77223ccf43a921ea22e1675), - outputs: BoxedSlicePrefix([ - Alias( - AliasOutput { - amount: BoundedU64( - 53700, - ), - native_tokens: NativeTokens( - BoxedSlicePrefix([]), - ), - alias_id: AliasId(0x0000000000000000000000000000000000000000000000000000000000000000), - state_index: 0, - state_metadata: BoxedSlicePrefix([]), - foundry_counter: 0, - unlock_conditions: UnlockConditions( - BoxedSlicePrefix([ - StateControllerAddress( - StateControllerAddressUnlockCondition( - Ed25519( - Ed25519Address(0x4f56285a1876d31b62f085c1bb35a85c0edc29889074631b81172991c3e4d6ff), - ), - ), - ), - GovernorAddress( - GovernorAddressUnlockCondition( - Ed25519( - Ed25519Address(0x4f56285a1876d31b62f085c1bb35a85c0edc29889074631b81172991c3e4d6ff), - ), - ), - ), - ]), - ), - features: Features( - BoxedSlicePrefix([]), - ), - immutable_features: Features( - BoxedSlicePrefix([ - Issuer( - IssuerFeature( - Ed25519( - Ed25519Address(0x4f56285a1876d31b62f085c1bb35a85c0edc29889074631b81172991c3e4d6ff), - ), - ), - ), - ]), - ), - }, - ), - Basic( - BasicOutput { - amount: BoundedU64( - 1000047500, - ), - native_tokens: NativeTokens( - BoxedSlicePrefix([]), - ), - unlock_conditions: UnlockConditions( - BoxedSlicePrefix([ - Address( - AddressUnlockCondition( - Ed25519( - Ed25519Address(0x4f56285a1876d31b62f085c1bb35a85c0edc29889074631b81172991c3e4d6ff), - ), - ), - ), - ]), - ), - features: Features( - BoxedSlicePrefix([]), - ), - }, - ), - ]), - payload: OptionalPayload( - Some( - TaggedData( - TaggedDataPayload { - tag: "0x484f524e4554205370616d6d65722053656d692d4c617a79", - data: "0x57652061726520616c6c206d616465206f662073746172647573742e0a436f756e743a203030353539320a54696d657374616d703a20323032322d30392d30315431343a32323a33345a0a54697073656c656374696f6e3a2031312e3832376d73", - }, - ), - ), - ), - }, - ), - unlocks: Unlocks( - BoxedSlicePrefix([ - Signature( - SignatureUnlock( - Ed25519( - Ed25519Signature { - public_key: 0x229172a3883abbeb5ff7e680a6a0a0f5c31bf222d48fd1747d9d0ead24155a6b, - signature: 0x354174e8f7981aa05eca6d936cd2c7bf0eb9e2954b1f550e683959eb412194f8edab0f8536c370e576eb812da434496749221c3b96b40d6d2c9de4c06d97030f, - }, - ), - ), - ), - Reference( - ReferenceUnlock( - BoundedU16( - 0, - ), - ), - ), - Reference( - ReferenceUnlock( - BoundedU16( - 0, - ), - ), - ), - Reference( - ReferenceUnlock( - BoundedU16( - 0, - ), - ), - ), - ]), - ), - }, - ), - ), - ), - nonce: 1785168781326821022, -} -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_09_get_block/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_09_get_block/_key_api_ref_links.md deleted file mode 100644 index 566eabed1ba..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_09_get_block/_key_api_ref_links.md +++ /dev/null @@ -1,19 +0,0 @@ -### `Client.get_block(blockId)` - -You can retrieve a block's data using its block ID using -the [`Client.get_block(&self, block_id: &BlockId)`](./../libraries/nodejs/references/classes/Client#getblock) -function. - -If successful, the function will return the block as JSON. - -This function queries the `GET /api/core/v2/blocks/{BlockId}` endpoint. - -### `Client.get_block(&self, block_id: &BlockId)` - -You can retrieve a block's metadata using its block ID using -the [``Client. get_block_metadata(&self, block_id: &BlockId)`](iota_client/client/struct.Client.html#method.get_block_metadata) -function. - -If successful, the function will return the block's metadata as JSON. - -This function queries the `GET /api/core/v2/blocks/{BlockId}/metadata` endpoint. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_10_prepare_signed_transaction/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_10_prepare_signed_transaction/_code_sample.mdx deleted file mode 100644 index 342c8bc7974..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_10_prepare_signed_transaction/_code_sample.mdx +++ /dev/null @@ -1,15 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```rust reference -https://github.com/iotaledger/iota.rs/tree/develop/client/examples/block/transaction.rs -``` - -### Run the Example - -Run the example by running the following command: - -```bash -cargo run --example transaction --release -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_10_prepare_signed_transaction/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_10_prepare_signed_transaction/_expected_output.md deleted file mode 100644 index 6a23d3434cd..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_10_prepare_signed_transaction/_expected_output.md +++ /dev/null @@ -1,3 +0,0 @@ -```plaintext -Transaction sent: https://explorer.shimmer.network/testnet/block/0x0e4c43eb9402aad8af70bbabfc4eb43ca4b603feb77d7bbcec43ccd06d9389bb -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_10_prepare_signed_transaction/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_10_prepare_signed_transaction/_key_api_ref_links.md deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_11_nft_output/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_11_nft_output/_code_sample.mdx deleted file mode 100644 index b765ff17d89..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_11_nft_output/_code_sample.mdx +++ /dev/null @@ -1,15 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```rust reference -https://github.com/iotaledger/iota.rs/tree/develop/client/examples/output/nft.rs -``` - -### Run the Example - -Run the example by running the following command: - -```bash -cargo run --example nft --release -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_11_nft_output/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_11_nft_output/_expected_output.md deleted file mode 100644 index 476325ad244..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_11_nft_output/_expected_output.md +++ /dev/null @@ -1,4 +0,0 @@ -```plaintext -Transaction with new NFT output sent: https://api.testnet.shimmer.network/api/core/v2/blocks/0xcfc8599956396ec01a0f4fed2f218f10f43876df28b3e9115d3695f99a536a4b -bech32_nft_address rms1zzke7q909dzj95v6nlcdlafz0ylc6dux5a2qwenq0xfuc9hcr8h76spvz3f -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_11_nft_output/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_11_nft_output/_key_api_ref_links.md deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_12_foundry_output/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_12_foundry_output/_code_sample.mdx deleted file mode 100644 index d3d389a78ad..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_12_foundry_output/_code_sample.mdx +++ /dev/null @@ -1,15 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```rust reference -https://github.com/iotaledger/iota.rs/tree/develop/client/examples/output/foundry.rs -``` - -### Run the Example - -Run the example by running the following command: - -```bash -cargo run --example foundry --release -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_12_foundry_output/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_12_foundry_output/_expected_output.md deleted file mode 100644 index bbcee18555f..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_12_foundry_output/_expected_output.md +++ /dev/null @@ -1,5 +0,0 @@ -```plaintext -Transaction with new alias output sent: https://api.testnet.shimmer.network/api/core/v2/blocks/0x6f10bd7234c7958992d9b0df269234f01afa96aecb6b5ed04f26786811640df7 -Transaction with foundry output sent: https://api.testnet.shimmer.network/api/core/v2/blocks/0xbcf2281c2557106426f7f622051ab8de233a430df48b38a826a863eeb9ee187e -Transaction with native tokens burnt sent: https://api.testnet.shimmer.network/api/core/v2/blocks/0x924a2385cddfffe1f46c1460160121b28c40a19e0e8011e04c7c2fe8d1d80ccd -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_12_foundry_output/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_12_foundry_output/_key_api_ref_links.md deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_13_alias_output/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_13_alias_output/_code_sample.mdx deleted file mode 100644 index 72b785d3827..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_13_alias_output/_code_sample.mdx +++ /dev/null @@ -1,15 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```rust reference -https://github.com/iotaledger/iota.rs/tree/develop/client/examples/output/alias.rs -``` - -### Run the Example - -Run the example by running the following command: - -```bash -cargo run --example alias --release -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_13_alias_output/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_13_alias_output/_expected_output.md deleted file mode 100644 index 350c2613b60..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_13_alias_output/_expected_output.md +++ /dev/null @@ -1,66 +0,0 @@ -```plaintext -Alias( - AliasOutput { - amount: 59200, - native_tokens: NativeTokens( - BoxedSlicePrefix([]), - ), - alias_id: AliasId(0x0000000000000000000000000000000000000000000000000000000000000000), - state_index: 0, - state_metadata: BoxedSlicePrefix([ - 104, - 101, - 108, - 108, - 111, - ]), - foundry_counter: 0, - unlock_conditions: UnlockConditions( - BoxedSlicePrefix([ - StateControllerAddress( - StateControllerAddressUnlockCondition( - Ed25519( - Ed25519Address(0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3), - ), - ), - ), - GovernorAddress( - GovernorAddressUnlockCondition( - Ed25519( - Ed25519Address(0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3), - ), - ), - ), - ]), - ), - features: Features( - BoxedSlicePrefix([ - Sender( - SenderFeature( - Ed25519( - Ed25519Address(0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3), - ), - ), - ), - Metadata( - MetadataFeature(0x68656c6c6f), - ), - ]), - ), - immutable_features: Features( - BoxedSlicePrefix([ - Issuer( - IssuerFeature( - Ed25519( - Ed25519Address(0x7ffec9e1233204d9c6dce6812b1539ee96af691ca2e4d9065daa85907d33e5d3), - ), - ), - ), - Metadata( - MetadataFeature(0x68656c6c6f), - ), - ]), - ), - }, -) -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_13_alias_output/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_13_alias_output/_key_api_ref_links.md deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_14_mqtt/_code_sample.mdx b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_14_mqtt/_code_sample.mdx deleted file mode 100644 index c55e6a6ad3e..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_14_mqtt/_code_sample.mdx +++ /dev/null @@ -1,15 +0,0 @@ -import DotEnvWarning from '../../../../_admonitions/_dot_env_warning.md'; - - - -```rust reference -https://github.com/iotaledger/iota.rs/tree/develop/client/examples/07_mqtt.rs -``` - -### Run the Example - -Run the example by running the following command: - -```bash -cargo run --example 07_mqtt --features=mqtt --release -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_14_mqtt/_expected_output.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_14_mqtt/_expected_output.md deleted file mode 100644 index c8af6513f33..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_14_mqtt/_expected_output.md +++ /dev/null @@ -1,78 +0,0 @@ -```json -Topic: blocksBlock{ - protocol_version: 2, - parents: Parents(BoxedSlicePrefix([ - BlockId(0x2c6217376977980929b5bd9f4fd33ee06a13dc5ed41a53ffa0d20eae77a0d3d9), - BlockId(0x3971dc26622ffef0d1cf5b6d2cbfa0732014dd3271d675158bf854100087475c), - BlockId(0x5bb64f36721d02b5ef314fd0a012ef1adf779592474dac88dd24d82550bf5242), - BlockId(0xc95cfe61e184ef1885a29f7832019840d999fa4baf452f6dbb127e2dc4c1d20f) - ])), - payload: OptionalPayload(Some(Transaction(TransactionPayload{ - essence: Regular(RegularTransactionEssence{ - network_id: 1856588631910923207, - inputs: BoxedSlicePrefix([ - Utxo(UtxoInput(0x8e7b59a567f0f439ef7d3b01de094ce2f81aa8e68e09f26705dfd1d39ddf471b0000)), - Utxo(UtxoInput(0x60e8afa096f3705b6f1a694f5496d51721ea4b4e9876b219dfecdf99586949fd0100)), - Utxo(UtxoInput(0xf12c189790488ec61ce8c4d9d28ebbb7e82d322b25ec293e40fd4ef2dfe15e0d0000)), - Utxo(UtxoInput(0xd14bd0777e8ea7266a2af955126dde56ed692d9ad6b19508cfd614d4b3612a950000)), - Utxo(UtxoInput(0xf31d1bf2c93ff0578d72951471c0fda2be4efd4cfbb7a2bd03e04d64362ef6401b00)), - Utxo(UtxoInput(0xf34edd2df152ef473679ad468d6f942fadeca7004499576bba9a1a17927da3af7700)) - ]), - inputs_commitment: InputsCommitment(0x43448b345d2c0bc38ea6e4abd79726852a2880528a753a986deb13bf3f93af5b), - outputs: BoxedSlicePrefix([ - Nft(NftOutput{ - amount: BoundedU64(51000), - native_tokens: NativeTokens(BoxedSlicePrefix([ - - ])), - nft_id: NftId(0x0000000000000000000000000000000000000000000000000000000000000000), - unlock_conditions: UnlockConditions(BoxedSlicePrefix([ - Address(AddressUnlockCondition(Ed25519(Ed25519Address(0x56b1638c1bb2566e2150d4667f78a59ee0d9b9a6c1e6af4499c3d55c8fd77e01)))) - ])), - features: Features(BoxedSlicePrefix([ - - ])), - immutable_features: Features(BoxedSlicePrefix([ - Issuer(IssuerFeature(Ed25519(Ed25519Address(0x56b1638c1bb2566e2150d4667f78a59ee0d9b9a6c1e6af4499c3d55c8fd77e01)))), - Metadata(MetadataFeature(0x736f6d652d697066732d6c696e6b)) - ])) - }), - Basic(BasicOutput{ - amount: BoundedU64(1009003400), - native_tokens: NativeTokens(BoxedSlicePrefix([ - - ])), - unlock_conditions: UnlockConditions(BoxedSlicePrefix([ - Address(AddressUnlockCondition(Ed25519(Ed25519Address(0x56b1638c1bb2566e2150d4667f78a59ee0d9b9a6c1e6af4499c3d55c8fd77e01)))) - ])), - features: Features(BoxedSlicePrefix([ - - ])) - }) - ]), - payload: OptionalPayload(Some(TaggedData(TaggedDataPayload{ - tag: "0x484f524e4554205370616d6d65722053656d692d4c617a79", - data: "0x57652061726520616c6c206d616465206f662073746172647573742e0a436f756e743a203032353636380a54696d657374616d703a20323032322d30392d30325431343a30353a33355a0a54697073656c656374696f6e3a20313836c2b573" - }))) - }), - unlocks: Unlocks(BoxedSlicePrefix([ - Signature(SignatureUnlock(Ed25519(Ed25519Signature{ - public_key: 0x1eea893bc9fc06787b7e5d273cdb02e02f9a5cce9eb4e1dc513eec14e8d95047, - signature: 0xbaab2fd45c038a0661f896184aecd249c8169b4b08dda8965d7d99e3778828cbe69c95a6893115d83705887d20f85eef4d3f9d2d39e89d009649da66fdfffa0a - }))), - Reference(ReferenceUnlock(BoundedU16(0))), - Reference(ReferenceUnlock(BoundedU16(0))), - Reference(ReferenceUnlock(BoundedU16(0))), - Reference(ReferenceUnlock(BoundedU16(0))), - Reference(ReferenceUnlock(BoundedU16(0))) - ])) - }))), - nonce: 1785168781326745297 -} -Topic: milestone-info/latest{ - "index": 798690, - "milestoneId": "0xc405fa4839b32d78b1a7f27e297d07842aa83a8ced1e5b556e446317c7348be6", - "timestamp": 1662127539 -} -[...] -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_14_mqtt/_key_api_ref_links.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_14_mqtt/_key_api_ref_links.md deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_run_how_tos.md b/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_run_how_tos.md deleted file mode 100644 index 4fbd7d6b16e..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/libraries/rust/how_to/_run_how_tos.md +++ /dev/null @@ -1,49 +0,0 @@ -## Prerequisites - -Before you can run the examples, please refer to the [Rust Getting Started guide](./../../../getting_started/rust.mdx) to install -the library. - -### Clone the Repository - -To run the rust examples, you will first need to clone the repository. You can do so by running the following command: - -```bash -git clone git@github.com:iotaledger/iota.rs.git -``` - -### Set Up Your .env file - -After you have [cloned the project](#clone-the-repository), you should: - -1. Move into the project directory by running the following command: - -```bash -cd iota.rs -``` - -2. Create your `.env` file by making a copy of the `.env.example` file by running the following command: - -```bash -cp .env.example .env -``` - -## Run Code Examples - -The iota.rs library has numerous [examples](https://github.com/iotaledger/iota.rs/tree/develop/examples) -you can run to get acquainted with the library. After you have followed the instructions to -[install the library](./../../../getting_started/rust.mdx#install-the-library), you can run any example with the following -command from the `examples` directory: - -```bash -cargo run --example node_api_core_get_health --release -``` - -## Examples List - -You can replace the `node_api_core_get_health` by any other example from the [Rust examples directory](https://github.com/iotaledger/iota.rs/tree/dev/examples). - -You can get a full list of examples by running the following command: - -```bash -cargo run --example -``` diff --git a/docs/build/iota.rs/2.0-rc.7/docs/node_api_core.md b/docs/build/iota.rs/2.0-rc.7/docs/node_api_core.md deleted file mode 100644 index f9453dc2ffb..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/node_api_core.md +++ /dev/null @@ -1,523 +0,0 @@ -# `Client::get_health` - -## Description - -Calls `GET /health`. - -Returns the health of the node. - -## Request - -## Response - -## Example - -```rust -let health = client.get_health(&node).await?; -``` - -Run `cargo run --example node_api_core_get_health --release -- [NODE URL]`. - -# `Client::get_info` - -## Description - -Calls `GET /api/core/v2/info`. - -Returns general information about the node. - -## Request - -No parameters. - -## Response - -## Example - -```rust -let info = client.get_info().await?; -``` - -Run `cargo run --example node_api_core_get_info --release -- [NODE URL]`. - -# `Client::get_tips` - -## Description - -Calls `GET /api/core/v2/tips`. - -Returns tips that are ideal for attaching a block. - -## Request - -No parameters. - -## Response - -## Example - -```rust -let tips = client.get_tips().await?; -``` - -Run `cargo run --example node_api_core_get_tips --release -- [NODE URL]`. - -# `Client::post_block` - -## Description - -Calls `POST /api/core/v2/blocks`. - -Submits a block as a JSON payload. - -## Request - -## Response - -## Example - -```rust -let block_id = client.post_block(&block).await?; -``` - -Run `cargo run --example node_api_core_post_block --release -- [NODE URL]`. - -# `Client::post_block_raw` - -## Description - -Calls `POST /api/core/v2/blocks`. - -Submits a block as raw bytes. - -## Request - -## Response - -## Example - -```rust -let block_id = client.post_block_raw(&block).await?; -``` - -Run `cargo run --example node_api_core_post_block_raw --release -- [NODE URL]`. - -# `Client::get_block` - -## Description - -Calls `GET /api/core/v2/blocks/{blockId}`. - -Returns block data as JSON by its identifier. - -## Request - -## Response - -## Example - -```rust -let block = client.get_block(&block_id).await?; -``` - -Run `cargo run --example node_api_core_get_block --release -- [NODE URL]`. - -# `Client::get_block_raw` - -## Description - -Calls `GET /api/core/v2/blocks/{blockId}`. - -Returns block data as raw bytes by its identifier. - -## Request - -## Response - -## Example - -```rust -let block = client.get_block_raw(&block_id).await?; -``` - -Run `cargo run --example node_api_core_get_block_raw --release -- [NODE URL]`. - -# `Client::get_block_metadata` - -## Description - -Calls `GET /api/core/v2/blocks/{blockId}/metadata`. - -Finds the metadata of a given block. - -## Request - -## Response - -## Example - -```rust -let block_metadata = client.get_block_metadata(&block_id).await?; -``` - -Run `cargo run --example node_api_core_get_block_metadata --release -- [NODE URL]`. - -# `Client::` - -Calls `GET /api/core/v2/outputs/{outputId}`. - -Finds an output by its identifier. - -## Request - -## Response - -## Example - -```rust - -``` - -Run `cargo run --example node_api_core_ --release -- [NODE URL]`. - -# `Client::` - -## Description - -Calls `GET /api/core/v2/outputs/{outputId}/metadata`. - -Returns metadata about an output by its identifier. - -## Request - -## Response - -## Example - -```rust - -``` - -Run `cargo run --example node_api_core_ --release -- [NODE URL]`. - -# `Client::get_receipts` - -Calls `GET /api/core/v2/receipts`. - -Returns all stored receipts. - -## Request - -## Response - -## Example - -```rust -let receipts = client.get_receipts().await?; -``` - -Run `cargo run --example node_api_core_get_receipts --release -- [NODE URL]`. - -# `Client::get_receipts_migrated_at` - -## Description - -Calls `GET /api/core/v2/receipts/{migratedAt}`. - -Returns all stored receipts for a given migration index. - -## Request - -## Response - -## Example - -```rust -let receipts = client.get_receipts_migrated_at(1_000_000).await?; -``` - -Run `cargo run --example node_api_core_get_receipts_migrated_at --release -- [NODE URL]`. - -# `Client::get_treasury` - -Calls `GET /api/core/v2/treasury`. - -Returns information about the treasury. - -## Request - -No parameters. - -## Response - -## Example - -```rust -let treasury = client.get_treasury().await?; -``` - -Run `cargo run --example node_api_core_get_treasury --release -- [NODE URL]`. - -# `Client::` - -## Description - -Calls `GET /api/core/v2/transactions/{transactionId}/included-block`. - -Returns the included block of a transaction. - -## Request - -## Response - -## Example - -```rust - -``` - -Run `cargo run --example node_api_core_ --release -- [NODE URL]`. - -# `Client::get_milestone_by_id` - -## Description - -Calls `GET /api/core/v2/milestones/{milestoneId}`. - -Returns milestone data as JSON by its identifier. - -## Request - -## Response - -## Example - -```rust -let milestone = client.get_milestone_by_id(&milestone_id).await?; -``` - -Run `cargo run --example node_api_core_get_milestone_by_id --release -- [NODE URL]`. - -# `Client::get_milestone_by_id_raw` - -## Description - -Calls `GET /api/core/v2/milestones/{milestoneId}`. - -Returns milestone data as raw bytes by its identifier. - -## Request - -## Response - -## Example - -```rust -let milestone = client.get_milestone_by_id_raw(&milestone_id).await?; -``` - -Run `cargo run --example node_api_core_get_milestone_by_id_raw --release -- [NODE URL]`. - -# `Client::get_utxo_changes_by_id` - -## Description - -Calls `GET /api/core/v2/milestones/{milestoneId}/utxo-changes`. - -Gets all UTXO changes of a given milestone by milestone identifier. - -## Request - -## Response - -## Example - -```rust -let utxo_changes = client.get_utxo_changes_by_id(&milestone_id).await?; -``` - -Run `cargo run --example node_api_core_get_utxo_changes_by_id --release -- [NODE URL]`. - -# `Client::get_milestone_by_index` - -## Description - -Calls `GET /api/core/v2/milestones/by-index/{index}`. - -Returns milestone data as JSON by its index. - -## Request - -## Response - -## Example - -```rust -let milestone = client.get_milestone_by_index(milestone_index).await?; -``` - -Run `cargo run --example node_api_core_get_milestone_by_index --release -- [NODE URL]`. - -# `Client::get_milestone_by_index_raw` - -## Description - -Calls `GET /api/core/v2/milestones/by-index/{index}`. - -Returns milestone data as raw bytes by its index. - -## Request - -## Response - -## Example - -```rust -let milestone = client.get_milestone_by_index_raw(milestone_index).await?; -``` - -Run `cargo run --example node_api_core_get_milestone_by_index_raw --release -- [NODE URL]`. - -# `Client::get_utxo_changes_by_index` - -## Description - -Calls `GET /api/core/v2/milestones/by-index/{index}/utxo-changes`. - -Gets all UTXO changes of a given milestone by milestone index. - -## Request - -## Response - -## Example - -```rust -let utxo_changes = client.get_utxo_changes_by_index(milestone_index).await?; -``` - -Run `cargo run --example node_api_core_get_utxo_changes_by_index --release -- [NODE URL]`. - -# `Client::` - -## Description - -Calls `POST /api/core/v2/whiteflag`. - -Computes applied and confirmed merkle route hashes for a proposed milestone. - -## Request - -## Response - -## Example - -```rust - -``` - -Run `cargo run --example node_api_core_ --release -- [NODE URL]`. - -# `Client::` - -## Description - -Calls `GET /api/core/v2/peers`. - -Gets information about the peers of the node. - -## Request - -## Response - -## Example - -```rust - -``` - -Run `cargo run --example node_api_core_ --release -- [NODE URL]`. - -# `Client::` - -## Description - -Calls `POST /api/core/v2/peers`. - -Adds a given peer to the node. - -## Request - -## Response - -## Example - -```rust - -``` - -Run `cargo run --example node_api_core_ --release -- [NODE URL]`. - -# `Client::` - -## Description - -Calls `GET /api/core/v2/peers/{peerId}`. - -Gets information about a given peer. - -## Request - -## Response - -## Example - -Run `cargo run --example node_api_core_ --release -- [NODE URL]`. - -# `Client::` - -## Description - -Calls `DELETE /api/core/v2/peers/{peerId}`. - -Removes/disconnects a given peer. - -## Request - -## Response - -## Example - -```rust - -``` - -Run `cargo run --example node_api_core_ --release -- [NODE URL]`. - -# `Client::` - -## Description - -Calls `POST /api/core/v2/control/database/prune`. - -Prunes the node database. - -## Request - -## Response - -## Example - -```rust - -``` - -Run `cargo run --example node_api_core_ --release -- [NODE URL]`. - -# `Client::` - -## Description - -Calls `POST /api/core/v2/control/snapshot/create`. - -Creates a new snapshot diff --git a/docs/build/iota.rs/2.0-rc.7/docs/overview.md b/docs/build/iota.rs/2.0-rc.7/docs/overview.md deleted file mode 100644 index 7e805af44a0..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/overview.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -description: 'The iota.rs library is designed to simplify how you connect and interact -with [nodes](/introduction/node_software) in the IOTA network. ' -image: /img/overview/layered_overview.svg -keywords: - -- layered overview -- high level -- low level -- stronghold -- value transactions -- explanation - ---- - -# Overview - -![IOTA Client Library Overview](/img/banner/banner_client_lib_overview.png) - -The iota.rs library is designed to simplify how you connect and interact -with [nodes](/introduction/explanations/node_software) in the IOTA network. You can use it to generate -addresses, send messages, sign and send transactions, and more. - -Beyond establishing the initial connection to a node, iota.rs has no state. Operations use only the data you pass during -a call and have no effect on your software beyond returning a value. You are in complete control of the data flow in -your application. - -This stateless approach makes iota.rs easy to use and understand. But since you are in full control of data management, -you are also fully responsible for it, which could feel overwhelming if you handle complex or sensitive data. If you -plan on managing funds in your application, take a look at -our [wallet.rs library](/wallet.rs/welcome) instead. - -## Supported Languages - -We implemented the iota.rs library in [Rust](getting_started/rust.mdx) and prepared bindings -for [JavaScript](getting_started/nodejs.mdx), [Python](getting_started/python.mdx), -and [Java](getting_started/java.mdx). Every binding is adjusted for the language's conventions and best -practices. For example, Python developers avoid the Builder programming pattern, so our -Python binding uses named constructor arguments. However, we never change the meaning behind our API, which is equally -powerful no matter which language you choose. - -## Your Application In the IOTA Network - -Your application communicates with iota.rs either directly in Rust or through one of the language bindings. The iota.rs -library turns your requests into REST API calls and sends them to a node through the Internet. The node, in turn, -interacts with the rest of an IOTA network, which could be -the [main operational network (mainnet)](/introduction/reference/networks/mainnet) or -a [network for testing purposes (devnet)](/introduction/reference/networks/devnet). - -Different nodes can run on different software, but they always expose the same interface to clients. For example, one -node could be a [Hornet](/hornet/welcome) node, and the other could be -a different implementation of the -[core REST API](/apis/core/v2/iota-core-rest-api), and they both would -appear the same for any client. - -![A diagram that illustrates the text above. It has three layers: the application layer that includes iota.rs and its bindings, communication layer (the Internet network), and IOTA network layer with nodes that operate on one of the IOTA networks.](/img/overview/layered_overview.svg 'An overview of IOTA layers.') - -## API Design - -The iota.rs library exposes operations of two types. Clients interact with nodes by calling their REST API, and the -first group of operations mirrors the available calls. When your program invokes such an operation, it directly -translates it into a REST call to a node. See -the [node's REST API reference](/apis/core/v2/iota-core-rest-api) -for a complete list of available endpoints. - -Operations from the first group tend to be too atomic and basic to use conveniently. The second group provides you with -higher-level helper functions. These functions represent an actual task and combine multiple basic operations -internally. diff --git a/docs/build/iota.rs/2.0-rc.7/docs/troubleshooting.md b/docs/build/iota.rs/2.0-rc.7/docs/troubleshooting.md deleted file mode 100644 index b497fc1f23d..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/troubleshooting.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -description: Troubleshooting the IOTA Client Library. -image: /img/logo/iota_mark_light.png -keywords: - - discussion - - channel - - problem - - solution - - discord - - stackexchange ---- - -# Troubleshooting - -## StackExchange - -> [https://iota.stackexchange.com](https://iota.stackexchange.com/) - -The IOTA StackExchange a a nice tool for developers to find answers for a problem. Just search your problem and find your answer! If there is no one, submit your question and share it in the discussion channel below. - -## Joining the discussion - -If you want to get involved in discussions about this library, or you're looking for support, go to the #clients-discussion channel on [Discord](https://discord.iota.org). diff --git a/docs/build/iota.rs/2.0-rc.7/docs/welcome.md b/docs/build/iota.rs/2.0-rc.7/docs/welcome.md deleted file mode 100644 index a50918de907..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/docs/welcome.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -description: Official IOTA Client Library which can be used to easily integrate an IOTA Client into your application -image: /img/banner/banner_client_lib.png -keywords: - - requirements - - software - - library - - rust - - python - - nodejs - - explanation ---- - -# Welcome - -![IOTA Client Library](/img/banner/banner_client_lib.png) - -The iota.rs library handles communications between your software and the IOTA network. - -The iota.rs library is free and open-source, and it will be. Both the IOTA Foundation and the IOTA community maintain -the library and this wiki, which means that you can rely on it as a source of knowledge on iota.rs. Start exploring it -from the [Overview](overview.md) page. - -If you have questions, jump into a discussion or start a new one on our [Discord server](https://discord.iota.org) or -ask questions and find answers at our [community on Stack Exchange](https://iota.stackexchange.com/). If you wish to -contribute to the project, make sure that you read our [contribution guide](./contribute.md). - -We are glad that you are here! diff --git a/docs/build/iota.rs/2.0-rc.7/sidebars.js b/docs/build/iota.rs/2.0-rc.7/sidebars.js deleted file mode 100644 index 1b2f71671a1..00000000000 --- a/docs/build/iota.rs/2.0-rc.7/sidebars.js +++ /dev/null @@ -1,141 +0,0 @@ -/** - * * Creating a sidebar enables you to: - - create an ordered group of docs - - render a sidebar for each doc of that group - - provide next/previous navigation - - The sidebars can be generated from the filesystem, or explicitly defined here. - - Create as many sidebars as you want. - */ - -module.exports = { - docs: [ - { - type: 'doc', - id: 'welcome', - }, - { - type: 'doc', - id: 'overview', - }, - { - type: 'category', - label: 'Getting Started', - - link: { - type: 'doc', - id: 'getting_started/getting_started', - }, - items: [ - { - type: 'doc', - id: 'getting_started/rust', - label: 'Rust', - }, - { - type: 'doc', - id: 'getting_started/nodejs', - label: 'Node.js', - }, - { - type: 'doc', - id: 'getting_started/java', - label: 'Java', - }, - { - type: 'doc', - id: 'getting_started/python', - label: 'Python', - }, - ], - }, - { - type: 'category', - label: 'How To', - items: [ - { - type: 'autogenerated', - dirName: 'how_tos', - }, - ], - }, - { - type: 'category', - label: 'API Reference', - items: [ - { - type: 'doc', - id: 'libraries/rust/api_reference', - label: 'Rust', - }, - { - type: 'category', - label: 'Node.js', - items: [ - { - type: 'doc', - id: 'libraries/nodejs/references/api_ref', - label: 'API Reference', - }, - { - type: 'category', - label: 'Classes', - items: [ - { - type: 'autogenerated', - dirName: 'libraries/nodejs/references/classes', - }, - ], - }, - { - type: 'category', - label: 'Enums', - items: [ - { - type: 'autogenerated', - dirName: 'libraries/nodejs/references/enums', - }, - ], - }, - { - type: 'category', - label: 'Interfaces', - items: [ - { - type: 'autogenerated', - dirName: 'libraries/nodejs/references/interfaces', - }, - ], - }, - ], - }, - { - type: 'doc', - id: 'libraries/java/api_reference', - label: 'Java', - }, - { - type: 'category', - label: 'Python', - items: [ - { - type: 'autogenerated', - dirName: 'libraries/python/references/iota_client', - }, - ], - }, - ], - }, - { - type: 'doc', - id: 'troubleshooting', - label: 'Troubleshooting', - }, - { - type: 'doc', - id: 'contribute', - label: 'Contribute', - }, - ], -}; diff --git a/docs/build/streams/0.2/docs/contribute.md b/docs/build/streams/0.2/docs/contribute.md deleted file mode 100644 index e543b8fd141..00000000000 --- a/docs/build/streams/0.2/docs/contribute.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -description: Contribute to the IOTA Client Library joining the IOTA Libraries Initiative, contributing to the official GitHub repository or sharing your knowledge on Discord. -image: /img/logo/iota_mark_light.png -keywords: - - join - - documentation - - project - - contribute - - discord - - GitHub ---- - -# Contribute to the Project - -**Thanks for thinking about contributing to the project! We have the following ways that you can contribute.** - -## Join the IOTA Libraries Initiative - -The [IOTA Libraries Initiative](https://github.com/iota-community/X-Team_IOTA_Streams) is a collaborative effort to help improve the developer experience. - -- Quality assurance and review -- Documentation -- Code samples - -If you'd like to get involved, join the #experience channel on [Discord](https://discord.iota.org). - -## Contribute to the project's GitHub repository - -All the code is open source and hosted on [GitHub](https://github.com/iotaledger/streams) where you can do the following: - -- Report a bug -- Suggest a new feature -- Contribute to the documentation - -## Contribute to the documentation - -This documentation is also open source and hosted on GitHub. - -If you want to contribute new documentation or fix an error, see the [contribution guidelines](https://github.com/iotaledger/documentation/blob/develop/.github/CONTRIBUTING.md). - -## Share your knowledge - -Helping others is an important part of any open source ecosystem. - -By sharing your knowledge with others, you can provide a lot of value to the community and maybe inspire someone else to learn and contribute. - -Take a look at what discussions are going on in the #clients-discussion channel on [Discord](https://discord.iota.org). - -Thanks :heart: diff --git a/docs/build/streams/0.2/docs/getting_started.md b/docs/build/streams/0.2/docs/getting_started.md deleted file mode 100644 index 33a6bd7db7f..00000000000 --- a/docs/build/streams/0.2/docs/getting_started.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -description: Choose your binding and get started with the Streams Library. -image: /img/logo/iota_mark_light.png -keywords: - - rust - - wasm - - c - - IDE ---- - -# Getting Started - -To check out our examples and write and test your own code, you would need an IDE or a code editor of your choice and a stable internet connection. You also need to set up your environment by following [this](./libraries/rust/getting_started.md) instructions. - -We assume that you already know the basics of the Rust programming language. Companies and communities behind each language provide their own documentation for beginners: [Rust](https://www.rust-lang.org/learn/get-started). You could start with that first, or refer to these guides as you read through our streams documentation. If you have never programmed in your life, MIT has published an open [introductory course to programming](https://ocw.mit.edu/courses/intro-programming/#general). Check it out! diff --git a/docs/build/streams/0.2/docs/libraries/overview.md b/docs/build/streams/0.2/docs/libraries/overview.md deleted file mode 100644 index 2bc335962a4..00000000000 --- a/docs/build/streams/0.2/docs/libraries/overview.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -description: The `streams` library is written in Rust. You can also find bindings written for wasm and C. -image: /img/overview/layered_overview.svg -keywords: - - bindings - - library - - rust - - wasm - - c ---- - -# IOTA Streams libraries - -The `streams` library is currently available in the following languages: - -- [Rust](./rust/getting_started.md) - -## Getting Started - -The recommended approach to start your interactions with IOTA is to use a developer network. A public API load balancer is provided here: [api.lb-0.h.chrysalis-devnet.iota.cafe](https://api.lb-0.h.chrysalis-devnet.iota.cafe) - -The test network explorer is available at the [IOTA Tangle explorer](https://explorer.iota.org/devnet/). diff --git a/docs/build/streams/0.2/docs/libraries/rust/api_reference.md b/docs/build/streams/0.2/docs/libraries/rust/api_reference.md deleted file mode 100644 index 3d349b23579..00000000000 --- a/docs/build/streams/0.2/docs/libraries/rust/api_reference.md +++ /dev/null @@ -1,12 +0,0 @@ -# API Reference - -Users are broken down into two types: `Author` and `Subscriber`. An `Author` is the user -that generates the channel, accepts subscription requests and can perform access granting -and restriction methods. A `Subscriber` is an instance that can attach to a channel to read -from and write to depending on the access privileges they've been granted. - -You can generate the api reference with: - -``` -cargo doc --document -``` diff --git a/docs/build/streams/0.2/docs/libraries/rust/examples.md b/docs/build/streams/0.2/docs/libraries/rust/examples.md deleted file mode 100644 index 4f3cdf64704..00000000000 --- a/docs/build/streams/0.2/docs/libraries/rust/examples.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -description: Official IOTA Streams Rust API examples. -image: /img/logo/iota_mark_light.png -keywords: - - api - - Rust - - examples ---- - -# Examples - -A list of example implementations can be found [here](https://github.com/iotaledger/streams-examples) - -Additionally there are a couple of local examples present [here](https://github.com/iotaledger/streams/tree/develop/examples). -To run these examples simply update the `.env` file with the node url you would like -to use, and run the command: - -``` -cargo run --release -``` diff --git a/docs/build/streams/0.2/docs/libraries/rust/getting_started.md b/docs/build/streams/0.2/docs/libraries/rust/getting_started.md deleted file mode 100644 index 77576b52bcc..00000000000 --- a/docs/build/streams/0.2/docs/libraries/rust/getting_started.md +++ /dev/null @@ -1,155 +0,0 @@ -# Getting Started - -Streams requires an asynchronous runtime environment to be set, we suggest using [tokio](https://docs.rs/tokio/latest/tokio/). Streams also uses [anyhow](https://docs.rs/anyhow/latest/anyhow/) for error handling, so projects can use `anyhow::Result` and `anyhow::Error` for easier integration. - -To create a new Rust project, run: - -```bash -cargo new PROJECT_NAME -``` - -Create two of these Rust projects, one for the author and one for the subscriber, and add the following dependencies to both their `Cargo.toml` files: - -```toml -tokio = { version = "1.5.0", features = ["full"] } -anyhow = { version = "1.0" } -iota-streams = { git = "https://github.com/iotaledger/streams", branch = "develop"} - -# Temporarily needed because Streams is a work in progress -bee-message = "=0.1.5" -bee-rest-api = "=0.1.2" -``` - -## Basic Usage - -With the needed projects and their dependencies added, we can start using the Streams library. Below are two example scripts for both the author and the subscriber. The author script will announce a channel and print the announcement link. The subscriber script handles the announcement to let the subscriber know where to find the channel. - -### Author - -Replace the seed of the author with a random string and run the script to get the announcement link. - -``` -use anyhow::Result; -use iota_streams::app_channels::api::tangle::{Author, ChannelType}; -use iota_streams::app::transport::tangle::client::Client; - -#[tokio::main] -async fn main() -> Result<()> { - let node = "https://chrysalis-nodes.iota.org"; - let client = Client::new_from_url(node); - - // Author implementation will set the Channel Type - let mut author = Author::new("AUTHOR_SEED", ChannelType::SingleBranch, client); - - // Start the channel and retrieve the announcement link - let ann_link = author.send_announce().await?; - - // Convert the announcement link to a string to share with others - println!("{}", ann_link.to_string()); - Ok(()) -} -``` - -### Subscriber - -Replace the seed of the subscriber with a random string, paste the announcement link from the author script above and run the script to let the subscriber find the channel. - -``` -use anyhow::Result; -use iota_streams::app_channels::api::tangle::{Address, Subscriber}; -use iota_streams::app::transport::tangle::client::Client; -use std::str::FromStr; - -#[tokio::main] -async fn main() -> Result<()> { - let node = "https://chrysalis-nodes.iota.org"; - let client = Client::new_from_url(node); - - // Subscriber implementation does not need to specify a channel type, it will be - // parsed from the announcement message - let mut subscriber = Subscriber::new("SUBSCRIBER_SEED", client); - - // Create Address object from announcement link string - let ann_link = Address::from_str("ANNOUNCEMENT_LINK")?; - - // Process the announcement message - subscriber.receive_announcement(&ann_link).await?; - Ok(()) -} -``` - -## Next Steps - -Now we can begin subscribing users to the channel and generating branches to specify access control for publishers and subscribers via keyload messages. - -### Subscription - -To subscribe to a channel, subscribers create a subscribe message that is linked to the channel announcement message. The link of this message should then be provided to the author. This allows the author to handle the subscription message and use the public key of the subscriber for access control and validation purposes. - -#### Subscriber - -``` -// Send subscription message -let sub_link = subscriber.send_subscribe(&ann_link).await?; -// Provide the link to the author -println!("{}", sub_link.to_string()); -``` - -#### Author - -``` -// Process subscriber link -let sub_link = Address::from_str("SUBSCRIPTION_LINK")?; -author.receive_subscribe(&sub_link).await?; -``` - -### Keyloads - -Keyload messages are used as an access control mechanism for a branch. A random key is generated and masked within the message using the public keys or pre-shared keys included in them. This allows the author to specify which subscribers have access to which branches. There are two ways to send a keyload: - -- Send a keyload including specific pre-shared keys or subscriber public keys. -- Send a keyload including all pre-shared keys and subscriber public keys known to the author. - -Example: - -``` -// Send keyload including pre-shared key -let psk = psk_from_seed("KEY_SEED".as_bytes()); -let psk_id = pskid_from_psk(&psk); -author.store_psk(psk_id, psk)?; -author.send_keyload(&ann_link, &vec![psk_id.into()]).await?; - -// Send keyload for subscriber -author.send_keyload(&ann_link, &vec![subscriber_public_key.into()]).await?; - -// Send keyload for everyone -author.send_keyload_for_everyone(&ann_link).await?; -``` - -### Pre-shared keys - -As an alternative to subscribing via public key exchange using subscribe messages, an author may specify access control through the use of a pre-shared key (PSK). A PSK is a 32 byte array containing a secret key, shared outside of the Streams instance, that can be used to specify access through a keyload message. If an author issues a keyload with a PSK included, and a subscriber reads this message with the same PSK stored within itself, then the subscriber can participate in the proceeding branch without being subscribed to the channel. - -Example: - -``` -use iota_streams::app_channels::api::{psk_from_seed, pskid_from_psk}; -use rand::Rng; - -// Create a random key -let key_seed = rand::thread_rng().gen::<[u8; 32]>(); -let psk = psk_from_seed(&key); -let pskid = pskid_from_psk(&psk); - -// Store the PSK in the author -author.store_psk(pskid, psk)?; - -// Create a keyload with the PSK included -let keyload_link = author.send_keyload(&ann_link, &vec![psk_id.into()]).await?; - -// Store the same PSK in the subscriber -subscriber.store_psk(pskid, psk); - -// Process keyload message from subscriber end -subscriber.receive_keyload(&keyload_link).await?; -``` diff --git a/docs/build/streams/0.2/docs/overview.md b/docs/build/streams/0.2/docs/overview.md deleted file mode 100644 index d279cf9c3af..00000000000 --- a/docs/build/streams/0.2/docs/overview.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -description: "The Streams framework is intended to be a secure message verification and protection protocol -for sending data over a given transport layer" -image: /img/overview/layered_overview.svg -keywords: -- layered overview -- high level -- low level -- stronghold -- channels -- author -- subscriber -- value transactions ---- - -# Overview - -The IOTA Streams framework is intended to be a secure message verification and protection protocol -for sending data over a given transport layer. - -The Channels protocol is designed as a replacement for the previously used MAM library for sending -data using the Tangle as the primary transportation mechanism. The channels themselves can be -structured in a number of ways with any arbitrary combination of publishers and subscribers (although -each channel can only be hosted by a single author instance) - -# Channels Protocol - -The Channels protocol provides the high level API tools necessary for authors and subscribers to be -generated and interact with the Tangle. - -## Authors - -A channel author is responsible for the generation of a new channel along with the configuration of the -intended structure of that channel (i.e single branch vs multi branch). An author of a channel will be -able to set the access restrictions to branches within a channel structure, as well as accepting and -managing user subscription messages. - -## Subscribers - -A channel subscriber is any user within a channel that is not the author. A subscriber can be generated -independently without verification by an author, but in order to write to a branch, or to process any -private streams, they will be required to subscribe to the channel, and have the author accept and process -that subscription. A subscriber may also use pre-shared keys instead of subscription as a method of -interacting with a stream without conducting a subscription process. - -## Branching - -Branches can be defined as any sequential grouping of messages that are linked to the announcement -message. These branches will typically be generated with either a signed packet message or a keyload message for -public and private streaming respectively. A channel can assume two different forms: - -- Single branch: a linear sequencing of messages (similar to a MAM stream) with each message linked to - the previous one. -- Multi branch: a sequencing of messages that does not rely on sequential linking of messages. - -When generating a channel, the author will decide whether the channel will use single branching or multi- -branching, this will inform the Streams instance in which way it should perform sequencing. subscribers will -also be informed as they process the announcement message, so their instances know the appropriate -sequencing order as well. - -## Keyloads - -A keyload message is an access restriction and control message that allows the author to specify who should be -able to decrypt any messages that are attached following it. There are two ways to specify access when generating -a keyload message: - -- Subscriber public keys -- Pre-shared keys - -### Public Keys - -During the processing of subscription messages, public keys are masked and provided to the author to be stored on -their instance. That author can then specify which of these users will be able to access subsequent messages by -including that public key in the keyload message. - -### Pre-Shared Keys - -A predefined key shared amongst users by other means then the subscription process above. These keys can be used to provide access restrictions to a stream -without the need for a subscription process. - -:::note - -The security and transportation of these pre-shared keys must be ensured by the user implementations. - -::: - -## Sequencing - -Sequencing is the methodology built within streams to allow message identifiers to be sequentially generated regardless -of the shape of the channel. Messages are identified by an indexation position within the Tangle, and they are -generated using a combination of these pieces of information: - -- Application instance (channel identifier). -- Public key of the publisher. -- Previous message id (The message being linked to). -- Branch number (identifier for the specific branch). -- Sequencing number (the sequencing position of the publisher). - -As messages are posted to and read from the channel, a local state for the user implementation will update with the message -identifier, branch and sequencing numbers for each publishing party. This allows user implementations to derive and -search for the next message in the sequence to keep in sync. - -### Single Branch Sequencing - -In a single branch implementation, sequencing state of each user will be updated to the same state. This means that -regardless of the publisher, the state of each user will update the previous message id to the new message link, and the -sequencing number will be incremented by one. - -Sequence states before Msg1 is sent: - -``` - Author Sub1 -Prev Msg Id Msg0 Msg0 -Branch No. 0 0 -Seq. No. 2 2 <- Users start from 2, 0 and 1 are reserved for subscriptions and announcements -``` - -Msg1 is then sent by the author using the above stated author state. - -Sequence states after Msg1 is sent: - -``` - Author Sub1 -Prev Msg Id Msg1 Msg1 -Branch No. 0 0 -Seq. No. 3 3 -``` - -:::note - -It is recommended that a single branch be used with only a single publisher to avoid out of sync parties from -issuing and retrieving messages from an incorrect sequencing combination (i.e. Sub1 sends a message linked to Msg1 and Sub2 -sends a message linked to that same Msg1 before seeing and registering the message from Sub1, thus forking the stream). -Multiple publishers can be used, but it is important to ensure that they do not try to send messages in parallel to -avoid this conflict. In the future this may be an enforced limitation on single branch implementations to remove the -possibility altogether. - -::: - -### Multi Branch Sequencing - -In a multi branch implementation, the sequencing state of each user will be updated independently after each message is sent. -In order to track the linking of messages of individual publishers within a tree-like structure, a secondary message is -sent in tandem with every data message. This message is called a sequencing message, and contains the essence necessary -for a user to derive the correct message id of a sequenced message. The sequencing messages are issued to an anchored -branch generated during the creation of the channel. As a new message is generated by a user, a sequencing message is -issued to this anchored branch to allow users a reference guide to the location of the issued data packet. diff --git a/docs/build/streams/0.2/docs/specs.md b/docs/build/streams/0.2/docs/specs.md deleted file mode 100644 index f40068c9cc3..00000000000 --- a/docs/build/streams/0.2/docs/specs.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -description: "The Streams framework is intended to be a secure message verification and protection protocol -for sending data over a given transport layer" -image: /img/logo/wallet_light.png -keywords: -- Rust -- streams -- spec ---- - -# Specifications document - -The specs doc can be found separate from docs here: -[Spec.pdf](https://github.com/iotaledger/streams/blob/develop/specification/Streams_Specification_1_0A.pdf) diff --git a/docs/build/streams/0.2/docs/troubleshooting.md b/docs/build/streams/0.2/docs/troubleshooting.md deleted file mode 100644 index 21d804e77f7..00000000000 --- a/docs/build/streams/0.2/docs/troubleshooting.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -description: Troubleshooting the Streams Library. -image: /img/logo/iota_mark_light.png -keywords: - - discussion - - channel - - problem - - solution - - discord - - stackexchange ---- - -# Troubleshooting - -## StackExchange - -> [https://iota.stackexchange.com](https://iota.stackexchange.com/) - -The IOTA StackExchange a a nice tool for developers to find answers for a problem. Just search your problem and find your answer! If there is no one, submit your question and share it in the discussion channel below. - -## Joining the discussion - -If you want to get involved in discussions about this library, or you're looking for support, go to the #streams channel on [Discord](https://discord.iota.org). diff --git a/docs/build/streams/0.2/docs/welcome.md b/docs/build/streams/0.2/docs/welcome.md deleted file mode 100644 index d4b0917c386..00000000000 --- a/docs/build/streams/0.2/docs/welcome.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -description: Official IOTA Streams which can be used to easily integrate an IOTA Wallet into your application -image: /img/logo/wallet_light.png -keywords: - - requirements - - streams - - channels - - software - - library - - rust - - nodejs ---- - -# Welcome - -This is the documentation for the official IOTA Streams software. You can read more about core principles behind IOTA Streams in the following blog [post](https://blog.iota.org/iota-streams-alpha-7e91ee326ac0/). - -Streams is an organizational tool for structuring and navigating secure data through the Tangle. Streams organizes data by ordering it in a uniform and interoperable structure. Needless to say, it is also based on our official _one source code of truth_ [IOTA Rust library](https://github.com/iotaledger/iota.rs). - -More information about Chrysalis components is available at [documentation portal](/introduction/welcome). - -## Joining the discussion - -If you want to get involved in discussions about this library, or you're looking for support, go to the #streams-discussion channel on [Discord](https://discord.iota.org). - -## What you will find here - -This documentation has five paths: - -1. The Overview: a detailed overview of the streams library. -2. Libraries: all available programming languages and their resources. -3. The Specification: detailed explanation requirements and functionality. -4. Contribute: how you can work on the streams software. -5. Get in touch: join the community and become part of the X-Team! diff --git a/docs/build/streams/0.2/sidebars.js b/docs/build/streams/0.2/sidebars.js deleted file mode 100644 index 5bcc9ce1ecf..00000000000 --- a/docs/build/streams/0.2/sidebars.js +++ /dev/null @@ -1,75 +0,0 @@ -/** - * * Creating a sidebar enables you to: - - create an ordered group of docs - - render a sidebar for each doc of that group - - provide next/previous navigation - - The sidebars can be generated from the filesystem, or explicitly defined here. - - Create as many sidebars as you want. - */ - -module.exports = { - docs: [ - { - type: 'doc', - id: 'welcome', - }, - { - type: 'doc', - id: 'overview', - }, - { - type: 'doc', - id: 'getting_started', - }, - { - type: 'category', - label: 'Libraries', - collapsed: false, - items: [ - { - type: 'doc', - id: 'libraries/overview', - label: 'Overview', - }, - { - type: 'category', - label: 'Rust', - items: [ - { - type: 'doc', - id: 'libraries/rust/getting_started', - label: 'Getting Started', - }, - { - type: 'doc', - id: 'libraries/rust/examples', - label: 'Examples', - }, - { - type: 'doc', - id: 'libraries/rust/api_reference', - label: 'API Reference', - }, - ], - }, - ], - }, - { - type: 'doc', - id: 'specs', - label: 'Specification', - }, - { - type: 'doc', - id: 'troubleshooting', - label: 'Troubleshooting', - }, - { - type: 'doc', - id: 'contribute', - label: 'Contribute', - }, - ], -}; diff --git a/docs/build/stronghold.rs/1.1/docs/reference/specs/scope.md b/docs/build/stronghold.rs/1.1/docs/reference/specs/scope.md index 6712a575ce5..57d1dc0db6e 100644 --- a/docs/build/stronghold.rs/1.1/docs/reference/specs/scope.md +++ b/docs/build/stronghold.rs/1.1/docs/reference/specs/scope.md @@ -152,7 +152,7 @@ prior work from Daniel Thompson-Yvetot and Tensor at their security boutique "IO ### 2. High level library (stronghold.rs) -The high level library integrates engine.rs and iota.rs to a fully fledged secret storage and +The high level library integrates engine.rs to a fully fledged secret storage and enclave based system for operations in the context of the IOTA Protocol. Its primary purpose is to serve as the operational enclave for several IOTA Products: diff --git a/docs/build/wallet.rs/0.1/docs/contribute.md b/docs/build/wallet.rs/0.1/docs/contribute.md deleted file mode 100644 index 672a4629307..00000000000 --- a/docs/build/wallet.rs/0.1/docs/contribute.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -description: Contribute to the IOTA Wallet Library joining the IOTA Libraries Initiative, contributing to the official GitHub repository, or sharing your knowledge on Discord. -image: /img/logo/logo.svg -keywords: - - join - - documentation - - project - - contribute - - discord - - GitHub - - reference ---- - -# Contribute to the Project - -Thank you for thinking about contributing to the project! You can contribute using the following ways. - -## Join the IOTA Libraries Initiative - -The [IOTA Libraries Initiative](https://github.com/iota-community/X-Team_IOTA_Libraries) is a collaborative effort to help improve the developer experience that includes. - -- Quality assurance and review. -- Documentation. -- Code samples. - -If you would like to get involved, join the [#wallet-discussion channel](https://discord.com/channels/397872799483428865/933883981311643698). - -## Contribute to the Project's GitHub Repository - -All of the code is open source and hosted on [GitHub](https://github.com/iotaledger/wallet.rs) where you can: - -- Report a bug. -- Suggest a new feature. -- Contribute to the documentation. - -## Contribute to the Documentation - -This documentation is also open source and hosted on GitHub. - -If you want to contribute new documentation or fix an error, [create a new task](https://github.com/iotaledger/wallet.rs/issues/new/choose), and outline your feedback - -## Share Your Knowledge - -Helping others is an important part of any open source ecosystem. - -By sharing your knowledge with others, you can provide a lot of value to the community and maybe inspire someone else to learn and contribute. - -Take a look at what discussions are going on in the [#wallet-discussion channel](https://discord.com/channels/397872799483428865/933883981311643698) - -Thanks :heart: diff --git a/docs/build/wallet.rs/0.1/docs/examples/java.md b/docs/build/wallet.rs/0.1/docs/examples/java.md deleted file mode 100644 index add2a2a6a8f..00000000000 --- a/docs/build/wallet.rs/0.1/docs/examples/java.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -description: The Official IOTA Wallet Library Java API examples. -image: /img/logo/iota_mark_light.png -keywords: - - api - - Java - - examples - - type - - node - - client - - reference ---- - -# Examples in Java - -This section will guide you through several examples using the Java binding of the `wallet.rs` library. You can also find the code for the examples in the `/bindings/java/examples/java-app` folder in the [official GitHub repository](https://github.com/iotaledger/wallet.rs/tree/dev/bindings/java/examples/java-app). - -```bash -git clone -b production https://github.com/iotaledger/wallet.rs -``` - -```bash -cd wallet.rs/bindings/java -``` - -Examples are all collected in a sample project. By default, it runs a node info example, but there are more. - -You can run the example with Gradle or Maven using the following commands: - -Gradle: `./gradlew examples:java-app:test --info` - -Maven: `cd examples/java-app && mvn test` - -## Backup and Restore - -1. Create an account manager and set a password: - -```java -AccountManager manager = AccountManager.Builder().finish(); - -manager.setStrongholdPassword("password"); -manager.storeMnemonic(AccountSignerType.STRONGHOLD, null); - -``` - -2. Create your account: - -```java -ClientOptions clientOptions = new ClientOptionsBuilder() - .withNode("https://api.lb-0.h.chrysalis-devnet.iota.cafe") - .build(); -Account account = manager - .createAccount(client_options) - .alias("alias") - .initialise(); -String id = account.id(); - -``` - -3. Secure your account in a backup file: - -```java -// backup the stored accounts to ./backup/${backup_name} -Path backupPath = manager.backup("./backup"); -``` - -4. You can import the backup later, or in another application using the following snippet: - -```java -manager.importAccounts(backupPath, "password"); - -Account imported_account_handle = manager.getAccount(id); -``` - -That's it! You can now backup and restore your account! - -## Transfering Funds - -1. Get or Create your account: - -```java -AccountManager manager = AccountManager.Builder().finish(); - -manager.setStrongholdPassword("password"); - -// Get account or create a new one -String accountAlias = "alias"; -Account account; -try { - account = manager.getAccount(accountAlias) -} catch (WalletException e) { - // first we'll create an example account and store it - manager.storeMnemonic(AccountSignerType.STRONGHOLD, null); - ClientOptions clientOptions = new ClientOptionsBuilder() - .withNode("https://api.lb-0.h.chrysalis-devnet.iota.cafe") - .build(); - account = manager - .createAccount(client_options) - .alias(accountAlias) - .initialise(); -} -``` - -2. Generate the address: - -```java -Address address = account.generateAddress(); -``` - -3. Print and wait: - -```java -System.out.println("Send iotas from the faucet to {} and press enter after the transaction got confirmed" + - address -); - -System.in.read(); -``` - -4. Send and wait: - -```java -System.out.println("Sending transfer..."); -Message message = account - .transfer( - Transfer.builder( - AddressWrapper.parse("atoi1qzt0nhsf38nh6rs4p6zs5knqp6psgha9wsv74uajqgjmwc75ugupx3y7x0r"), - 10000000, - OutputKind.SIGNATURE_LOCKED_DUST_ALLOWANCE), - ) - .finish(), - ); -System.out.println("Message sent: " + message.id()); -``` - -## Listen to Events - -```java - -``` - ---- - -You can find more advanced examples in the [examples](https://github.com/iotaledger/wallet.rs/tree/dev/bindings/java/examples/java-app) folder. diff --git a/docs/build/wallet.rs/0.1/docs/examples/nodejs.mdx b/docs/build/wallet.rs/0.1/docs/examples/nodejs.mdx deleted file mode 100644 index 5f66e5c4daa..00000000000 --- a/docs/build/wallet.rs/0.1/docs/examples/nodejs.mdx +++ /dev/null @@ -1,229 +0,0 @@ ---- -description: Official IOTA Wallet Library Software Node.js examples. -image: /img/logo/logo.svg -keywords: - - account - - address - - nodejs - - dust protection - - password - - stronghold - - Chrysalis - - reference ---- - -# Examples in Node.js - -In this section, you will go over several examples that use the node.js binding of the `wallet.rs` library. You can also find examples of the code in the `/bindings/nodejs/examples` folder of the [official GitHub repository](https://github.com/iotaledger/wallet.rs/tree/dev/bindings/nodejs/examples). - -ll the examples in this section expect you to set your custom password in the _.env_ file: - -```bash -SH_PASSWORD="here is your super secure password" -``` - -## Account Manager and Individual Accounts - -You can initialize (open) secure storage for individual accounts. This storage is backed up by `Stronghold` by default, using an AccountManager instance. - -The following example creates a new database and account: - -```js reference -https://github.com/iotaledger/wallet.rs/tree/production/bindings/nodejs/examples/binding_examples/1-create-account.js -``` - -- Storage is initialized under the given path (`./alice-database`). -- The password is set based on your password in _.env_ file (`manager.setStrongholdPassword(process.env.SH_PASSWORD)` ). -- When you initialize the new database, a Stronghold mnemonic (seed) is automatically generated and stored by default (`manager.storeMnemonic(SignerType.Stronghold)` ). -- You will only need to set the seed when you initialize the database for the first time. You can open an already initialized database using your password. - -The storage is encrypted at rest, so you need a strong password and location to place your storage. - -:::note - -We recommended that you store your `Stronghold` password encrypted on rest and separated from `Stronghold` snapshots. - -Deal with the password with utmost care. - -::: - -Storage is made of two things: - -- A single file called _wallet.stronghold_ contains the _seed_. `Stronghold` will secure the seed and encrypt it at rest. The generated seed (mnemonic) serves as a cryptographic key, which is used to generate all accounts and related addresses. -- Other data used by the library that is stored under _db_ sub-directory. The includes account information, generated addresses, fetched messages, etc. This data is used to speed up some operations, such as account creation, address generation, etc. - -One of the key principles behind `Stronghold` based storage is that no one can extract a seed from the storage. You manage your accounts via an _AccountManager_ instance and all the complexities are hidden under the hood and are dealt with securely. - -If you also want to store a seed somewhere else, you can use the `AccountManager.generateMnemonic()` method. Using this method generates a random seed. You can also use it before the actual account initialization. - -You can find detailed information about seed generation in the [Developer Guide to Chrysalis](/introduction/welcome/). - -### Accounts - -The `wallet.rs` library uses a model of individual accounts to separate individual users or clients from each other. You can generate multiple addresses for each account deterministically. You can find more information about account management in the [Developer Guide to Chrysalis](/introduction/how_tos/exchange/). - -Once you have created the backend storage, you can create individual accounts for individual users can be created by running the `manager.createAccount()` method: - -```javascript -let account = await manager.createAccount({ - alias: 'Alice', // an unique id from your existing user - clientOptions: { - node: 'https://api.lb-0.h.chrysalis-devnet.iota.cafe', - localPow: false, - }, -}); -``` - -Each account is related to a specific IOTA network (mainnet and devnet), which is referenced by node properties such as node url. In this example, it is on the `Chrysalis` devnet balancer. - -You can refer to the [Wallet Node.js API Reference](../reference/nodejs.md) for more information about _clientOptions_ . - -#### Alias - -An _Alias_ should be unique, and it can be any string that you see fit. The _alias_ is used to identify the account later on. Each account is also represented by an _index_ which is incremented by 1 every time new account is created. -Any account can be then referred to by its _index_ , _alias_ , or one of its generated _addresses_ . - -Several API calls can be performed via an _account_ instance. - -:::note - -It is good practice to sync accounts with the Tangle every time you work with an _account_ instance. This way, you can ensure that you rely on the latest available information. - -You can do this using `account.sync()`.`account.sync()` is performed automatically on `send`, `retry`,`reattach` and `promote` API calls. - -::: - -Once an account has been created, you can retrieve an instance using the following methods: - -- [`AccountManager.getAccount(accountId)`](../reference/nodejs.md#getaccountaccountid). -- [`AccountManager.getAccountByAlias(alias)`](../reference/nodejs.md#getaccountbyaliasalias). -- [`AccountManager.getAccounts()` .](../reference/nodejs.md#getaccounts). - -The most common methods of _account_ instance are: - -_`account.alias()` : Returns an alias of the given account. -_`account.listAddresses()` : Returns list of addresses related to the account. -_`account.getUnusedAddress()` : Returns a first unused address. -_`account.generateAddress()` : Generate a new address for the address index incremented by 1. -_`account.balance()` : Returns the balance for the given account. -_`account.sync()` : Sync the account information with the Tangle. - -## Generating Address(es) - -Each account can have multiple addresses. Addresses are generated deterministically based on the account and address index. This means that the combination of account and index uniquely identifies the given address. - -There are two types of addresses, _internal_ and _public_ (external), and each set of addresses is independent of each other and has an independent _index_ id. - -- You can create _Public_ addresses using the `account.generateAddress()` function. Public addresses are flagged as _internal=false_ (public). -- _Internal_ addresses are also called `change` addresses. _Internal_ addresses are used to store the excess funds and are indicated as _internal=false_. - -This approach is also known as a _BIP32 Hierarchical Deterministic wallet (HD Wallet)_. - -:::note - -The IOTA 1.5 (Chrysalis) network supports reusing addresses multiple times. - -::: - -You can use the following example to generate a new address: - -```js reference -https://github.com/iotaledger/wallet.rs/tree/production/bindings/nodejs/examples/binding_examples/2-generate-address.js -``` - -## Checking Balance - -Before continuing, you should visit the [IOTA devnet faucet service](https://faucet.chrysalis-devnet.iota.cafe/) and send some tokens to your devnet addresses. - -![IOTA Faucet Service](/img/libraries/screenshot_faucet.png) - -You can use the following example to generate a new database and account: - -```js reference -https://github.com/iotaledger/wallet.rs/tree/production/bindings/nodejs/examples/binding_examples/3-check-balance.js -``` - -IOTA is based on _Unspent Transaction Output_ model. You can find a detailed explanation in the [Developer Guide to Chrysalis](/learn/about-iota/messages#utxo). - -## Sending Tokens - -You can use the following example to send tokens using an Account instance to any desired address: - -```js reference -https://github.com/iotaledger/wallet.rs/tree/production/bindings/nodejs/examples/binding_examples/4-send.js -``` - -The full function signature is `Account.send(address, amount, [options])`. -You can use the default options. However, you can provide additional options, such as `remainderValueStrategy` , which has the following strategies: - -- `changeAddress()`: Send the remainder value to an internal address. -- `reuseAddress()`: Send the remainder value back to its original address. - -The `Account.send()` function returns a _wallet message_ that fully describes the given transaction. You can use the _messageId_ to check confirmation statuses. You can also retrieve individual messages related to any given account using the `Account.listMessages()` function. - -### Dust Protection - -The network uses a [dust protection](/introduction/explanations/faq#what-is-dust-protection-and-how-does-it-work) protocol to prevent malicious actors from spamming the network while also keeping track of the unspent amount ( _UTXO_ ). - -:::info - -Micro-transactions below 1Mi of IOTA tokens can be sent to another address if there is already at least 1Mi on that address. -That is why we sent 1Mi in the last example, to comply with the dust protection. - -Dust protection also means you cannot leave less than 1Mi on a spent address (leave a dust behind). - -::: - -## Backing Up a Database - -Due to security practices that are incorporated in the Stronghold's DNA, there is no way to retrieve a seed, as it is encrypted at rest. So, if you are using the default options, you should make sure that you back up your seed regularly. - -The following example will guide you in backing up your data in secure files. You can move this file to another app or device, and restore it. - -```js reference -https://github.com/iotaledger/wallet.rs/tree/production/bindings/nodejs/examples/binding_examples/5-backup.js -``` - -Alternatively, you can create a copy of the _wallet.stronghold_ file and use it as seed backup. This can be achieved by a daily [_cronjob_](https://linux.die.net/man/1/crontab), [_rsync_](https://linux.die.net/man/1/rsync), or [_scp_](https://linux.die.net/man/1/scp) with a datetime suffix for example. - -## Restore a Database - -To restore a database via `wallet.rs`, you will need to create a new empty database with a password (without the mnemonic seed). After you have created the empty database, you will need to import all accounts from the file that has been backed up earlier. - -The following example restores a secured backup file: - -```js reference -https://github.com/iotaledger/wallet.rs/tree/production/bindings/nodejs/examples/binding_examples/6-restore.js -``` - -Since the backup file is just a copy of the original database, it can be also be renamed to _wallet.stronghold_ and opened in a standard way. - -## Listen to Events - -The `wallet.rs` library can listen to several supported events. As soon as the event occurs, a provided callback will be triggered. - -You can use the following example to fetch an existing _Account_ and listen to transaction events related to that _Account_ : - -```js reference -https://github.com/iotaledger/wallet.rs/tree/production/bindings/nodejs/examples/binding_examples/7-events.js -``` - -Example output: - -```json -data: { - accountId: 'wallet-account://1666fc60fc95534090728a345cc5a861301428f68a237bea2b5ba0c844988566', - address: { - address: 'atoi1q9c6r2ek5w2yz54en78m8dxwl4qmwd7gmh9u0krm45p8txxyhtfry6apvwj', - balance: 20000000, - keyIndex: 0, - internal: false, - outputs: [ [Object], [Object] ] - }, - balance: 20000000 -} -``` - -You can then use the _accountId_ to identify the account via `AccountManager.getAccount(accountId)`. - -Read more about Events in the [API reference](../reference/nodejs.md#addeventlistenerevent-cb). diff --git a/docs/build/wallet.rs/0.1/docs/examples/python.mdx b/docs/build/wallet.rs/0.1/docs/examples/python.mdx deleted file mode 100644 index 74e9a454826..00000000000 --- a/docs/build/wallet.rs/0.1/docs/examples/python.mdx +++ /dev/null @@ -1,446 +0,0 @@ ---- -description: Official IOTA Wallet Library Software Python examples. -image: /img/logo/logo.svg -keywords: - - account - - address - - python - - balance - - Chrysalis - - reference ---- - -# Examples in Python - -In this section, you can find several examples that use the python binding of the `wallet.rs` library. You can also find examples of the code in the `/bindings/python/examples` folder of the [official GitHub repository](https://github.com/iotaledger/wallet.rs/tree/dev/bindings/python/examples). - -All the examples in this section expect you to set your custom password in the `.env` file: - -```bash -SH_PASSWORD="here is your super secure password" -``` - -## Account Manager and Individual Accounts - -You can initialize (open) a secure storage for individual accounts. The storage is backed up by `Stronghold` by default, using an AccountManager instance. - -The following example creates a new database and account: - -```python reference -https://github.com/iotaledger/wallet.rs/tree/production/bindings/python/examples/1a_create_account_manager.py -``` - -- Storage is initialized under the given path (`./alice-database`). -- The password is set based on your password in `.env` file (`manager.setStrongholdPassword(process.env.SH_PASSWORD)`). -- When you initialize the new database, a Stronghold mnemonic (seed) is automatically generated and stored by default (`manager.storeMnemonic(SignerType.Stronghold)`). -- The seed should be set only for the first time. You can open the initialized database by using your password. - -The storage is encrypted at rest, so you need a strong password and location where to place your storage. - -:::note - -We recommended you to store your `Stronghold` password encrypted on rest and separated from `Stronghold` snapshots. - -Manage your password with utmost care. - -::: - -The storage is made of: - -- A single file called _wallet.stronghold_ , which contains a _seed_ and is secured by `Stronghold` and encrypted at rest. The generated seed (mnemonic) serves as a cryptographic key from which all accounts and related addresses are generated. -- Other data used by the library that is stored under the _db_ sub-directory. This includes account information, generated addresses, fetched messages, etc. This data is used to speed up some operations, such as account creation, address generation, etc. - -One of the key principles behind `Stronghold` based storage is that no one can extract a seed from the storage. You deal with all accounts purely via an _AccountManager_ instance. All complexities are hidden under the hood and are dealt with securely. - -If you want to store a seed somewhere else, you can use the `AccountManager.generateMnemonic()` method. This method will generate a random seed, and it can be used before the actual account initialization. - -You can find detailed information about seed generation at [Developer Guide to Chrysalis](https://chrysalis.docs.iota.org/guides/dev_guide#seed). - -### Accounts - -The `wallet.rs` library uses a model of individual accounts to separate individual users and clients from each other. It is possible to generate multiple addresses for each account deterministically. - -Each account is related to a specific IOTA network (mainnet or devnet), which is referenced by node properties such as node url. In this example, it is the `Chrysalis` testnet balancer. - -For more information about _client_options_ , please refer to the [Wallet Python API Reference](../reference/python.md#clientoptions) section. - -```python reference -https://github.com/iotaledger/wallet.rs/tree/production/bindings/python/examples/1b_create_account.py -``` - -An _alias_ should be unique so it can be any string that you see fit. The _alias_ is usually used to identify the account later on. Each account is also represented by an _index_ which is incremented by 1 every time a new account is created. -Any account can be then referred to by its _index_ , _alias_ or one of its generated _addresses_ . - -Once an account has been created, you retrieve an instance of it using the following methods: - -- `get_account(account_id: str)` -- `get_accounts()` . - -You can get an overview of all available accounts by running the following snippet: - -```python -for acc in account_manager.get_accounts(): - print(f"Account alias: {acc.alias()}; network: {acc.bech32_hrp()}") -``` - -You can get and instance of a specific account using the `account_manager.get_account("ALIAS")`, replacing _"ALIAS"_ for the given alias: - -```python -account = account_manager.get_account("Alice") -``` - -Several API calls can be performed via an _account_ instance. - -:::note - -It is a good practice to sync the given _account_ with the Tangle every time you work with an _account_ instance to retrieve the latest information available. You can do this using the `account.sync()` method. By default, `account.sync()` is performed automatically on `send` , `retry` , `reattach` , and `promote` API calls. - -::: - -The most common methods of _account_ instance are: - -- `account.alias()` : returns an alias of the given account. -- `account.addresses()` : returns list of addresses related to the account. -- `account.get_unused_address()` : returns a first unused address. -- `account.is_latest_address_unused()` : queries the Tangle and returns a _bool_ whether latest address was already used. -- `account.generate_address()` : generates a new address for the address index incremented by 1. -- `account.balance()` : returns the balance for the given account. -- `account.sync()` : syncs the account information with the tangle. - -## Generating Address(es) - -Each _account_ can have multiple _addresses_ . _Addresses_ are generated deterministically based on the _account_ and _address_ index. This means that the combination of _account_ and index uniquely identifies the given address. - -There are two types of addresses, _internal_ and _public_ (external), and each set of addresses are independent of each other and have an independent _index_ id. - -- _Public_ addresses are created by `account.generateAddress()` and are indicated as `internal=false` (public) -- _Internal_ addresses are also called _change_ addresses. _Internal_ addresses are used to store the excess funds and are indicated as `internal=true`. - -This approach is also known as a _BIP32 Hierarchical Deterministic wallet (HD Wallet)_. - -:::note - -The IOTA 1.5 (Chrysalis) network supports reusing addresses multiple times. - -::: - -You can use the following example to generate a new address via an instance of _account_ which was retrieved using an _account_manager_ instance: - -```python reference -https://github.com/iotaledger/wallet.rs/tree/production/bindings/python/examples/2_generate_address.py -``` - -Example output: - -```js -[ - { - address: { - inner: 'atoi1qzy79ew8x4hn4dsr0t3j8ce8hdwdrh8xzx85x2gkse6k0fx2jkyaqdgd2rn', - }, - balance: 0, - key_index: 0, - internal: False, - outputs: [], - }, - { - address: { - inner: 'atoi1qzht4m2jt0q50lhlqa786pcx6vardm4xj8za72fezde6tj39acatq5zh2cg', - }, - balance: 0, - key_index: 1, - internal: False, - outputs: [], - }, -]; -``` - -There are two human-readable prefixes in IOTA 1.5 network: _iota_ (mainnet) and _atoi_ (devnet). If you take a close look at the addresses in the output, you will notice that both of them start with _atoi_ , and are therefore devnet addresses. - -You can find detailed information about generating addresses at the [Developer Guide to Chrysalis](https://chrysalis.docs.iota.org/guides/dev_guide#addresskey-space). - -## Checking the Balance - -Before we continue further, please visit the [IOTA devnet faucet service](https://faucet.chrysalis-devnet.iota.cafe/) and send some tokens to your devnet addresses. - -![IOTA Faucet Service](/img/libraries/screenshot_faucet.png) - -You can use the following example to sync your accounts and retrieve their balances. - -```python reference -https://github.com/iotaledger/wallet.rs/tree/production/bindings/python/examples/3_check_balance.py -``` - -Example output: - -```js -Total balance: -{ - 'total': 10000000, - 'available': 10000000, - 'incoming': 10000000, - 'outgoing': 0 -} - -Balance per individual addresses: -[{ - 'address': { - 'inner': 'atoi1qzy79ew8x4hn4dsr0t3j8ce8hdwdrh8xzx85x2gkse6k0fx2jkyaqdgd2rn' - }, - 'balance': 0, - 'key_index': 0, - 'internal': False, - 'outputs': [] - }, - { - 'address': { - 'inner': 'atoi1qzht4m2jt0q50lhlqa786pcx6vardm4xj8za72fezde6tj39acatq5zh2cg' - }, - 'balance': 10000000, - 'key_index': 1, - 'internal': False, - 'outputs': [{ - 'transaction_id': '1c88c91fe0a8eed074b5ccdfdad52403d7908d157b231ae1ef28b0e20ba14e8e', - 'message_id': 'f1575f984f7fda6e9b3e23e96ef3304fcd0ba4ce323af3920856a427fabe1abe', - 'index': 0, - 'amount': 10000000, - 'is_spent': False, - 'address': { - 'inner': 'atoi1qzht4m2jt0q50lhlqa786pcx6vardm4xj8za72fezde6tj39acatq5zh2cg' - } - }] - }, - { - 'address': { - 'inner': 'atoi1qpvnsgygzal4vkxhlc0ew7c6c6csnjr72x5rgn3txqswrsa2xfrec8v04f7' - }, - 'balance': 0, - 'key_index': 2, - 'internal': False, - 'outputs': [] - } -] -``` - -In the detailed view per individual addresses, there is also an _outputs_ section. The _outputs_ show all the transactions (also known as _wallet message(s)_ ), which are related to that _address_, and therefore account for the balance. - -You can also check the balance using the [Tangle Explorer](https://explorer.iota.org/devnet/addr/atoi1qzht4m2jt0q50lhlqa786pcx6vardm4xj8za72fezde6tj39acatq5zh2cg). - -:::note - -IOTA is based on _Unspent Transaction Output_ model. You can find a detailed explanation in the [Developer Guide to Chrysalis](https://chrysalis.docs.iota.org/guides/dev_guide#unspent-transaction-output-utxo). - -::: - -## Sending Tokens - -The process of sending tokens via _wallet.rs_ can be described as follows: - -1. Create instance of `iota_wallet.Transfer()` class with the following mandatory arguments: _amount_, _address_ and _remainder_value_strategy_ . - The _remainder_value_strategy_ argument can be either: - - - `ReuseAddress` - - `ChangeAddress` - -2. Once you have created an instance of `iota_wallet.Transfer()` , you can send the tokens using the `transfer()` function of the _Account_ instance. - -:::note - -We recommend that you sync the account information with the Tangle by running the `account.sync().execute()` method before doing anything with the account. This way, you can ensure that you rely on the latest available information. - -::: - -```python reference -https://github.com/iotaledger/wallet.rs/tree/production/bindings/python/examples/4_send.py -``` - -The previous snippet should have a similar output to the following JSON object: - -```js -{ - 'id': '9d3c401d59b0a87f6fbaa58582bb71e1858d63336421ccbae834821d9be113d3', - 'version': 1, - 'parents': ['66009ff08637c3e74340fb9e09e30e3c4453728c857fd425df2d2e0587af6426', - '6da392ac35f73594bf5509fb5c3304e972b36313ce98f2cc63def7cde2054b53', - '9157b29cbffcd5c9669cf22004fbc557354e5ade7268f5bfe25fbc75ab29e3b1', - 'bfe860e09350cd3b8db90611e78e03fdda654139a4b34e68e4b1bb07528b2bef' - ], - 'payload_length': 233, - 'payload': { - 'transaction': [{ - 'essence': { - 'regular': { - 'inputs': [{ - 'transaction_id': '692d6660084dd3b6341ef4f761bc8b8bb27ac35bb0b352bfb030f2c80753815b', - 'index': 0, - 'metadata': { - 'transaction_id': '692d6660084dd3b6341ef4f761bc8b8bb27ac35bb0b352bfb030f2c80753815b', - 'message_id': 'c6284e0cc2a6383474782d4e6b6cfaf16c1831c8875cca262982782758a248c0', - 'index': 0, - 'amount': 10000000, - 'is_spent': False, - 'address': { - 'inner': 'atoi1qq24vlx53qdskyfw6940xa2vg55ma5egzyqv6glq23udx3e0zkmmg97cwze' - } - } - }], - 'outputs': [{ - 'address': 'atoi1qq24vlx53qdskyfw6940xa2vg55ma5egzyqv6glq23udx3e0zkmmg97cwze', - 'amount': 9000000 - }, - { - 'address': 'atoi1qpvnsgygzal4vkxhlc0ew7c6c6csnjr72x5rgn3txqswrsa2xfrec8v04f7', - 'amount': 1000000 - } - ], - 'payload': None - } - }, - 'unlock_blocks': [{ - 'signature': { - 'public_key': [15... < TRIMMED > ...], - 'signature': [210... < TRIMMED > ...] - }, - 'reference': None - }] - }], - 'milestone': None, - 'indexation': None - }, - 'timestamp': 1615132552, - 'nonce': 274654, - 'confirmed': None, - 'broadcasted': True, - 'incoming': False, - 'value': 1000000, - 'remainder_value': 9000000 -}} -``` - -This is a _wallet message_ that fully describes the given transaction. - -To understand all aspects of messages, you will need to get familiar with concept of _UTXO_ . You can find detailed information in the [UTXO section in the Developer Guide to Chrysalis](https://chrysalis.docs.iota.org/guides/dev_guide#unspent-transaction-output-utxo). - -You can double-check the message using [Tangle Explorer](https://explorer.iota.org/) using its _node_response['id']_. Please make sure you select the right network. - -If you have used the _ChangeAddress remainder_value_strategy_, the message will transfer tokens to the target address as well as new _internal_ address within the given account (`internal=True`). - -You can find detailed information about messages and payloads in the [Developer Guide to Chrysalis](https://chrysalis.docs.iota.org/guides/dev_guide#messages-payloads-and-transactions). - -### Reattachments - -If you need to reattach a message, you should use the [`iota_wallet.promote(account_id, message_id)`](../reference/python.md#promoteaccount_id-message_id-walletmessagewalletmessage) or [`iota_wallet.reattach(account_id, message_id)`](../reference/python.md#reattachmessage_id-walletmessagewalletmessage) methods, sending your _account_id_ and _message_id_ as arguments. - -### List of Messages (transactions) - -You can query for a list of all particular messages (transactions) related to the given account using [`account.list_messages()`](../reference/python.md#list_messagescount-from-message_type-optional-listwalletmessagewalletmessage) method, and the related [`account.message_count()`](../reference/python.md#message_countmessage_type-optional-int) method. - -You can use those methods to check whether a message is confirmed, broadcast, etc. You should always _Sync_ the account with the Tangle before checking the confirmation status. - -You can use the following example to _sync_ an _account_ , and list all the messages related to the _account_ . - -```python reference -https://github.com/iotaledger/wallet.rs/tree/production/bindings/python/examples/4b_list_messages.py -``` - -### Dust Protection - -The network uses a [dust protection](https://chrysalis.docs.iota.org/guides/dev_guide#dust-protection) protocol to prevent malicious actors from spamming the network while also keeping track of the unspent amount ( _UTXO_ ). - -:::note - -“... micro-transactions below 1Mi of IOTA tokens can be sent to another address if there is already at least 1Mi on that address. -That's why we sent 1Mi in the last example to comply with the protection.” - -::: - -Dust protection also means you can not leave less than 1Mi on a spent address (leave a dust behind). - -## Backup Database - -Due to security practices that are incorporated in the `Stronghold's` DNA, there is no way to retrieve a seed, as seeds are encrypted at rest. Therefore, if you are using the default options, backing up the seed storage is a very important task. - -The following example will guide you in backing up your data in secure files. You can move this file to another app or device, and restore it. - -```python reference -https://github.com/iotaledger/wallet.rs/tree/production/bindings/python/examples/5_backup.py -``` - -Output: - -```plaintext -Backup path: ./backup/2021-03-07T18-24-06-iota-wallet-backup-wallet.stronghold -``` - -Alternatively, you can create a copy of the _wallet.stronghold_ file and use it as seed backup. This can be achieved by a daily [_cronjob_](https://linux.die.net/man/1/crontab), [_rsync_](https://linux.die.net/man/1/rsync) or [_scp_](https://linux.die.net/man/1/scp) with a datetime suffix for example. - -## Restore a Database - -To restore a database via `wallet.rs`, you will need to: - -1. Create new empty database with a password (without mnemonic seed). -2. Import all accounts from the file that has been backed up earlier. - -The following example restores a secured backup file: - -```python reference -https://github.com/iotaledger/wallet.rs/tree/production/bindings/python/examples/6_restore.py -``` - -Since the backup file is just a copy of the original database, it can be also be renamed to _wallet.stronghold_ and opened in a standard way. - -```python -account_manager = iw.AccountManager( - storage_path='./alice-database' -) -account_manager.set_stronghold_password("password") -``` - -## Listening to Events - -The `wallet.rs` library can listen to several supported events. As soon as the event occurs, a provided callback will be triggered. - -You can add any of the following event listeners: - -- `on_balance_change(callback): id` . -- `on_new_transaction(callback): id` . -- `on_confirmation_state_change(callback): id` . -- `on_reattachment(callback): id` . -- `on_broadcast(callback): id` . -- `on_error(callback): id` . -- `on_stronghold_status_change(callback): id` . - -Once you have registered an event listener, the function will return an _id_ for the listener as a list [Bytes]. -You can later use this _id_ to remove a listener by using the corresponding method described below: - -- `remove_balance_change_listener(id)` . -- `remove_new_transaction_listener(id)` . -- `remove_confirmation_state_change_listener(id)` . -- `remove_reattachment_listener(id)` . -- `remove_broadcast_listener(id)` . -- `remove_error_listener(id)` . -- `remove_stronghold_status_change_listener(id)` . - -The following example sets up a listener for the _on_balance_change_ event using an event-based pattern: - -```python reference -https://github.com/iotaledger/wallet.rs/tree/production/bindings/python/examples/7b_event_simple_event.py -``` - -Expected output: - -```plaintext -Account: Alice -Syncing... -Address: {'inner': 'atoi1qquszp0hzfsrgx4vx58dfg4v6eh20d2k3ddfgg9dt5778c2egc9uyw7g457'} -Fill your address with the Faucet: https://faucet.chrysalis-devnet.iota.cafe/ -Waiting for external event (on_balance_changed)... -On balanced changed: {"indexationId":"c3a7a1ab8ba78460954223a704693d088ddd0388681ac6cc1dd964a388d1a619","accountId":"wallet-account://e51a6285ea2d8cbdf5b6da2b85a8344f619d798d869ef4fb88c5fac0e653d6cc","address":"atoi1qquszp0hzfsrgx4vx58dfg4v6eh20d2k3ddfgg9dt5778c2egc9uyw7g457","balanceChange":{"spent":0,"received":10000000}} -Done. -``` - -Alternatively, events can be consumed via queue-base pattern as shown in the following example: - -```python reference -https://github.com/iotaledger/wallet.rs/tree/production/bindings/python/examples/7_event_queue.py -``` diff --git a/docs/build/wallet.rs/0.1/docs/examples/rust.mdx b/docs/build/wallet.rs/0.1/docs/examples/rust.mdx deleted file mode 100644 index 71c76bd7905..00000000000 --- a/docs/build/wallet.rs/0.1/docs/examples/rust.mdx +++ /dev/null @@ -1,107 +0,0 @@ ---- -description: Official IOTA Wallet Library Software Rust examples. -image: /img/logo/logo.svg -keywords: - - account - - event - - Rust - - transfer - - backup - - how to ---- - -# Examples in Rust - -The examples for wallet.rs are located in the library's repository. To get access to them, clone the `wallet.rs` repository: - -```bash -git clone -b production https://github.com/iotaledger/wallet.rs.git -cd wallet.rs -``` - -You can list all available examples by running the following command: - -```bash -cargo run --example # lists the available examples -``` - -To run an example, you can use the following command, replacing _transfer_ with the desired example: - -```bash -cargo run --example transfer # execute the `transfer` example -``` - -You can find all examples in the `examples` subfolder of the project. - -## Backup and Restore - -1. Create an account manager and set a password: - -```rust -let manager = AccountManager::builder().finish().await.unwrap(); - -manager.set_stronghold_password("password").await.unwrap(); -manager.store_mnemonic(SignerType::Stronghold, None).await.unwrap(); -``` - -2. Create your account: - -```rust -let client_options = ClientOptionsBuilder::new() - .with_node("https://api.lb-0.h.chrysalis-devnet.iota.cafe")? - .build() - .unwrap(); -let account_handle = manager - .create_account(client_options)? - .alias("alias") - .initialise() - .await?; -let id = account_handle.id().await; -``` - -3. You can secure your account in a backup file: - -```rust -// backup the stored accounts to ./backup/${backup_name} -let backup_path = manager.backup("./backup").await?; - -``` - -4. You can import the backup later, or in another application using the following snippet: - -```rust -manager.import_accounts(backup_path, "password").await?; - -let imported_account_handle = manager.get_account(&id).await?; - -let account = account_handle.read().await; -let imported_account = imported_account_handle.read().await; -``` - -That's it! You can now backup and restore your account! - -You can see the full code for the example in the [`wallet.rs` repository](https://github.com/iotaledger/wallet.rs/blob/production/examples/backup_and_restore.rs) - -## Transfer - -You use the following example to generate an account and transfer funds. - -```rust reference -https://github.com/iotaledger/wallet.rs/tree/production//examples/transfer.rs -``` - -## Events - -`wallet.rs` library is able to listen to several supported event. As soon as the event occurs, a provided callback will be triggered. - -You can use the following example to fetch an existing _Account_ and listen to transaction events related to that _Account_ : - -```rust reference -https://github.com/iotaledger/wallet.rs/tree/production/examples/event.rs -``` - -## Logger - -```rust reference -https://github.com/iotaledger/wallet.rs/tree/production/examples/logger.rs -``` diff --git a/docs/build/wallet.rs/0.1/docs/explanations/nutshell.md b/docs/build/wallet.rs/0.1/docs/explanations/nutshell.md deleted file mode 100644 index 953993510f8..00000000000 --- a/docs/build/wallet.rs/0.1/docs/explanations/nutshell.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -description: The `wallet.rs` library is written in Rust. You can also find three bindings written in Node.js, Python, and Java. -image: /img/logo/logo.svg -keywords: - - bindings - - library - - rust - - python - - java - - node.js - - account - - multiple - - explanation ---- - -# The Wallet Library in a Nutshell - -The `wallet.rs` library uses an account model so you can create an account for each of your users. You can also take another approach and use one account and generate many addresses to link your users in your database. - -Using the library allows you to assign a meaningful alias to each account. Users may also segregate their funds across multiple accounts or multiple addresses. It is up to a developer to choose a single-account approach or a multi-account approach. - -The library is based on a [derivation for multiple accounts from a single seed](https://chrysalis.docs.iota.org/guides/dev_guide#addresskey-space). An account is a deterministic identifier from which multiple addresses can be further derived. - -Below you will see the relationships between seeds, accounts, and addresses. A single seed can contain multiple accounts. Each account can also have multiple addresses which can be linked to users in your database. - -![Seed, accounts and Addresses](/img/libraries/address_generation.svg) diff --git a/docs/build/wallet.rs/0.1/docs/getting_started/java.md b/docs/build/wallet.rs/0.1/docs/getting_started/java.md deleted file mode 100644 index 60bf244685e..00000000000 --- a/docs/build/wallet.rs/0.1/docs/getting_started/java.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -description: Getting started with the official IOTA Wallet Library Java binding. -image: /img/logo/iota_mark_light.png -keywords: - - Java - - Rust - - jar - - maven - - environment variable - - getting started ---- - -# Getting Started with Java - -## Prerequisites - -To use the library, we recommend you update Rust to the latest stable version [`$ rustup update stable`](https://github.com/rust-lang/rustup.rs#keeping-rust-up-to-date). Nightly should be fine but some changes might not be compatible. - -Ensure you have installed the [required dependencies for the library](https://github.com/iotaledger/wallet.rs/blob/dev/README.md) first. Then, you can also install the following programs: - -- Java & JDK (Make sure $JAVA_HOME env variable is set). -- [Gradle](https://gradle.org/install/) v4 or higher or [Maven](https://maven.apache.org/download.cgi). -- Cargo ndk (`cargo install cargo-ndk`). -- Cargo fmt (`rustup component add rustfmt`). - -Download or clone the `wallet.rs` repository: - -```bash -git clone -b production https://github.com/iotaledger/wallet.rs.git -``` - -## Security - -In a production setup, do not store passwords in the host's environment variables or in the source code. See our [backup and security recommendations](https://chrysalis.docs.iota.org/guides/backup_security) for production setups. - -## Installation - -To build using the Wallet.rs Java bindings, you will need: - -1. JNI Native library linking `Rust` to `C`, and then `C` to java `native` methods (`.so` , `.dll` or `.dylib` depending on your system). -2. Java archive(Jar) containing `native` methods which call C code. (`.jar`). - -### Step 1: Creating the Native Library - -Build the wallet library (this generates the java source code and JNI library file): - -```bash -cd wallet.rs/bindings/java -cargo build --release -``` - -You can find the generated binaries in `wallet.rs/bindings/java/target/release`. - -:::note - -Compiling for Android requires additional compilation instructions. - -You can find these instructions in [Getting Started with Java for Android](java_for_android.md). -::: - -### Step 2: Creating the Java Archive - -#### Generating the source files and classes - -After you complete step 1, you can find the Java generated source files under `wallet.rs/bindings/java/native/src/main/java/org/iota/wallet`. - -If this step succeeds, you need to generate the jar file containing the newly generated Java source files. - -#### Generating the jar - -You can generate the jar file with your tool of preference. This guide provides examples for Gradle and Maven. - -##### Gradle - -Make `gradlew` executable (`chmod +x gradlew`) if needed, then run the following commands from the project root: - -```bash -cd wallet.rs/bindings/java -./gradlew jar -``` - -##### Maven - -```bash -cd wallet.rs/bindings/java -mvn install -``` - -After running one of these commands, you can find the jar file at `wallet.rs/bindings/java/native/build/libs/native.jar` - -## Usage - -You can find more information on using the `wallet.rs` library's java binding in the [examples section](../examples/java.md). - -### Gradle - -```` -./gradlew examples:java-app:test --info -```bash - -### Maven - -You can run the examples using Maven by running the following command: - - -```bash -mvn exec:exec -```` - -## API Reference - -You can find the references for the binding's API in the [Java API Reference](../reference/java.mdx) section. - -## Limitations - -Due to the fact that tje Java binding through C to Rust, there are a few limiting factors. - -- Classic builder patterns return a `clone` after each builder call since we can only pass back to C by reference in `Rust` as shown in the example below. - -```Java -Builder builder1 = new Builder(); -Builder builder2 = builder1.setValue(true); - -// These are different instances, thus builder1 wont have the value set -assertNotEquals(builder1, builder2); -``` diff --git a/docs/build/wallet.rs/0.1/docs/getting_started/java_for_android.md b/docs/build/wallet.rs/0.1/docs/getting_started/java_for_android.md deleted file mode 100644 index ecdb744ef12..00000000000 --- a/docs/build/wallet.rs/0.1/docs/getting_started/java_for_android.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -description: Official IOTA Wallet Library Java API reference. -image: /img/logo/iota_mark_light.png -keywords: - - api - - Java - - android - - cross - - compile - - getting started ---- - -# Getting Started with Java for Android - -Android development requires a more specific environment setup. In this tutorial we will guide you through the various ways to build an APK with `wallet.rs` capabilities. - -The first part of this tutorial shows you how to install the required tools for building an apk. Scroll [down](#using-pre-generated-binaries) for a guide using the precompiled binaries found on our release page [here](https://github.com/iotaledger/wallet.rs/releases). The Java releases are tagged with `android-binding-vX.Y.Z`. - -:::info -Since Android development mainly uses Gradle, we will use that for this tutorial -::: - -## Setup by Compiling - -Compiling an Android app comes with the added task of building for multiple different device architectures. -In this tutorial we mention the following 2 variables: -`$ARCH` and `$TARGET`. - -These variables are used to generate correct binaries during cross compilation and linking. - -#### List of Target Devices - -`$ARCH` and -> `$TARGET` related to each other in the following manner: - -- `armeabi-v7a` -> `armv7-linux-androideabi` -- `arm64-v8a` -> `aarch64-linux-android` -- `x86` -> `i686-linux-android` -- `x86_64` -> `x86_64-linux-android` - -When building an app, you as a developer must decide for how many architectures you make an APK for. Binaries need to be generated for each architecture. - -The android-app example has a [build.gradle](https://github.com/iotaledger/wallet.rs/blob/production/bindings/java/examples/android-app/build.gradle) file that shows the enabled list in a variable called `archTriplets`. You can disable and enable them, as long as you have at least one. (This file will also automatically compile our binaries when we run gradle. Feel free to use it in your project!) - -We will use `archTriplets` for the enabled list of device targets during this tutorial. - -## Prerequisite - -- Dependencies indicated in the [Prerequisites](./java.md#prerequisites) section of Getting Started with Android. -- Android NDK or Android Studio with NDK installed (If you extract make sure to make it executable `chmod -R +x android-ndk-VERSION` ) - -In order to cross compile the binaries for Android; we need the following target toolchains: (Or all of the enabled `archTriplets`) - -``` -rustup target add \ - armv7-linux-androideabi \ - aarch64-linux-android \ - i686-linux-android \ - x86_64-linux-android -``` - -For this setup we use `$ANDROID_NDK_HOME` for the location of your NDK, wether you use Android studio or manual compilation - -1. set `ANDROID_NDK_HOME` environment variable - -Example: `export ANDROID_NDK_HOME=$ANDROID_HOME/ndk/{A_VERSION_NUMBER}` - -If you dont have `ANDROID_HOME`; Usually found at `/home/user/Android`. Make sure you have installed Android correctly. -Attempt to run `android` on your terminal. If this command does not open the Android SDK Manager, then your path is not configured correctly. - -## 1. Generating the Java Files - -### 1.1 Compiling Binaries - -In order to generate the Java source files; we need to run cargo manually once. - -This step will require you to run `cargo build --release` in `wallet.rs/bindings/java`. - -:::info -This step is simplifying the process by running an unnecesary build (We compile here for our current system). If you have a working environment already, you can run cargo with a `--target=$TARGET` to save time later on. -::: - -### 1.2 Creating the `jar` File - -Afterwards, you need to run `./gradlew jar` in `wallet.rs/bindings/java` in order to generate the jar file. - -The jar will be found at `wallet.rs/bindings/java/native/build/libs/native.jar` - -## 2. Building the App - -Building the actual app can be done through two different ways. Using Android Studio and by manual linking. - -The following 2 Sections describe both methods. - -#### Cross-compiling - -In order to build on windows, we need to add android triplets to our VCPKG and use that during compilation. -[TODO] - -Currently cross compiling has only worked on WSL/Linux. -If you wish to use Android Studio in Windows, first make the android target binaries in WSL/Linux, then copy them over to `src/main/jniLibs/$TARGET/`. (See step [Compiling a binary](#Adding%20shared%20library), but do that for each enabled target in WSL/Linux) - -Afterwards you need to comment out all `archTriplets` in `build.gradle` in order for you not to regenerate them (and fail on Windows). - -### 2.1 Android Studio - -Load the project under the `wallet.rs/bindings/java` folder in Android studio. - -Make sure you have an NDK and SDK: `file->Project Structure->SDK Location`. If the NDK location is marked grey, edit the `local.properties` like so: (This must be the location of `$ANDROID_NDK_HOME`, which still needs to be on your path) - -``` -ndk.dir=I\:\\Path\\To\\AndroidSDK\\ndk\\VERSION -``` - -If youre on linux/wsl, just run the app. On other platforms see the `Setup/Cross compile note` before running. - -### 2.2 Manual Linking - -#### Preparing Your Environment - -Add the standalone toolchain to the search path. - -Example: `export PATH=$PATH:$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/{OS}/bin` - -Replace `{OS}` with your OS name; on Linux this would be called `linux-x86_64`, windows `windows-x86_64` (`x86_64`depening on architecture type) - -These toolchains can alternatively be prepended to the cargo command as well, but we wont discuss that in this tutorial. - -#### Setting Up the Cargo Config - -In order to compile the binaries for the various Android targets, we need to specify the targets to rust. - -Create or update the following file: `~/.cargo/config`. -Replace each instance of `$ANDROID_NDK_HOME` with the actual location (variables do not work) and add the text below to the config file. - -``` -[target.armv7-linux-androideabi] -linker = "$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin/armv7a-linux-androideabi21-clang" -ar = "$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin/arm-linux-androideabi-ar" - -[target.aarch64-linux-android] -linker = "$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin/aarch64-linux-android21-clang" -ar = "$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin/aarch64-linux-android-ar" - -[target.i686-linux-android] -linker = "$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin/i686-linux-android21-clang" -ar = "$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin/i686-linux-android-ar" - -[target.x86_64-linux-android] -linker = "$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin/x86_64-linux-android21-clang" -ar = "$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin/x86_64-linux-android-ar" -``` - -#### Generating the Binaries - -Now we need to generate binaries for all the enabled targets inside your `build.gradle` `archTriplets`. -The easiest way is to use the gradle build system. Using the `build.gradle` inside `examples/android-app`, we automatically build all enabled targets after running the following: - -``` -cd wallet.rs/bindings/java -./gradlew build -``` - -Alternatively, you can also manually run the commands; - -1. Compile the binaries for the target - -Example: `cargo build --target aarch64-linux-android --release` - -2. Adding shared library - -> Copy `$ANDROID_NDK_HOME/sources/cxx-stl/llvm-libc++/libs/$ARCH/libc++_shared.so` to `src/main/libs/$ARCH/` - -Example: `cp $ANDROID_NDK_HOME/sources/cxx-stl/llvm-libc++/libs/arm64-v8a/libc++_shared.so examples/android-app/src/main/libs/arm64-v8a` - -#### Building Your App - -Assemble your android app with gradle using: - -``` -cd wallet.rs/bindings/java -./gradlew aR -``` - -#### Signing Your App - -1. prepare a signing keystore; we will call it `signed_ks.jks` - - > How to make: https://developer.android.com/studio/publish/app-signing#generate-key - -2. Sign the apk - -> `$ANDROID_HOME/build-tools/{VERSION}/apksigner sign --ks examples/android-app/signed_ks.jks --out examples/android-app/android-app-release-signed.apk -v examples/android-app/build/outputs/apk/release/android-app-release-unsigned.apk` - -3. Connect device - > https://developer.android.com/studio/command-line/adb#connect-to-a-device-over-wi-fi-android-11+ - -For example: - -- `adb pair 192.168.0.x:x` -- `adb connect 192.168.0.x:x` -- `adb install -r --fastdeploy examples/android-app/android-app-release-signed.apk` -- `adb shell am monitor` - -## Using Pre-Generated Binaries - -It is very likely you dont want or need to compile by yourself. That is why we provide precompiled binaries found on our release page [here](https://github.com/iotaledger/wallet.rs/releases). The Java releases are tagged with `android-binding-vX.Y.Z`. - -Install the files attached to the release so that you achieve the following directory structure: (extract the `jniLibs.zip` into `root_app/src/main/`) - -``` -root_app/src/main/ - libs/ - native.jar - jniLibs/ - arm64-v8a/ - libc++_shared.so - libiota_wallet_java.so - armeabi-v7a/ - libc++_shared.so - libiota_wallet_java.so - x86/ - libc++_shared.so - libiota_wallet_java.so - x86_64/ - libc++_shared.so - libiota_wallet_java.so -``` - -### Android Studio - -Then using Android Studio, add the native.jar to your project by right clicking -> Add As Library... -> Select your Android app Module and press OK. - -### Manual - -Add the jar to your `build.gradle` dependencies section using; for example: `implementation files('src\\main\\libs\\native.jar')` - -:::info -When trying to build the `android-app` example in the repository with precompiled binaries, comment out all the `archTriplets` inside `wallet.rs/bindings/java/examples/android-app/build.gradle`. (Otherwise you will try to regenerate the `.so` files) -::: diff --git a/docs/build/wallet.rs/0.1/docs/getting_started/nodejs.mdx b/docs/build/wallet.rs/0.1/docs/getting_started/nodejs.mdx deleted file mode 100644 index 75ef7e07f3f..00000000000 --- a/docs/build/wallet.rs/0.1/docs/getting_started/nodejs.mdx +++ /dev/null @@ -1,159 +0,0 @@ ---- -description: Getting started with the official IOTA Wallet Library Software Node.js binding. -image: /img/logo/logo.svg -keywords: - - Node.js - - dotenv - - install - - npm - - yarn - - security - - getting started ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -# Getting Started with Node.js - -:::note - -You can find a guide for exchanges and the most common use cases in the [Chrysalis documentation](/introduction/how_tos/exchange/), which is based on `wallet.rs` and `Node.js`. - -::: - -The [IOTA Wallet Node.js binding](https://www.npmjs.com/package/@iota/wallet) is published on [npmjs.com](https://www.npmjs.com/). - -The [code examples](../examples/nodejs.mdx) use _dotenv_ for password management. - -## Requirements - -You can use the following links to install any of the requirements. - -| Requirement | Version | -| --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [Node.js](https://nodejs.org/en/) | [14.x](https://nodejs.org/download/release/latest-v14.x/), [16.x](https://nodejs.org/download/release/latest-v16.x/), or [18.x - LTS](https://nodejs.org/download/release/latest-v18.x/) | -| Your package manager of choice | [npm](https://www.npmjs.com/) or [Yarn](https://yarnpkg.com/) | - -## Install the Library - -Since wallet.rs is also used to communicate with nodes in the [Shimmer network](/get-started/introduction/shimmer/introduction) -that runs the [Stardust protocol](/introduction/welcome), if you plan to use the library -in the [IOTA network](/learn/about-iota/an-introduction-to-iota/) with the -[Chrysalis protocol](/introduction/welcome/), you will need to install the latest `1.x.x` version. - - - - -```bash -npm i @iota/wallet@1.0.17 -``` - - - - -```bash -yarn install @iota/wallet@1.0.17 -``` - - - - -## Build the Library - -If you prefer, you can build the library from source instead of [installing it](#install-the-library). **This process is -more complex than simply installing the library.** - -### Clone the Repository - -The first thing you will need to build the library from source is: - -1. Clone the repository: - -```bash -git clone git@github.com:iotaledger/wallet.rs.git -``` - -2. Move into the project's directory: - -```bash -cd wallet.rs -``` - -3. Checkout the `production` branch, or any `1.x.x` [tag](https://github.com/iotaledger/wallet.rs/tags): - -```bash -git checkout production -``` - -### Install the Library's Dependencies - -Once you have [cloned the repository](#clone-the-repository), you can proceed to install the library's dependencies: - -1. Move into the Node.js binding directory: - -```bash -cd bindings/nodejs -``` - -2. Install the dependencies with your package manager of choice: - - - - -```bash -npm i -``` - - - - -```bash -yarn -``` - - - - -### Build the Library - -Once you have installed the library's dependencies, you can proceed to install the library. The [`install`](https://github.com/iotaledger/wallet.rs/blob/production/bindings/nodejs/package.json#L16) -script will install any necessary dependencies and then proceed to build the library and create the necessary packages. - - - - -```bash -npm run install -``` - - - - -```bash -yarn install -``` - - - - -## Use the Library - -:::warning Safe password Storage - -In a production setup, do not store passwords in the host's environment variables or in the source code. For reference, see our [backup and security recommendations](/introduction/how_tos/backup_security/) for production setups. - -::: - -To use the library, you simply need to create an [`AccountManager`](../reference/nodejs.md#accountmanager) from -the `@iota/wallet` package in your application as shown in the example on line 8 of the example below. - -:::tip More Examples - -You can find more examples using the `wallet.rs` library's node.js binding in the [examples section](../examples/nodejs.mdx). - -::: - -```js reference -https://github.com/iotaledger/wallet.rs/tree/production/bindings/nodejs/examples/binding_examples/1-create-account.js -``` diff --git a/docs/build/wallet.rs/0.1/docs/getting_started/python.md b/docs/build/wallet.rs/0.1/docs/getting_started/python.md deleted file mode 100644 index 01bf6881591..00000000000 --- a/docs/build/wallet.rs/0.1/docs/getting_started/python.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -description: Getting started with the official IOTA Wallet Library Software Python binding. -image: /img/logo/logo.svg -keywords: - - Python - - install - - pip - - unpack - - getting started ---- - -# Getting Started with Python - -## Security - -:::note - -In a production setup, do not store passwords in the host's environment variables or in the source code. For reference, review our [backup and security recommendations](/introduction/how_tos/backup_security/) for production setups. -::: - -## Requirements - -- [Python 3.x](https://www.python.org). -- [pip](https://pypi.org/project/pip). - -## Installation - -### Install prebuild libraries - -To get the python binding working, you need to leverage pre-built python libraries for linux, MacOs, or Windows. You can install these to your python environment (3.6+) using _pip_ . The binding is automatically generated using [GitHub actions](https://github.com/iotaledger/wallet.rs/actions/workflows/python_binding_publish.yml). - -You can download the latest artifacts for a major python version using the [nighly.link service](https://nightly.link/iotaledger/wallet.rs/workflows/python_binding_publish/production). - -1. Download zip file for the given os and pyversion. -2. Unpack wheel file ( _.whl_ ). -3. Install it via _pip_ by running the following command: - -```bash -pip install -``` - -### Install from source - -### Additional Requirements - -- [Rust and Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html). -- (for Linux only) `libudev`. You can install it with `apt install libudev-dev`. - -#### Clone the Repository - -You can clone the wallet.rs client library by running the following command: - -```bash -git clone -b production https://github.com/iotaledger/wallet.rs -``` - -#### Change to the Python Binding Directory - -After you have cloned the repository, you should change directory to `wallet.rs/bindings/python/native`. You can do so by running the following command: - -```bash -cd wallet.rs/bindings/python/native -``` - -#### Install the Required Dependencies and Build the Wheel - -Install and run maturin: - -```bash -pip3 install maturin -maturin develop -maturin build --manylinux off -``` - -The wheel file is now created in `bindings/python/native/target/wheels`. You can install it with: - -```bash -pip3 install [THE_BUILT_WHEEL_FILE] -``` - -Once it has been installed, you can double-check the installation using _pip_ : - -```bash -pip list -``` - -The pip list should now include the _iota-wallet-python-binding_: - -```plaintext -Package Version --------------------------- ------- -iota-wallet-python-binding 0.1.0 -``` - -Once your python environment has installed the `iota-wallet-python-binding`, you can start developing using the python binding. - -## Usage - -To use the _iota_wallet_ you will need to add an import statement: - -```python -import iota_wallet -``` - -If you'd like more information on the _iota_wallet_, you can print the documentation using the following snippet: - -```python -print(iota_wallet.__doc__) -``` diff --git a/docs/build/wallet.rs/0.1/docs/getting_started/rust.mdx b/docs/build/wallet.rs/0.1/docs/getting_started/rust.mdx deleted file mode 100644 index f9652f4f8ea..00000000000 --- a/docs/build/wallet.rs/0.1/docs/getting_started/rust.mdx +++ /dev/null @@ -1,133 +0,0 @@ ---- -description: Getting started with the official IOTA Wallet Library Software Rust library. -image: /img/logo/logo.svg -keywords: - - Rust - - install - - cargo - - system environment variables - - getting started ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -# Getting Started with Rust - -You download the source code for the wallet.rs library from the [official GitHub repository](https://github.com/iotaledger/wallet.rs). - -## Prerequisites - -You will need to install _Rust_ and _Cargo_ to use wallet.rs. You can find installation instructions in the [Rust documentation](https://doc.rust-lang.org/cargo/getting-started/installation.html). - -We recommend you update _Rust_ to the [latest stable version](https://github.com/rust-lang/rustup.rs#keeping-rust-up-to-date). The nightly version should be fine, but there is a chance some changes are not compatible. - -[_no_std_](https://docs.rust-embedded.org/book/intro/no-std.html) is not currently supported, but we are working on it, and we will provide it as a feature once the new implementation is ready. - -### Dependencies - -[_cmake_](https://cmake.org/documentation/) and [_openssl_](https://www.openssl.org/docs/) are required to run Rust. To run the build process successfully using Cargo, you may need install additional build tools onto your system. - - - - -You can download _cmake_ from the [official cmake website](https://cmake.org/download/). -You can install _openssl_ with [vcpkg](https://github.com/microsoft/vcpkg) or -[chocolatey](https://chocolatey.org/). - - - - -```bash -choco install openssl -# you may need to set the OPENSSL_ROOT_DIR environment variable -set OPENSSL_ROOT_DIR="C:\Program Files\OpenSSL-Win64" -``` - - - - -```bash -./vcpkg.exe install openssl:x64-windows -./vcpkg.exe integrate install -# you may want to add this to the system environment variables since you'll need it to compile the crate -set VCPKGRS_DYNAMIC=1 -``` - - - - - - -You can install _cmake_ and _openssl_ with [_Homebrew_](https://docs.brew.sh/) by running the following -commands: - -```bash -brew install cmake -brew install openssl@1.1 -# you may want to add this to your .zshrc or .bashrc since you'll need it to compile the crate -OPENSSL_ROOT_DIR=$(brew --prefix openssl@1.1) -``` - - - - -You can install _cmake_ and _openssl_ with your distro's package manager or download them from their websites. -On Debian and Ubuntu, you will also need the -[_build-essential_](https://packages.debian.org/sid/build-essential) package. - - - - -## Use the Library - -### Add wallet.rs as a Dependency - -If you simply want to use the library, you only need to add this lines your _Cargo.toml_ file: - -``` -[dependencies] -iota-wallet = { git = "https://github.com/iotaledger/wallet.rs", branch = "production" } -``` - -### Enable Asynchronous Functionality - -The example below requires asynchronous functionality. You can enable it by adding the following line as a dependency: - -``` -tokio = { version = "1", features = ["full"] } -``` - -### Initialize the Library - -To use the library, you first need to create an `AccountManager`, as shown on lines 7 through 10 in the following example. - -After you have created your `AccountManager` you can use it interact with a node, for example the public devnet at `https://api.lb-0.h.chrysalis-devnet.iota.cafe`. - -```rust {7-10} showLineNumbers -use iota_wallet::{account_manager::AccountManager, client::ClientOptionsBuilder, signing::SignerType}; -use std::path::PathBuf; - -#[tokio::main] -async fn main() -> iota_wallet::Result<()> { - let storage_folder: PathBuf = "./my-db".into(); - let manager = AccountManager::builder() - .with_storage(&storage_folder, None)? - .finish() - .await?; - manager.set_stronghold_password("password").await?; - // If no mnemonic is provided, then the Stronghold file is the only way for a backup - manager.store_mnemonic(SignerType::Stronghold, None).await?; - let client_options = ClientOptionsBuilder::new() - .with_node("https://api.lb-0.h.chrysalis-devnet.iota.cafe")? - .build()?; - let account = manager - .create_account(client_options)? - .signer_type(SignerType::Stronghold) - .initialise() - .await?; - let address = account.generate_address().await?; - println!("Address: {}", address.address().to_bech32()); - Ok(()) -} -``` diff --git a/docs/build/wallet.rs/0.1/docs/overview.md b/docs/build/wallet.rs/0.1/docs/overview.md deleted file mode 100644 index 3a4ea27aa49..00000000000 --- a/docs/build/wallet.rs/0.1/docs/overview.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -description: The wallet library is a stateful package with a standardized interface for developers to build applications involving IOTA value transactions. -image: /img/logo/logo.svg -keywords: - - layered overview - - high level - - low level - - stronghold - - value transactions - - explanation ---- - -# Overview - -The wallet library is a stateful package with a standardized interface for developers to build applications involving IOTA value transactions. It provides abstractions to handle IOTA payments and can optionally interact with the [IOTA Stronghold enclave](https://github.com/iotaledger/stronghold.rs/) for seed handling, seed storage, and state backup. - -You can read about our specs in detail in our [Engineering Specs Doc](https://github.com/iotaledger/wallet.rs/blob/dev/specs/wallet-ENGINEERING-SPEC-0000.md). - -## High Level Layered Overview - -![High Level Layered Overview](/img/overview/iota_layers_overview.svg) diff --git a/docs/build/wallet.rs/0.1/docs/reference/java.mdx b/docs/build/wallet.rs/0.1/docs/reference/java.mdx deleted file mode 100644 index a076458814f..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java.mdx +++ /dev/null @@ -1,524 +0,0 @@ ---- -title: Java API Reference -description: Official IOTA Wallet Library Java API reference. -image: /img/logo/iota_mark_light.png -keywords: - - api - - Java - - param - - type - - endpoint - - builder - - reference ---- - -import Account from './java_api/Account.mdx'; -import AccountBalance from './java_api/AccountBalance.mdx'; -import AccountInitialiser from './java_api/AccountInitialiser.mdx'; -import AccountManager from './java_api/AccountManager.mdx'; -import AccountManagerBuilder from './java_api/AccountManagerBuilder.mdx'; -import AccountSignerType from './java_api/AccountSignerType.mdx'; -import AccountSynchronizer from './java_api/AccountSynchronizer.mdx'; -import AccountsSynchronizer from './java_api/AccountsSynchronizer.mdx'; -import Actor from './java_api/Actor.mdx'; -import ActorCallback from './java_api/ActorCallback.mdx'; -import Address from './java_api/Address.mdx'; -import AddressBuilder from './java_api/AddressBuilder.mdx'; -import AddressConsolidationNeededEvent from './java_api/AddressConsolidationNeededEvent.mdx'; -import AddressConsolidationNeededListener from './java_api/AddressConsolidationNeededListener.mdx'; -import AddressData from './java_api/AddressData.mdx'; -import AddressOutput from './java_api/AddressOutput.mdx'; -import AddressWrapper from './java_api/AddressWrapper.mdx'; -import Api from './java_api/Api.mdx'; -import BalanceChange from './java_api/BalanceChange.mdx'; -import BalanceChangeListener from './java_api/BalanceChangeListener.mdx'; -import BalanceEvent from './java_api/BalanceEvent.mdx'; -import BroadcastTransactionListener from './java_api/BroadcastTransactionListener.mdx'; -import BroadcastingBundle from './java_api/BroadcastingBundle.mdx'; -import BrokerOptions from './java_api/BrokerOptions.mdx'; -import ClientOptions from './java_api/ClientOptions.mdx'; -import ClientOptionsBuilder from './java_api/ClientOptionsBuilder.mdx'; -import ErrorListener from './java_api/ErrorListener.mdx'; -import Essence from './java_api/Essence.mdx'; -import EventId from './java_api/EventId.mdx'; -import EventManager from './java_api/EventManager.mdx'; -import EventType from './java_api/EventType.mdx'; -import FetchingMigrationData from './java_api/FetchingMigrationData.mdx'; -import IndexationPayload from './java_api/IndexationPayload.mdx'; -import InfoResponse from './java_api/InfoResponse.mdx'; -import InputData from './java_api/InputData.mdx'; -import InputKind from './java_api/InputKind.mdx'; -import Message from './java_api/Message.mdx'; -import MessageId from './java_api/MessageId.mdx'; -import MessagePayload from './java_api/MessagePayload.mdx'; -import MessagePayloadType from './java_api/MessagePayloadType.mdx'; -import MessageType from './java_api/MessageType.mdx'; -import MigratedFundsEntry from './java_api/MigratedFundsEntry.mdx'; -import MigrationAddress from './java_api/MigrationAddress.mdx'; -import MigrationBundle from './java_api/MigrationBundle.mdx'; -import MigrationBundleOptions from './java_api/MigrationBundleOptions.mdx'; -import MigrationData from './java_api/MigrationData.mdx'; -import MigrationProgressEvent from './java_api/MigrationProgressEvent.mdx'; -import MigrationProgressListener from './java_api/MigrationProgressListener.mdx'; -import MigrationProgressType from './java_api/MigrationProgressType.mdx'; -import MilestoneId from './java_api/MilestoneId.mdx'; -import MilestonePayload from './java_api/MilestonePayload.mdx'; -import MilestonePayloadEssence from './java_api/MilestonePayloadEssence.mdx'; -import MilestoneSignature from './java_api/MilestoneSignature.mdx'; -import MiningBundle from './java_api/MiningBundle.mdx'; -import NativeAPI from './java_api/NativeAPI.mdx'; -import NewTransactionListener from './java_api/NewTransactionListener.mdx'; -import NodeInfoWrapper from './java_api/NodeInfoWrapper.mdx'; -import OutputKind from './java_api/OutputKind.mdx'; -import PreparedTransactionData from './java_api/PreparedTransactionData.mdx'; -import PublicKey from './java_api/PublicKey.mdx'; -import ReattachTransactionListener from './java_api/ReattachTransactionListener.mdx'; -import ReceiptPayload from './java_api/ReceiptPayload.mdx'; -import ReferenceUnlock from './java_api/ReferenceUnlock.mdx'; -import RegularEssence from './java_api/RegularEssence.mdx'; -import RemainderValueStrategy from './java_api/RemainderValueStrategy.mdx'; -import RustHex from './java_api/RustHex.mdx'; -import RustLogging from './java_api/RustLogging.mdx'; -import Signature from './java_api/Signature.mdx'; -import SignatureLockedDustAllowanceOutput from './java_api/SignatureLockedDustAllowanceOutput.mdx'; -import SignatureLockedSingleOutput from './java_api/SignatureLockedSingleOutput.mdx'; -import SignatureUnlock from './java_api/SignatureUnlock.mdx'; -import SigningBundle from './java_api/SigningBundle.mdx'; -import StrongholdStatusEvent from './java_api/StrongholdStatusEvent.mdx'; -import StrongholdStatusListener from './java_api/StrongholdStatusListener.mdx'; -import StrongholdStatusType from './java_api/StrongholdStatusType.mdx'; -import SyncedAccount from './java_api/SyncedAccount.mdx'; -import TransactionConfirmationChangeEvent from './java_api/TransactionConfirmationChangeEvent.mdx'; -import TransactionConfirmationChangeListener from './java_api/TransactionConfirmationChangeListener.mdx'; -import TransactionConfirmed from './java_api/TransactionConfirmed.mdx'; -import TransactionEvent from './java_api/TransactionEvent.mdx'; -import TransactionIO from './java_api/TransactionIO.mdx'; -import TransactionId from './java_api/TransactionId.mdx'; -import TransactionInput from './java_api/TransactionInput.mdx'; -import TransactionOutput from './java_api/TransactionOutput.mdx'; -import TransactionPayload from './java_api/TransactionPayload.mdx'; -import TransactionReattachmentEvent from './java_api/TransactionReattachmentEvent.mdx'; -import Transfer from './java_api/Transfer.mdx'; -import TransferBuilder from './java_api/TransferBuilder.mdx'; -import TransferOutput from './java_api/TransferOutput.mdx'; -import TransferProgress from './java_api/TransferProgress.mdx'; -import TransferProgressListener from './java_api/TransferProgressListener.mdx'; -import TransferProgressType from './java_api/TransferProgressType.mdx'; -import TreasuryInput from './java_api/TreasuryInput.mdx'; -import TreasuryOutput from './java_api/TreasuryOutput.mdx'; -import TreasuryPayload from './java_api/TreasuryPayload.mdx'; -import UnlockBlock from './java_api/UnlockBlock.mdx'; -import UnlockBlockKind from './java_api/UnlockBlockKind.mdx'; -import UtxoInput from './java_api/UtxoInput.mdx'; -import Value from './java_api/Value.mdx'; -import ValueUnit from './java_api/ValueUnit.mdx'; -import WalletException from './java_api/WalletException.mdx'; -import WalletTransferProgress from './java_api/WalletTransferProgress.mdx'; - -## Account - - - -## AccountBalance - - - -## AccountInitialiser - - - -## AccountManager - - - -## AccountManagerBuilder - - - -## AccountSignerType - - - -## AccountSynchronizer - - - -## AccountsSynchronizer - - - -## Actor - - - -## ActorCallback - - - -## Address - -
- -## AddressBuilder - - - -## AddressConsolidationNeededEvent - - - -## AddressConsolidationNeededListener - - - -## AddressData - - - -## AddressOutput - - - -## AddressWrapper - - - -## Api - - - -## BalanceChange - - - -## BalanceChangeListener - - - -## BalanceEvent - - - -## BroadcastTransactionListener - - - -## BroadcastingBundle - - - -## BrokerOptions - - - -## ClientOptions - - - -## ClientOptionsBuilder - - - -## ErrorListener - - - -## Essence - - - -## EventId - - - -## EventManager - - - -## EventType - - - -## FetchingMigrationData - - - -## IndexationPayload - - - -## InfoResponse - - - -## InputData - - - -## InputKind - - - -## Message - - - -## MessageId - - - -## MessagePayload - - - -## MessagePayloadType - - - -## MessageType - - - -## MigratedFundsEntry - - - -## MigrationAddress - - - -## MigrationBundle - - - -## MigrationBundleOptions - - - -## MigrationData - - - -## MigrationProgressEvent - - - -## MigrationProgressListener - - - -## MigrationProgressType - - - -## MilestoneId - - - -## MilestonePayload - - - -## MilestonePayloadEssence - - - -## MilestoneSignature - - - -## MiningBundle - - - -## NativeAPI - - - -## NewTransactionListener - - - -## NodeInfoWrapper - - - -## OutputKind - - - -## PreparedTransactionData - - - -## PublicKey - - - -## ReattachTransactionListener - - - -## ReceiptPayload - - - -## ReferenceUnlock - - - -## RegularEssence - - - -## RemainderValueStrategy - - - -## RustHex - - - -## RustLogging - - - -## Signature - - - -## SignatureLockedDustAllowanceOutput - - - -## SignatureLockedSingleOutput - - - -## SignatureUnlock - - - -## SigningBundle - - - -## StrongholdStatusEvent - - - -## StrongholdStatusListener - - - -## StrongholdStatusType - - - -## SyncedAccount - - - -## TransactionConfirmationChangeEvent - - - -## TransactionConfirmationChangeListener - - - -## TransactionConfirmed - - - -## TransactionEvent - - - -## TransactionIO - - - -## TransactionId - - - -## TransactionInput - - - -## TransactionOutput - - - -## TransactionPayload - - - -## TransactionReattachmentEvent - - - -## Transfer - - - -## TransferBuilder - - - -## TransferOutput - - - -## TransferProgress - - - -## TransferProgressListener - - - -## TransferProgressType - - - -## TreasuryInput - - - -## TreasuryOutput - - - -## TreasuryPayload - - - -## UnlockBlock - - - -## UnlockBlockKind - - - -## UtxoInput - - - -## Value - - - -## ValueUnit - - - -## WalletException - - - -## WalletTransferProgress - - diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/Account.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/Account.mdx deleted file mode 100644 index 614fd88ce26..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/Account.mdx +++ /dev/null @@ -1,174 +0,0 @@ -### consolidateOutputs(include_dust_allowance_outputs): [Message[]](#message) - -Consolidate _account outputs_ . - -| Parameter | Type | Description | -| ------------------------------ | ------- | ------------------------------------- | -| include_dust_allowance_outputs | boolean | Wether we include dust outputs or not | - -### transfer(transfer): [Message](#message) - -Send messages. - -| Parameter | Type | Description | -| --------- | --------------------- | ----------------------------------------------------- | -| transfer | [Transfer](#transfer) | A transfer object, can be made using Transfer.builder | - -### retry(message_id): [Message](#message) - -Retry message. - -| Parameter | Type | Description | -| ---------- | ----------------------- | -------------------------------------- | -| message_id | [MessageId](#messageid) | The id of the message we want to retry | - -### promote(message_id): [Message](#message) - -Promote message. - -| Parameter | Type | Description | -| ---------- | ----------------------- | ---------------------------------------- | -| message_id | [MessageId](#messageid) | The id of the message we want to promote | - -### reattach(message_id): [Message](#message) - -Reattach message. - -| Parameter | Type | Description | -| ---------- | ----------------------- | ----------------------------------------- | -| message_id | [MessageId](#messageid) | The id of the message we want to reattach | - -### generateAddress(): [Address](#address) - -Gets a new unused address and links it to this account. - -### generateAddresses(amount): [Address[]](#address) - -Gets amount new unused addresses and links them to this account. - -| Parameter | Type | Description | -| --------- | ---- | ----------------------------------- | -| amount | long | The amount of addresses we generate | - -### getUnusedAddress(): [Address](#address) - -Synchronizes the account addresses with the Tangle and returns the latest address in the account, -which is an address without balance. - -### isLatestAddressUnused(): boolean - -Syncs the latest address with the Tangle and determines whether it's unused or not. -An unused address is an address without balance and associated message history. -Note that such address might have been used in the past, because the message history might have been pruned by -the node. - -### latestAddress(): [Address](#address) - -Returns the most recent address of the account. - -### balance(): [AccountBalance](#accountbalance) - -Gets the account balance information. - -### setAlias(alias): void - -Updates the account alias. - -| Parameter | Type | Description | -| --------- | ------ | ------------- | -| alias | String | The new alias | - -### setClientOptions(options): void - -Updates the account's client options. - -| Parameter | Type | Description | -| --------- | ------------------------------- | --------------- | -| options | [ClientOptions](#clientoptions) | The new options | - -### listMessages(count, from, message_type): [Message[]](#message) - -Gets a list of transactions on this account. -It's fetched from the storage. To ensure the database is updated with the latest transactions, -`sync` should be called first. - -``` -// gets 10 received messages, skipping the first 5 most recent messages. -ClientOptions clientOptions = ClientOptionsBuilder::new() -.withNode("https://api.lb-0.h.chrysalis-devnet.iota.cafe") -.build(); - -AccountManager manager = AccountManager.builder() -.withStorage("./test-storage", null) -.finish(); -manager.setStrongholdPassword("password"); -manager.storeMnemonic(SignerType.STRONGHOLD, null); - -Account account = manager -.createAccount(clientOptions) -.unwrap() -.initialise(); -account.listMessages(10, 5, MessageType.RECEIVED)); -``` - -| Parameter | Type | Description | -| ------------ | --------------------------- | ------------------------------------------ | -| count | long | Number of (most recent) messages to fetch. | -| from | long | Starting point of the subset to fetch. | -| message_type | [MessageType](#messagetype) | Optional message type filter., can be null | - -### listSpentAddresses(): [Address[]](#address) - -Gets the spent addresses. - -### listUnspentAddresses(): [Address[]](#address) - -Gets the unspent addresses. - -### getMessage(message_id): Optional<[Message](#message)> - -Gets a message with the given id associated with this account. - -| Parameter | Type | Description | -| ---------- | ----------------------- | ------------------------------------ | -| message_id | [MessageId](#messageid) | The id of the message we want to get | - -### getNodeInfo(node, jwt, username, password): [NodeInfoWrapper](#nodeinfowrapper) - -Gets the node info from /api/v1/info endpoint -TODO: Add auth and url in one NodeInfoOptions struct. - -| Parameter | Type | Description | -| --------- | ------ | ------------------------------------------------------------------- | -| node | String | The node URL | -| jwt | String | The JWT, can be `null` | -| username | String | The username, can be `null` | -| password | String | The password, can be `null`. Only checked if username is not `null` | - -### alias(): String - -The account alias. - -### bech32Hrp(): String - -Returns the address bech32 human readable part. - -### id(): String - -The account identifier. - -### createdAt(): Calendar - -Time of account creation. - -### sync(): [AccountSynchronizer](#accountsynchronizer) - -Returns the builder to setup the process to synchronize this account with the Tangle. - -### lastSyncedAt(): Optional<Calendar> - -Time the account was last synced with the Tangle. - -### clientOptions(): [ClientOptions](#clientoptions) - -The current client options. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/AccountBalance.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/AccountBalance.mdx deleted file mode 100644 index 87f4dcd5172..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/AccountBalance.mdx +++ /dev/null @@ -1,20 +0,0 @@ -Account balance information. - -### getTotal(): long - -Account's total balance. - -### getAvailable(): long - -For example, if a user with 50i total account balance has made a message spending 20i, -the available balance should be (50i-30i) = 20i. - -### getIncoming(): long - -Balances from message with `incoming: true`. -Note that this may not be accurate since the node prunes the messags. - -### getOutgoing(): long - -Balances from message with `incoming: false`. -Note that this may not be accurate since the node prunes the messags. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/AccountInitialiser.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/AccountInitialiser.mdx deleted file mode 100644 index 62eb239b88e..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/AccountInitialiser.mdx +++ /dev/null @@ -1,54 +0,0 @@ -### signerType(signer_type): [AccountInitialiser](#accountinitialiser) - -Sets the account type. - -| Parameter | Type | Description | -| ----------- | --------------------------------------- | ----------- | -| signer_type | [AccountSignerType](#accountsignertype) | | - -### alias(alias): [AccountInitialiser](#accountinitialiser) - -Defines the account alias. If not defined, we'll generate one. - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| alias | String | | - -### createdAt(created_at): [AccountInitialiser](#accountinitialiser) - -Time of account creation. - -| Parameter | Type | Description | -| ---------- | ---- | ----------- | -| created_at | long | | - -### messages(messages): [AccountInitialiser](#accountinitialiser) - -Messages associated with the seed. -The account can be initialised with locally stored messages. - -| Parameter | Type | Description | -| --------- | --------------------- | ----------- | -| messages | [Message[]](#message) | | - -### addresses(addresses): [AccountInitialiser](#accountinitialiser) - -Address history associated with the seed. -The account can be initialised with locally stored address history. - -| Parameter | Type | Description | -| --------- | --------------------- | ----------- | -| addresses | [Address[]](#address) | | - -### skipPersistence(): [AccountInitialiser](#accountinitialiser) - -Skips storing the account to the database. - -### allowCreateMultipleEmptyAccounts(): [AccountInitialiser](#accountinitialiser) - -Enables creating multiple accounts without history. -The wallet disables it by default to simplify account discovery. - -### initialise(): [Account](#account) - -Initialises the account. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/AccountManager.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/AccountManager.mdx deleted file mode 100644 index 69d6e43b0f7..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/AccountManager.mdx +++ /dev/null @@ -1,212 +0,0 @@ -The account manager. - -Used to manage multiple accounts. - -### Builder(): [AccountManagerBuilder](#accountmanagerbuilder) - -Initialises the account manager builder. - -### getMigrationData(nodes, seed, permanode, security_level, initial_address_index, gap_limit): [MigrationData](#migrationdata) - -Gets the legacy migration data for the seed. - -| Parameter | Type | Description | -| --------------------- | -------- | ---------------------------------------------------------------- | -| nodes | String[] | List of legacy nodes to connect to | -| seed | String | The seed we want to get data for | -| permanode | String | The legacy permanode URL | -| security_level | byte | The seed security level | -| initial_address_index | long | The starting index of the seed we searc | -| gap_limit | long | The maximum gap we cross without finding an address with balance | - -### getMigrationAddress(ledger_prompt, account_id): [MigrationAddress](#migrationaddress) - -Convert the first address from the first account to a migration tryte address - -| Parameter | Type | Description | -| ------------- | ------- | ----------- | -| ledger_prompt | boolean | | -| account_id | String | | - -### createMigrationBundle(seed, input_address_indexes, options): [MigrationBundle](#migrationbundle) - -Creates the bundle for migration associated with the given input indexes, -Performs bundle mining if the address is spent and `mine` is true, -And signs the bundle. Returns the bundle hash. -It logs the operations to `$storage_path.join(log_file_name)`. - -| Parameter | Type | Description | -| --------------------- | ------------------------------------------------- | ----------- | -| seed | String | | -| input_address_indexes | long[] | | -| options | [MigrationBundleOptions](#migrationbundleoptions) | | - -### sendMigrationBundle(nodes, bundle_hash, mwm): void - -Sends the migration bundle to the given node. mwm 0 for default(14) - -| Parameter | Type | Description | -| ----------- | -------- | ----------- | -| nodes | String[] | | -| bundle_hash | String | | -| mwm | short | | - -### startBackgroundSync(polling_interval, automatic_output_consolidation): void - -Initialises the background polling and MQTT monitoring. - -| Parameter | Type | Description | -| ------------------------------ | ------- | --------------------------------------- | -| polling_interval | float | Sets the polling interval in seconds | -| automatic_output_consolidation | boolean | If we automatically consolidate outputs | - -### stopBackgroundSync(): void - -Stops the background polling and MQTT monitoring. - -### setStoragePassword(password): void - -Sets the password for the stored accounts. - -| Parameter | Type | Description | -| --------- | ------ | -------------------- | -| password | String | The Storage password | - -### setStrongholdPassword(password): void - -Sets the stronghold password. - -| Parameter | Type | Description | -| --------- | ------ | -------------------------------- | -| password | String | The Stronghold snapshot password | - -### changeStrongholdPassword(current_password, new_password): void - -Changes the stronghold password. - -| Parameter | Type | Description | -| ---------------- | ------ | ------------------------------- | -| current_password | String | The current Stronghold password | -| new_password | String | The new Stronghold password | - -### isLatestAddressUnused(): boolean - -Determines whether all accounts has the latest address unused. - -### setClientOptions(options): void - -Sets the client options for all accounts. - -| Parameter | Type | Description | -| --------- | ------------------------------- | ----------- | -| options | [ClientOptions](#clientoptions) | | - -### storeMnemonic(signer_type, mnemonic): void - -Stores a mnemonic for the given signer type. -If the mnemonic is not provided, we'll generate one. - -| Parameter | Type | Description | -| ----------- | --------------------------------------- | ----------- | -| signer_type | [AccountSignerType](#accountsignertype) | | -| mnemonic | String | | - -### generateMnemonic(): String - -Generates a new mnemonic. - -### verifyMnemonic(mnemonic): void - -Checks is the mnemonic is valid. If a mnemonic was generated with `generate_mnemonic()`, the mnemonic here -should match the generated. - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| mnemonic | String | | - -### createAccount(client_options): [AccountInitialiser](#accountinitialiser) - -Adds a new account. - -| Parameter | Type | Description | -| -------------- | ------------------------------- | ----------- | -| client_options | [ClientOptions](#clientoptions) | | - -### removeAccount(account_id): void - -Deletes an account. - -| Parameter | Type | Description | -| ---------- | ------ | ----------- | -| account_id | String | | - -### syncAccounts(): [AccountsSynchronizer](#accountssynchronizer) - -Syncs all accounts. - -### internalTransfer(from_account_id, to_account_id, amount): [Message](#message) - -Transfers an amount from an account to another. - -| Parameter | Type | Description | -| --------------- | ------ | ----------- | -| from_account_id | String | | -| to_account_id | String | | -| amount | long | | - -### backup(destination, stronghold_password): Path - -Backups the storage to the given destination - -| Parameter | Type | Description | -| ------------------- | ------ | ----------- | -| destination | String | | -| stronghold_password | String | | - -### importAccounts(source, stronghold_password): void - -Import backed up accounts. - -| Parameter | Type | Description | -| ------------------- | ------ | ----------- | -| source | String | | -| stronghold_password | String | | - -### getAccount(account_id): [Account](#account) - -Gets the account associated with the given identifier. - -| Parameter | Type | Description | -| ---------- | ------ | ----------- | -| account_id | String | | - -### getAccounts(): [Account[]](#account) - -Gets all accounts from storage. - -### reattach(account_id, message_id): [Message](#message) - -Reattaches an unconfirmed transaction. - -| Parameter | Type | Description | -| ---------- | ----------------------- | ----------- | -| account_id | String | | -| message_id | [MessageId](#messageid) | | - -### promote(account_id, message_id): [Message](#message) - -Promotes an unconfirmed transaction. - -| Parameter | Type | Description | -| ---------- | ----------------------- | ----------- | -| account_id | String | | -| message_id | [MessageId](#messageid) | | - -### retry(account_id, message_id): [Message](#message) - -Retries an unconfirmed transaction. - -| Parameter | Type | Description | -| ---------- | ----------------------- | ----------- | -| account_id | String | | -| message_id | [MessageId](#messageid) | | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/AccountManagerBuilder.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/AccountManagerBuilder.mdx deleted file mode 100644 index 908f418c016..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/AccountManagerBuilder.mdx +++ /dev/null @@ -1,55 +0,0 @@ -Account manager builder. - -### AccountManagerBuilder(): [AccountManagerBuilder](#accountmanagerbuilder) - -Initialises a new instance of the account manager builder with the default storage adapter. - -### withStorage(storage_path, password): [AccountManagerBuilder](#accountmanagerbuilder) - -Sets the storage config to be used. - -| Parameter | Type | Description | -| ------------ | ------ | ---------------------------------------------- | -| storage_path | String | The path where the database file will be saved | -| password | String | The storage password | - -### withPollingInterval(polling_interval): [AccountManagerBuilder](#accountmanagerbuilder) - -Sets the polling interval. - -| Parameter | Type | Description | -| ---------------- | ----- | ------------------------------- | -| polling_interval | float | the polling interval in seconds | - -### withSkipPolling(): [AccountManagerBuilder](#accountmanagerbuilder) - -Skip polling - -### withOutputConsolidationThreshold(threshold): [AccountManagerBuilder](#accountmanagerbuilder) - -Sets the number of outputs an address must have to trigger the automatic consolidation process. - -| Parameter | Type | Description | -| --------- | ---- | ----------------------------------------------------------------------------------------- | -| threshold | long | The number of outputs an address must have to trigger the automatic consolidation process | - -### withAutomaticOutputConsolidationDisabled(): [AccountManagerBuilder](#accountmanagerbuilder) - -Disables the automatic output consolidation process. - -### withSyncSpentOutputs(): [AccountManagerBuilder](#accountmanagerbuilder) - -Enables fetching spent output history on sync. - -### withEventPersistence(): [AccountManagerBuilder](#accountmanagerbuilder) - -Enables event persistence. - -### withMultipleEmptyAccounts(): [AccountManagerBuilder](#accountmanagerbuilder) - -Enables creating multiple accounts without history. -The wallet disables it by default to simplify account discovery. - -### finish(): [AccountManager](#accountmanager) - -Builds the manager. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/AccountSignerType.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/AccountSignerType.mdx deleted file mode 100644 index ca57f698088..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/AccountSignerType.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### STRONGHOLD - -### LEDGER_NANO - -### LEDGER_NANO_SIMULATOR diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/AccountSynchronizer.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/AccountSynchronizer.mdx deleted file mode 100644 index 9911ed15e5d..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/AccountSynchronizer.mdx +++ /dev/null @@ -1,32 +0,0 @@ -Account sync helper. - -### gapLimit(limit): [AccountSynchronizer](#accountsynchronizer) - -Number of address indexes that are generated. - -| Parameter | Type | Description | -| --------- | ---- | ---------------------------------------------------------------- | -| limit | long | The maximum gap we cross without finding an address with balance | - -### skipPersistence(): [AccountSynchronizer](#accountsynchronizer) - -Skip saving new messages and addresses on the account object. -The found data is returned on the `execute` call but won't be persisted on the database. - -### skipChangeAddresses(): [AccountSynchronizer](#accountsynchronizer) - -Skip syncing existing change addresses. - -### addressIndex(address_index): [AccountSynchronizer](#accountsynchronizer) - -Initial address index to start syncing. - -| Parameter | Type | Description | -| ------------- | ---- | ------------------ | -| address_index | long | The starting index | - -### execute(): [SyncedAccount](#syncedaccount) - -Syncs account with the tangle. -The account syncing process ensures that the latest metadata (balance, transactions) -associated with an account is fetched from the tangle and is stored locally. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/AccountsSynchronizer.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/AccountsSynchronizer.mdx deleted file mode 100644 index 3d0f9627a76..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/AccountsSynchronizer.mdx +++ /dev/null @@ -1,37 +0,0 @@ -The accounts synchronizer. - -### gapLimit(limit): [AccountsSynchronizer](#accountssynchronizer) - -Number of address indexes that are generated. - -| Parameter | Type | Description | -| --------- | ---- | ---------------------------------------------------------------- | -| limit | long | The maximum gap we cross without finding an address with balance | - -### addressIndex(address_index): [AccountsSynchronizer](#accountssynchronizer) - -Initial address index to start syncing. - -| Parameter | Type | Description | -| ------------- | ---- | ------------------ | -| address_index | long | The starting index | - -### skipAccountDiscovery(): [AccountsSynchronizer](#accountssynchronizer) - -Skips the account discovery process. - -### skipChangeAddresses(): [AccountsSynchronizer](#accountssynchronizer) - -Skip syncing existing change addresses. - -### accountDiscoveryThreshold(account_discovery_threshold): [AccountsSynchronizer](#accountssynchronizer) - -Sets the minimum number of accounts to check on the discovery process. - -| Parameter | Type | Description | -| --------------------------- | ---- | --------------------------- | -| account_discovery_threshold | long | The minimum accounts number | - -### execute(): [SyncedAccount[]](#syncedaccount) - -Syncs the accounts with the Tangle. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/Actor.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/Actor.mdx deleted file mode 100644 index a92d2d22b72..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/Actor.mdx +++ /dev/null @@ -1,33 +0,0 @@ -### iotaInitialize(cb, actor_id, storage_path): void - -| Parameter | Type | Description | -| ------------ | ------------------------------- | ----------- | -| cb | [ActorCallback](#actorcallback) | | -| actor_id | String | | -| storage_path | String | | - -### iotaDestroy(actor_id): void - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| actor_id | String | | - -### iotaSendMessage(message): void - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| message | String | | - -### iotaListen(actor_id, id, event): void - -| Parameter | Type | Description | -| --------- | ----------------------- | ----------- | -| actor_id | String | | -| id | String | | -| event | [EventType](#eventtype) | | - -### iotaInitLogger(file_name): void - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| file_name | String | | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/ActorCallback.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/ActorCallback.mdx deleted file mode 100644 index d4eb39694b8..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/ActorCallback.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### onEvent(event): void - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| event | String | | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/Address.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/Address.mdx deleted file mode 100644 index 0e021539cd1..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/Address.mdx +++ /dev/null @@ -1,17 +0,0 @@ -An address. - -### builder(): [AddressBuilder](#addressbuilder) - -Gets a new instance of the address builder. - -### balance(): long - -Address total balance - -### readable(): String - -the Bech32 human readable part. - -### address(): [AddressWrapper](#addresswrapper) - -The address. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/AddressBuilder.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/AddressBuilder.mdx deleted file mode 100644 index 56d20dab2f0..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/AddressBuilder.mdx +++ /dev/null @@ -1,35 +0,0 @@ -### address(address): [AddressBuilder](#addressbuilder) - -Defines the address. - -| Parameter | Type | Description | -| --------- | --------------------------------- | ----------- | -| address | [AddressWrapper](#addresswrapper) | | - -### keyIndex(key_index): [AddressBuilder](#addressbuilder) - -Sets the address key index. - -| Parameter | Type | Description | -| --------- | ---- | ----------- | -| key_index | long | | - -### outputs(outputs): [AddressBuilder](#addressbuilder) - -Sets the address outputs. - -| Parameter | Type | Description | -| --------- | --------------------------------- | ----------- | -| outputs | [AddressOutput[]](#addressoutput) | | - -### internal(internal): [AddressBuilder](#addressbuilder) - -Sets the `internal` flag. - -| Parameter | Type | Description | -| --------- | ------- | ----------- | -| internal | boolean | | - -### build(): [Address](#address) - -Builds the address. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/AddressConsolidationNeededEvent.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/AddressConsolidationNeededEvent.mdx deleted file mode 100644 index 54027093285..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/AddressConsolidationNeededEvent.mdx +++ /dev/null @@ -1,9 +0,0 @@ -The `address consolidation needed` data. - -### accountId(): String - -The associated account identifier. - -### address(): [AddressWrapper](#addresswrapper) - -The associated address. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/AddressConsolidationNeededListener.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/AddressConsolidationNeededListener.mdx deleted file mode 100644 index 848a156b3ce..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/AddressConsolidationNeededListener.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### onAddressConsolidationNeeded(event): void - -| Parameter | Type | Description | -| --------- | ------------------------------------------------------------------- | ----------- | -| event | [AddressConsolidationNeededEvent](#addressconsolidationneededevent) | | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/AddressData.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/AddressData.mdx deleted file mode 100644 index a356c9ea9ef..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/AddressData.mdx +++ /dev/null @@ -1,5 +0,0 @@ -Address data for TransferProgressType.GeneratingRemainderDepositAddress and LedgerAddressGeneration. - -### address(): String - -The address. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/AddressOutput.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/AddressOutput.mdx deleted file mode 100644 index 4a2448193e1..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/AddressOutput.mdx +++ /dev/null @@ -1,71 +0,0 @@ -An Address output. - -### transactionId(): [TransactionId](#transactionid) - -Transaction ID of the output - -### setTransactionId(transaction_id): void - -| Parameter | Type | Description | -| -------------- | ------------------------------- | ----------- | -| transaction_id | [TransactionId](#transactionid) | | - -### messageId(): [MessageId](#messageid) - -Message ID of the output - -### setMessageId(message_id): void - -| Parameter | Type | Description | -| ---------- | ----------------------- | ----------- | -| message_id | [MessageId](#messageid) | | - -### index(): int - -Output index. - -### setIndex(index): void - -| Parameter | Type | Description | -| --------- | ---- | ----------- | -| index | int | | - -### amount(): long - -Output amount. - -### setAmount(amount): void - -| Parameter | Type | Description | -| --------- | ---- | ----------- | -| amount | long | | - -### isSpent(): boolean - -Spend status of the output, - -### setSpent(is_spent): void - -| Parameter | Type | Description | -| --------- | ------- | ----------- | -| is_spent | boolean | | - -### address(): [AddressWrapper](#addresswrapper) - -Associated address. - -### setAddress(address): void - -| Parameter | Type | Description | -| --------- | --------------------------------- | ----------- | -| address | [AddressWrapper](#addresswrapper) | | - -### kind(): [OutputKind](#outputkind) - -Output kind. - -### setKind(kind): void - -| Parameter | Type | Description | -| --------- | ------------------------- | ----------- | -| kind | [OutputKind](#outputkind) | | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/AddressWrapper.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/AddressWrapper.mdx deleted file mode 100644 index 3535a729365..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/AddressWrapper.mdx +++ /dev/null @@ -1,20 +0,0 @@ -### from(address, bech32_hrp): [AddressWrapper](#addresswrapper) - -Create an Address based on its address and Bech segments - -| Parameter | Type | Description | -| ---------- | ------ | ------------------- | -| address | String | The Address segment | -| bech32_hrp | String | the bech segment | - -### parse(address): [AddressWrapper](#addresswrapper) - -parse a fully functional address string into an AddressWrapper - -| Parameter | Type | Description | -| --------- | ------ | ------------------------- | -| address | String | The address we will parse | - -### toBech32(): String - -Get the bech segment of the address diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/Api.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/Api.mdx deleted file mode 100644 index e486c10f0f9..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/Api.mdx +++ /dev/null @@ -1,15 +0,0 @@ -### GET_TIPS - -`get_tips` API - -### POST_MESSAGE - -`post_message` API - -### GET_OUTPUT - -`get_output` API - -### GET_BALANCE - -`get_balance` API diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/BalanceChange.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/BalanceChange.mdx deleted file mode 100644 index dc5c0eaa865..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/BalanceChange.mdx +++ /dev/null @@ -1,13 +0,0 @@ -The balance change event payload. - -### isSpent(): boolean - -Checks if spent was more than 0 - -### spent(): long - -The change amount if it was a spent event. - -### received(): long - -The change amount if it was a receive event. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/BalanceChangeListener.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/BalanceChangeListener.mdx deleted file mode 100644 index f09541cbf10..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/BalanceChangeListener.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### onBalanceChange(event): void - -| Parameter | Type | Description | -| --------- | ----------------------------- | ----------- | -| event | [BalanceEvent](#balanceevent) | | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/BalanceEvent.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/BalanceEvent.mdx deleted file mode 100644 index dd95b45bdf0..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/BalanceEvent.mdx +++ /dev/null @@ -1,28 +0,0 @@ -The balance change event data. - -### indexationId(): String - -Event unique identifier. - -### accountId(): String - -The associated account identifier. - -### messageId(): Optional<[MessageId](#messageid)> - -The message id associated with the balance change. -Note that this might be empty without -AccountManagerBuilder#withSyncSpentOutputs - -### address(): [AddressWrapper](#addresswrapper) - -The associated address. - -### remainder(): Optional<Boolean> - -Whether the event is associated with a remainder output or not. -Note that this might be empty if we couldn't get the message object from the node. - -### balanceChange(): [BalanceChange](#balancechange) - -The balance change data. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/BroadcastTransactionListener.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/BroadcastTransactionListener.mdx deleted file mode 100644 index 0f7737f5ef1..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/BroadcastTransactionListener.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### onBroadcastTransaction(event): void - -| Parameter | Type | Description | -| --------- | ------------------------------------- | ----------- | -| event | [TransactionEvent](#transactionevent) | | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/BroadcastingBundle.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/BroadcastingBundle.mdx deleted file mode 100644 index cadbdc70685..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/BroadcastingBundle.mdx +++ /dev/null @@ -1,5 +0,0 @@ -Broadcasting the given bundle hash. - -### getBundleHash(): String - -The bundle hash. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/BrokerOptions.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/BrokerOptions.mdx deleted file mode 100644 index 343045fd441..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/BrokerOptions.mdx +++ /dev/null @@ -1,43 +0,0 @@ -The MQTT broker options. - -### BrokerOptions(): [BrokerOptions](#brokeroptions) - -### automaticDisconnect(disconnect): [BrokerOptions](#brokeroptions) - -Whether the MQTT broker should be automatically disconnected when all topics are unsubscribed or not. - -| Parameter | Type | Description | -| ---------- | ------- | ----------- | -| disconnect | boolean | | - -### timeout(timeout): [BrokerOptions](#brokeroptions) - -timeout of the mqtt broker. - -| Parameter | Type | Description | -| --------- | ----- | ---------------------- | -| timeout | float | The timeout in seconds | - -### useWs(use_ws): [BrokerOptions](#brokeroptions) - -Defines if websockets should be used (true) or TCP (false) - -| Parameter | Type | Description | -| --------- | ------- | ---------------------------- | -| use_ws | boolean | If we use web sockets or not | - -### port(port): [BrokerOptions](#brokeroptions) - -Defines the port to be used for the MQTT connection - -| Parameter | Type | Description | -| --------- | ---- | -------------------------- | -| port | int | The port we use to conenct | - -### maxReconnectionAttempts(max_reconnection_attempts): [BrokerOptions](#brokeroptions) - -Defines the maximum reconnection attempts before it returns an error - -| Parameter | Type | Description | -| ------------------------- | ---- | -------------------- | -| max_reconnection_attempts | long | The maximum attempts | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/ClientOptions.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/ClientOptions.mdx deleted file mode 100644 index 3a26c9642cb..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/ClientOptions.mdx +++ /dev/null @@ -1 +0,0 @@ -The client options type. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/ClientOptionsBuilder.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/ClientOptionsBuilder.mdx deleted file mode 100644 index 9ba94e05f09..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/ClientOptionsBuilder.mdx +++ /dev/null @@ -1,135 +0,0 @@ -The options builder for a client connected to multiple nodes. - -### ClientOptionsBuilder(): [ClientOptionsBuilder](#clientoptionsbuilder) - -Initialises a new instance of the builder. - -### withPrimaryNode(node): [ClientOptionsBuilder](#clientoptionsbuilder) - -Sets the primary node. - -| Parameter | Type | Description | -| --------- | ------ | ------------ | -| node | String | The node URL | - -### withPrimaryNodeAuth(node, jwt, username, password): [ClientOptionsBuilder](#clientoptionsbuilder) - -Adds an IOTA node by its URL to be used as primary node, with optional jwt and or basic authentication - -| Parameter | Type | Description | -| --------- | ------ | ------------------------------------------------------------------- | -| node | String | The node URL | -| jwt | String | The JWT, can be `null` | -| username | String | The username, can be `null` | -| password | String | The password, can be `null`. Only checked if username is not `null` | - -### withPrimaryPowNode(node): [ClientOptionsBuilder](#clientoptionsbuilder) - -Sets the primary PoW node. - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| node | String | | - -### withPrimaryPowNodeAuth(node, jwt, username, password): [ClientOptionsBuilder](#clientoptionsbuilder) - -Adds an IOTA node by its URL to be used as primary PoW node (for remote PoW), with optional jwt and or basic -authentication - -| Parameter | Type | Description | -| --------- | ------ | ------------------------------------------------------------------- | -| node | String | The node URL | -| jwt | String | The JWT, can be `null` | -| username | String | The username, can be `null` | -| password | String | The password, can be `null`. Only checked if username is not `null` | - -### withNode(node): [ClientOptionsBuilder](#clientoptionsbuilder) - -Adds a node to the node list. - -| Parameter | Type | Description | -| --------- | ------ | ------------ | -| node | String | The node URL | - -### withNodes(nodes): [ClientOptionsBuilder](#clientoptionsbuilder) - -ClientOptions connected to a list of nodes. - -| Parameter | Type | Description | -| --------- | -------- | --------------------- | -| nodes | String[] | The list of node URLs | - -### withNodePoolUrls(node_pool_urls): [ClientOptionsBuilder](#clientoptionsbuilder) - -Get node list from the node_pool_urls - -| Parameter | Type | Description | -| -------------- | -------- | -------------------------------------------------- | -| node_pool_urls | String[] | node_pool_urls list of node URLs for the node pool | - -### withNetwork(network): [ClientOptionsBuilder](#clientoptionsbuilder) - -ClientOptions connected to the default Network pool. - -``` -import org.iota.wallet.ClientOptionsBuilder; -ClientOptions clientOptions = new ClientOptionsBuilder().with_network("testnet2").build(); -``` - -| Parameter | Type | Description | -| --------- | ------ | ------------------------- | -| network | String | The network we connect to | - -### withNodeSyncInterval(node_sync_interval): [ClientOptionsBuilder](#clientoptionsbuilder) - -Set the node sync interval - -| Parameter | Type | Description | -| ------------------ | ----- | ----------------------- | -| node_sync_interval | float | The interval in seconds | - -### withNodeSyncDisabled(): [ClientOptionsBuilder](#clientoptionsbuilder) - -Disables the node syncing process. -Every node will be considered healthy and ready to use. - -### withMqttBrokerOptions(options): [ClientOptionsBuilder](#clientoptionsbuilder) - -Sets the MQTT broker options. - -| Parameter | Type | Description | -| --------- | ------------------------------- | ---------------- | -| options | [BrokerOptions](#brokeroptions) | the MQTT options | - -### withMqttDisabled(): [ClientOptionsBuilder](#clientoptionsbuilder) - -Disables MQTT - -### withLocalPow(local): [ClientOptionsBuilder](#clientoptionsbuilder) - -Sets whether the PoW should be done locally or remotely. - -| Parameter | Type | Description | -| --------- | ------- | ----------------------------- | -| local | boolean | Enables or disables local PoW | - -### withRequestTimeout(timeout): [ClientOptionsBuilder](#clientoptionsbuilder) - -Sets the request timeout. - -| Parameter | Type | Description | -| --------- | ----- | ------------------------------ | -| timeout | float | The request timeout in seconds | - -### withApiTimeout(api, timeout): [ClientOptionsBuilder](#clientoptionsbuilder) - -Sets the request timeout for a specific API usage. - -| Parameter | Type | Description | -| --------- | ----------- | ------------------------------ | -| api | [Api](#api) | The API we set the timeout for | -| timeout | float | The request timeout in seconds | - -### build(): [ClientOptions](#clientoptions) - -Builds the options. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/ErrorListener.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/ErrorListener.mdx deleted file mode 100644 index aa2303eae1f..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/ErrorListener.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### onError(error): void - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| error | String | | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/Essence.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/Essence.mdx deleted file mode 100644 index 12ebd04760f..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/Essence.mdx +++ /dev/null @@ -1 +0,0 @@ -### asRegular(): [RegularEssence](#regularessence) diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/EventId.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/EventId.mdx deleted file mode 100644 index 2ba4ee17b6d..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/EventId.mdx +++ /dev/null @@ -1 +0,0 @@ -The event identifier type. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/EventManager.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/EventManager.mdx deleted file mode 100644 index 44db07d4159..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/EventManager.mdx +++ /dev/null @@ -1,157 +0,0 @@ -### subscribeErrors(cb): [EventId](#eventid) - -Listen to errors. - -| Parameter | Type | Description | -| --------- | ------------------------------- | ----------- | -| cb | [ErrorListener](#errorlistener) | | - -### subscribeNewTransaction(cb): [EventId](#eventid) - -Listen to new messages. - -| Parameter | Type | Description | -| --------- | ------------------------------------------------- | ----------- | -| cb | [NewTransactionListener](#newtransactionlistener) | | - -### subscribeConfirmationStateChange(cb): [EventId](#eventid) - -Listen to transaction confirmation state change. - -| Parameter | Type | Description | -| --------- | ------------------------------------------------------------------------------- | ----------- | -| cb | [TransactionConfirmationChangeListener](#transactionconfirmationchangelistener) | | - -### subscribeReattachment(cb): [EventId](#eventid) - -Listen to transaction reattachment change. - -| Parameter | Type | Description | -| --------- | ----------------------------------------------------------- | ----------- | -| cb | [ReattachTransactionListener](#reattachtransactionlistener) | | - -### subscribeBroadcast(cb): [EventId](#eventid) - -Listen to transaction broadcast. - -| Parameter | Type | Description | -| --------- | ------------------------------------------------------------- | ----------- | -| cb | [BroadcastTransactionListener](#broadcasttransactionlistener) | | - -### subscribeTransferProgress(cb): [EventId](#eventid) - -Listen to a transfer event. - -| Parameter | Type | Description | -| --------- | ----------------------------------------------------- | ----------- | -| cb | [TransferProgressListener](#transferprogresslistener) | | - -### subscribeMigrationProgress(cb): [EventId](#eventid) - -Listen to a migration event. - -| Parameter | Type | Description | -| --------- | ------------------------------------------------------- | ----------- | -| cb | [MigrationProgressListener](#migrationprogresslistener) | | - -### subscribeBalanceChange(cb): [EventId](#eventid) - -Listen to balance changes. - -| Parameter | Type | Description | -| --------- | ----------------------------------------------- | ----------- | -| cb | [BalanceChangeListener](#balancechangelistener) | | - -### subscribeStrongholdStatusChange(cb): [EventId](#eventid) - -Listen to stronghold status change events. - -| Parameter | Type | Description | -| --------- | ----------------------------------------------------- | ----------- | -| cb | [StrongholdStatusListener](#strongholdstatuslistener) | | - -### subscribeAddressConsolidationNeeded(cb): [EventId](#eventid) - -Listen to `address consolidation needed` events. - -| Parameter | Type | Description | -| --------- | ------------------------------------------------------------------------- | ----------- | -| cb | [AddressConsolidationNeededListener](#addressconsolidationneededlistener) | | - -### removeErrorListener(event): void - -Removes the error listener associated with the given identifier. - -| Parameter | Type | Description | -| --------- | ------------------- | ---------------------------------------- | -| event | [EventId](#eventid) | The ID of the listener we want to remove | - -### removeNewTransactionListener(event): void - -Removes the new transaction listener associated with the given identifier. - -| Parameter | Type | Description | -| --------- | ------------------- | ---------------------------------------- | -| event | [EventId](#eventid) | The ID of the listener we want to remove | - -### removeConfirmationStateChangeListener(event): void - -Removes the new confirmation state change listener associated with the given identifier. - -| Parameter | Type | Description | -| --------- | ------------------- | ---------------------------------------- | -| event | [EventId](#eventid) | The ID of the listener we want to remove | - -### removeReattachmentListener(event): void - -Removes the reattachment listener associated with the given identifier. - -| Parameter | Type | Description | -| --------- | ------------------- | ---------------------------------------- | -| event | [EventId](#eventid) | The ID of the listener we want to remove | - -### removeBroadcastListener(event): void - -Removes the broadcast listener associated with the given identifier. - -| Parameter | Type | Description | -| --------- | ------------------- | ---------------------------------------- | -| event | [EventId](#eventid) | The ID of the listener we want to remove | - -### removeTransferProgressListener(event): void - -Remove a transfer event listener. - -| Parameter | Type | Description | -| --------- | ------------------- | ---------------------------------------- | -| event | [EventId](#eventid) | The ID of the listener we want to remove | - -### removeMigrationProgressListener(event): void - -| Parameter | Type | Description | -| --------- | ------------------- | --------------------------------------------------------------------------- | -| event | [EventId](#eventid) | The ID of the listener we want to remove Remove a migration event listener. | - -### removeBalanceChangeListener(event): void - -Removes the balance change listener associated with the given identifier. - -| Parameter | Type | Description | -| --------- | ------------------- | ---------------------------------------- | -| event | [EventId](#eventid) | The ID of the listener we want to remove | - -### removeStrongholdStatusChangeListener(event): void - -Removes the stronghold status change listener associated with the given identifier. - -| Parameter | Type | Description | -| --------- | ------------------- | ---------------------------------------- | -| event | [EventId](#eventid) | The ID of the listener we want to remove | - -### removeAddressConsolidationNeededListener(event): void - -Removes the balance change listener associated with the given identifier. - -| Parameter | Type | Description | -| --------- | ------------------- | ---------------------------------------- | -| event | [EventId](#eventid) | The ID of the listener we want to remove | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/EventType.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/EventType.mdx deleted file mode 100644 index 9e9add61e21..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/EventType.mdx +++ /dev/null @@ -1,17 +0,0 @@ -### ERROR_THROWN - -### BALANCE_CHANGE - -### NEW_TRANSACTION - -### CONFIRMATION_STATE_CHANGE - -### REATTACHMENT - -### BROADCAST - -### STRONGHOLD_STATUS_CHANGE - -### TRANSFER_PROGRESS - -### MIGRATION_PROGRESS diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/FetchingMigrationData.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/FetchingMigrationData.mdx deleted file mode 100644 index 12bfcfeeb85..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/FetchingMigrationData.mdx +++ /dev/null @@ -1,9 +0,0 @@ -Fetching migration data on the given address range. - -### getInitialAddressIndex(): long - -The initial address index on the fetch range. - -### getFinalAddressIndex(): long - -The final address index on the fetch range. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/IndexationPayload.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/IndexationPayload.mdx deleted file mode 100644 index b14408d827d..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/IndexationPayload.mdx +++ /dev/null @@ -1,25 +0,0 @@ -### fromBytes(index, data): [IndexationPayload](#indexationpayload) - -Creates a new `IndexationPayload`. - -| Parameter | Type | Description | -| --------- | ------ | ----------------------------- | -| index | byte[] | The index | -| data | byte[] | The data linked ot this index | - -### fromStrings(index, data): [IndexationPayload](#indexationpayload) - -Creates a new `IndexationPayload` from strings - -| Parameter | Type | Description | -| --------- | ------ | ----------------------------------------------- | -| index | String | The index | -| data | String | The data linked ot this indexMilestoneSignature | - -### index(): byte[] - -Returns the index of an `IndexationPayload`. - -### data(): byte[] - -Returns the data of an `IndexationPayload`. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/InfoResponse.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/InfoResponse.mdx deleted file mode 100644 index 610f201eddc..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/InfoResponse.mdx +++ /dev/null @@ -1,54 +0,0 @@ -Response of GET /api/v1/info. -Returns general information about the node. - -### name(): String - -The name of the node - -### version(): String - -The node software version - -### networkId(): String - -The network id the node is connected to - -### bech32Hrp(): String - -The bech32 HRP which is accepted by this node - -### messagesPerSecond(): double - -The messages per second this node is receiving - -### referencedMessagesPerSecond(): double - -The referenced messages per second this node is receiving - -### referencedRate(): double - -The reference rate - -### latestMilestoneTimestamp(): long - -The timestamp of the latest received milestone - -### minPowScore(): double - -The minimum required PoW for a message to be accepted - -### latestMilestoneIndex(): long - -The index of the latest seen milestone - -### confirmedMilestoneIndex(): long - -The index of the latest confirmed milestone - -### pruningIndex(): long - -The milestone index this node is pruning from - -### features(): String[] - -List of features running on this node diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/InputData.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/InputData.mdx deleted file mode 100644 index 6341e2896a8..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/InputData.mdx +++ /dev/null @@ -1,25 +0,0 @@ -Address can be used as input to spend balance - -### address(): String - -Input address - -### securityLvl(): short - -Security level - -### balance(): long - -Balance of the address - -### index(): long - -Index of the address - -### spent(): boolean - -Spent status - -### spentBundlehashes(): String[] - -Spent bundlehashes diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/InputKind.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/InputKind.mdx deleted file mode 100644 index 7aac49186c5..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/InputKind.mdx +++ /dev/null @@ -1,3 +0,0 @@ -### UTXO - -### TREASURY diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/Message.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/Message.mdx deleted file mode 100644 index a89fc665ec1..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/Message.mdx +++ /dev/null @@ -1,17 +0,0 @@ -### id(): [MessageId](#messageid) - -### version(): long - -### parents(): [MessageId[]](#messageid) - -### payloadLength(): long - -### payload(): Optional<[MessagePayload](#messagepayload)> - -### timestamp(): Date - -### nonce(): long - -### confirmed(): Optional<Boolean> - -### broadcasted(): boolean diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/MessageId.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/MessageId.mdx deleted file mode 100644 index 3eb95b9dca7..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/MessageId.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### MessageId(): [MessageId](#messageid) - -### fromString(str_rep): [MessageId](#messageid) - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| str_rep | String | | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/MessagePayload.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/MessagePayload.mdx deleted file mode 100644 index fe70b135796..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/MessagePayload.mdx +++ /dev/null @@ -1,27 +0,0 @@ -Message payload wrapper - -### deserialize(serialised_data): [MessagePayload](#messagepayload) - -Turns a serialized message payload string back into its class - -| Parameter | Type | Description | -| --------------- | ------ | ----------- | -| serialised_data | String | | - -### payloadType(): [MessagePayloadType](#messagepayloadtype) - -Get the type of message this contains (used to select the correct getter) - -### asIndexation(): [IndexationPayload](#indexationpayload) - -### asMilestone(): [MilestonePayload](#milestonepayload) - -### asTransaction(): [TransactionPayload](#transactionpayload) - -### asReceipt(): [ReceiptPayload](#receiptpayload) - -### asTreasury(): [TreasuryPayload](#treasurypayload) - -### serialize(): String - -Serializes the message payload into a json string diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/MessagePayloadType.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/MessagePayloadType.mdx deleted file mode 100644 index a3c82243116..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/MessagePayloadType.mdx +++ /dev/null @@ -1,9 +0,0 @@ -### TRANSACTION - -### MILESTONE - -### INDEXATION - -### RECEIPT - -### TREASURY_TRANSACTION diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/MessageType.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/MessageType.mdx deleted file mode 100644 index 70346c5dbfc..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/MessageType.mdx +++ /dev/null @@ -1,11 +0,0 @@ -### RECEIVED - -### SENT - -### FAILED - -### UNCONFIRMED - -### VALUE - -### CONFIRMED diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/MigratedFundsEntry.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/MigratedFundsEntry.mdx deleted file mode 100644 index 00d271744f6..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/MigratedFundsEntry.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### tailTransactionHash(): String - -Returns the tail transaction hash of a `MigratedFundsEntry`. - -### output(): [SignatureLockedSingleOutput](#signaturelockedsingleoutput) - -Returns the output of a `MigratedFundsEntry`. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationAddress.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationAddress.mdx deleted file mode 100644 index 068106a17b8..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationAddress.mdx +++ /dev/null @@ -1,9 +0,0 @@ -Migration address - -### trytes(): String - -address tryte encoded - -### bech32(): String - -address bech32 encoded diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationBundle.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationBundle.mdx deleted file mode 100644 index 9edeefed0bd..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationBundle.mdx +++ /dev/null @@ -1,9 +0,0 @@ -Migration bundle. - -### crackability(): double - -The bundle crackability if it was mined. - -### getBundleHash(): String - -The bundle hash. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationBundleOptions.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationBundleOptions.mdx deleted file mode 100644 index 366ec615c07..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationBundleOptions.mdx +++ /dev/null @@ -1,39 +0,0 @@ -Finds account data for the migration from legacy network. - -### MigrationBundleOptions(): [MigrationBundleOptions](#migrationbundleoptions) - -### setMine(node): void - -| Parameter | Type | Description | -| --------- | ------- | ----------- | -| node | boolean | | - -### mine(): boolean - -### setTimeouts(secs): void - -Sets the timeout in seconds, negative to set default - -| Parameter | Type | Description | -| --------- | ---- | ----------- | -| secs | long | | - -### timeouts(): long - -Returns the set timeout, defaults to 10 minutes - -### setOffset(offset): void - -| Parameter | Type | Description | -| --------- | ---- | ----------- | -| offset | Long | | - -### offset(): OptionalLong - -### setLogFileName(log_file_name): void - -| Parameter | Type | Description | -| ------------- | ------ | ----------- | -| log_file_name | String | | - -### logFileName(): Optional<String> diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationData.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationData.mdx deleted file mode 100644 index 59405c365f0..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationData.mdx +++ /dev/null @@ -1,18 +0,0 @@ -Migration data. - -### balance(): long - -Total seed balance. - -### lastCheckedAddressIndex(): long - -The index of the last checked address. -Useful if you want to call the finder again. - -### inputs(): [InputData[]](#inputdata) - -Migration inputs. - -### spentAddresses(): boolean - -If any of the inputs are spent diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationProgressEvent.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationProgressEvent.mdx deleted file mode 100644 index 2e5520f956e..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationProgressEvent.mdx +++ /dev/null @@ -1,13 +0,0 @@ -Type container for handling the different Migration events. - -### getType(): [MigrationProgressType](#migrationprogresstype) - -### asFetchingMigrationData(): [FetchingMigrationData](#fetchingmigrationdata) - -### asMiningBundle(): [MiningBundle](#miningbundle) - -### asSigningBundle(): [SigningBundle](#signingbundle) - -### asBroadcastingBundle(): [BroadcastingBundle](#broadcastingbundle) - -### asTransactionConfirmed(): [TransactionConfirmed](#transactionconfirmed) diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationProgressListener.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationProgressListener.mdx deleted file mode 100644 index 097b90f2aea..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationProgressListener.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### onMigrationProgress(event): void - -| Parameter | Type | Description | -| --------- | ------------------------------------------------- | ----------- | -| event | [MigrationProgressEvent](#migrationprogressevent) | | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationProgressType.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationProgressType.mdx deleted file mode 100644 index b87aaf3e015..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/MigrationProgressType.mdx +++ /dev/null @@ -1,21 +0,0 @@ -Migration event type. - -### FETCHING_MIGRATION_DATA - -Fetching migration data on the given address range. - -### MINING_BUNDLE - -Mining the bundle with the given spent address. - -### SIGNING_BUNDLE - -Signing the bundle. - -### BROADCASTING_BUNDLE - -Broadcasting the given bundle hash. - -### TRANSACTION_CONFIRMED - -Transaction confirmation event. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/MilestoneId.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/MilestoneId.mdx deleted file mode 100644 index 57ee3d0f20a..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/MilestoneId.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### fromString(str_rep): [MilestoneId](#milestoneid) - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| str_rep | String | | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/MilestonePayload.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/MilestonePayload.mdx deleted file mode 100644 index 7f299988ae2..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/MilestonePayload.mdx +++ /dev/null @@ -1,9 +0,0 @@ -A payload which defines the inclusion set of other messages in the Tangle. - -### essence(): [MilestonePayloadEssence](#milestonepayloadessence) - -Returns the essence of a `MilestonePayload`. - -### signatures(): [MilestoneSignature[]](#milestonesignature) - -Returns the signatures of a `MilestonePayload`. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/MilestonePayloadEssence.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/MilestonePayloadEssence.mdx deleted file mode 100644 index 7006e00b1b6..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/MilestonePayloadEssence.mdx +++ /dev/null @@ -1,31 +0,0 @@ -### index(): long - -Returns the index of a `MilestonePayloadEssence`. - -### timestamp(): long - -Returns the timestamp of a `MilestonePayloadEssence`. - -### parents(): [MessageId[]](#messageid) - -Returns the parents of a `MilestonePayloadEssence`. - -### merkleProof(): byte[] - -Returns the merkle proof of a `MilestonePayloadEssence`. - -### nextPowScore(): long - -Returns the next proof of work score of a `MilestonePayloadEssence`. - -### nextPowScoreMilestone(): long - -Returns the next proof of work index of a `MilestonePayloadEssence`. - -### publicKeys(): [PublicKey[]](#publickey) - -Returns the public keys of a `MilestonePayloadEssence`. - -### receipt(): Optional<[ReceiptPayload](#receiptpayload)> - -Returns the optional receipt of a `MilestonePayloadEssence`. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/MilestoneSignature.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/MilestoneSignature.mdx deleted file mode 100644 index 2fcd24f606b..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/MilestoneSignature.mdx +++ /dev/null @@ -1,3 +0,0 @@ -### getSignature(): byte[] - -Gets the signature of the milestone diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/MiningBundle.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/MiningBundle.mdx deleted file mode 100644 index 651d782b822..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/MiningBundle.mdx +++ /dev/null @@ -1,5 +0,0 @@ -Mining the bundle with the given spent address. - -### getAddress(): String - -The spent address. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/NativeAPI.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/NativeAPI.mdx deleted file mode 100644 index 0a71cc98dea..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/NativeAPI.mdx +++ /dev/null @@ -1,3 +0,0 @@ -The NativeAPI class, which houses all entrypoints to the shared library. - -### verifyLink(): void diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/NewTransactionListener.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/NewTransactionListener.mdx deleted file mode 100644 index f7c767df478..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/NewTransactionListener.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### onNewTransaction(event): void - -| Parameter | Type | Description | -| --------- | ------------------------------------- | ----------- | -| event | [TransactionEvent](#transactionevent) | | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/NodeInfoWrapper.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/NodeInfoWrapper.mdx deleted file mode 100644 index 22d06b7edef..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/NodeInfoWrapper.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### url(): String - -Get the URL from which this info is derived - -### nodeInfo(): [InfoResponse](#inforesponse) - -Get the information diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/OutputKind.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/OutputKind.mdx deleted file mode 100644 index 3bf939096bf..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/OutputKind.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### NONE - -### SIGNATURE_LOCKED_SINGLE - -### SIGNATURE_LOCKED_DUST_ALLOWANCE - -### TREASURY diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/PreparedTransactionData.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/PreparedTransactionData.mdx deleted file mode 100644 index 3080c4cb2e8..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/PreparedTransactionData.mdx +++ /dev/null @@ -1,13 +0,0 @@ -Prepared transaction event data. - -### inputs(): [TransactionIO[]](#transactionio) - -Transaction inputs. - -### outputs(): [TransactionIO[]](#transactionio) - -Transaction outputs. - -### data(): Optional<String> - -The indexation data. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/PublicKey.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/PublicKey.mdx deleted file mode 100644 index aaacdcd26da..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/PublicKey.mdx +++ /dev/null @@ -1,20 +0,0 @@ -### verify(sig, msg): boolean - -Verify the signature and bytes against this public key - -| Parameter | Type | Description | -| --------- | ----------------------- | ----------------------- | -| sig | [Signature](#signature) | The signature to verify | -| msg | byte[] | The bytes to verify | - -### toBytes(): byte[] - -Turns ths public key into bytes - -### tryFromBytes(bs): [PublicKey](#publickey) - -Attempt to create a public key from the provided bytes - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| bs | byte[] | | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/ReattachTransactionListener.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/ReattachTransactionListener.mdx deleted file mode 100644 index 626d17b24c6..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/ReattachTransactionListener.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### onReattachTransaction(event): void - -| Parameter | Type | Description | -| --------- | ------------------------------------------------------------- | ----------- | -| event | [TransactionReattachmentEvent](#transactionreattachmentevent) | | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/ReceiptPayload.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/ReceiptPayload.mdx deleted file mode 100644 index d6622175d19..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/ReceiptPayload.mdx +++ /dev/null @@ -1,9 +0,0 @@ -### migratedAt(): long - -The milestone index at which the funds of a `ReceiptPayload` were migrated - -### last(): boolean - -Whether a `ReceiptPayload` is the final one for a given migrated at index. - -### funds(): [MigratedFundsEntry[]](#migratedfundsentry) diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/ReferenceUnlock.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/ReferenceUnlock.mdx deleted file mode 100644 index f22fba82f3b..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/ReferenceUnlock.mdx +++ /dev/null @@ -1,11 +0,0 @@ -### from(index): [ReferenceUnlock](#referenceunlock) - -Creates a new `ReferenceUnlock`. - -| Parameter | Type | Description | -| --------- | ---- | ------------------------------------------- | -| index | int | The unlock block index we use for signature | - -### index(): int - -Return the index of a `ReferenceUnlock`. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/RegularEssence.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/RegularEssence.mdx deleted file mode 100644 index 1c135b197ea..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/RegularEssence.mdx +++ /dev/null @@ -1,25 +0,0 @@ -### inputs(): [TransactionInput[]](#transactioninput) - -Gets the transaction inputs. - -### outputs(): [TransactionOutput[]](#transactionoutput) - -Gets the transaction outputs. - -### payload(): Optional<[IndexationPayload](#indexationpayload)> - -### internal(): boolean - -Whether the transaction is between the mnemonic accounts or not. - -### incoming(): boolean - -Whether the transaction is incoming or outgoing. - -### value(): long - -The transactions's value. - -### remainderValue(): long - -The transactions's remainder value sum. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/RemainderValueStrategy.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/RemainderValueStrategy.mdx deleted file mode 100644 index dc0b63e3cd1..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/RemainderValueStrategy.mdx +++ /dev/null @@ -1,3 +0,0 @@ -### REUSE_ADDRESS - -### CHANGE_ADDRESS diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/RustHex.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/RustHex.mdx deleted file mode 100644 index 4c998a66641..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/RustHex.mdx +++ /dev/null @@ -1,11 +0,0 @@ -### encode(a0): String - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| a0 | String | | - -### decode(s): byte[] - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| s | String | | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/RustLogging.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/RustLogging.mdx deleted file mode 100644 index 58b4b1a31ae..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/RustLogging.mdx +++ /dev/null @@ -1 +0,0 @@ -### init(): void diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/Signature.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/Signature.mdx deleted file mode 100644 index 8e01a06ae82..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/Signature.mdx +++ /dev/null @@ -1,11 +0,0 @@ -### toBytes(): byte[] - -Turn the signature into bytes - -### fromBytes(bs): [Signature](#signature) - -Turns bytes into a signature - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| bs | byte[] | | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/SignatureLockedDustAllowanceOutput.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/SignatureLockedDustAllowanceOutput.mdx deleted file mode 100644 index 3a97125be4c..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/SignatureLockedDustAllowanceOutput.mdx +++ /dev/null @@ -1,19 +0,0 @@ -Output type for deposits that enables an address to receive dust outputs. It can be consumed as an input like a -regular SigLockedSingleOutput. - -### from(address, amount): [SignatureLockedDustAllowanceOutput](#signaturelockeddustallowanceoutput) - -Creates a new `SignatureLockedDustAllowanceOutput`. - -| Parameter | Type | Description | -| --------- | --------------------------------- | ------------------ | -| address | [AddressWrapper](#addresswrapper) | The address to set | -| amount | long | The amount to set | - -### amount(): long - -Returns the amount of a `SignatureLockedDustAllowanceOutput`. - -### address(): [AddressWrapper](#addresswrapper) - -Returns the address of a `SignatureLockedDustAllowanceOutput`. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/SignatureLockedSingleOutput.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/SignatureLockedSingleOutput.mdx deleted file mode 100644 index 3723ed5506b..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/SignatureLockedSingleOutput.mdx +++ /dev/null @@ -1,19 +0,0 @@ -Describes a deposit to a single address which is unlocked via a signature. - -### from(address, amount, remainder): [SignatureLockedSingleOutput](#signaturelockedsingleoutput) - -Creates a new `SignatureLockedSingleOutput`. - -| Parameter | Type | Description | -| --------- | --------------------------------- | ------------------------------- | -| address | [AddressWrapper](#addresswrapper) | The address to set | -| amount | long | The amount to set | -| remainder | boolean | if this output allows remainder | - -### amount(): long - -Returns the amount of a `SignatureLockedSingleOutput`. - -### address(): [AddressWrapper](#addresswrapper) - -Returns the address of a `SignatureLockedSingleOutput`. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/SignatureUnlock.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/SignatureUnlock.mdx deleted file mode 100644 index ae77deecf56..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/SignatureUnlock.mdx +++ /dev/null @@ -1,8 +0,0 @@ -### SignatureUnlock(public_key, signature): [SignatureUnlock](#signatureunlock) - -Create a new Signature inlock block - -| Parameter | Type | Description | -| ---------- | ------ | -------------------------------------------- | -| public_key | byte[] | The public ket used for this signature block | -| signature | byte[] | The signature created for this unlock block | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/SigningBundle.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/SigningBundle.mdx deleted file mode 100644 index b4da9ecfb67..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/SigningBundle.mdx +++ /dev/null @@ -1,5 +0,0 @@ -Signing the bundle. - -### getAddresses(): String[] - -The addresses associated with the bundle. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/StrongholdStatusEvent.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/StrongholdStatusEvent.mdx deleted file mode 100644 index e8fc5c0c54a..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/StrongholdStatusEvent.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### snapshotPath(): Path - -### status(): [StrongholdStatusType](#strongholdstatustype) - -### unlockedDuration(): Duration diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/StrongholdStatusListener.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/StrongholdStatusListener.mdx deleted file mode 100644 index 836a8886aab..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/StrongholdStatusListener.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### onStrongholdStatusChange(event): void - -| Parameter | Type | Description | -| --------- | ----------------------------------------------- | ----------- | -| event | [StrongholdStatusEvent](#strongholdstatusevent) | | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/StrongholdStatusType.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/StrongholdStatusType.mdx deleted file mode 100644 index d02ca9d159e..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/StrongholdStatusType.mdx +++ /dev/null @@ -1,3 +0,0 @@ -### UNLOCKED - -### LOCKED diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/SyncedAccount.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/SyncedAccount.mdx deleted file mode 100644 index eaed94a3721..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/SyncedAccount.mdx +++ /dev/null @@ -1,3 +0,0 @@ -### deposit_address(): [Address](#address) - -Get a deposit address guaranteed to be valid after having synced diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionConfirmationChangeEvent.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionConfirmationChangeEvent.mdx deleted file mode 100644 index fdf6f73ebfe..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionConfirmationChangeEvent.mdx +++ /dev/null @@ -1,17 +0,0 @@ -A transaction confirmation state change event data. - -### indexationId(): String - -Event unique identifier. - -### accountId(): String - -The associated account identifier. - -### message(): [Message](#message) - -The event message. - -### confirmed(): boolean - -The confirmed state of the transaction. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionConfirmationChangeListener.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionConfirmationChangeListener.mdx deleted file mode 100644 index d9127cbf327..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionConfirmationChangeListener.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### onConfirmationStateChange(event): void - -| Parameter | Type | Description | -| --------- | ------------------------------------------------------------------------- | ----------- | -| event | [TransactionConfirmationChangeEvent](#transactionconfirmationchangeevent) | | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionConfirmed.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionConfirmed.mdx deleted file mode 100644 index f10d1873986..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionConfirmed.mdx +++ /dev/null @@ -1,5 +0,0 @@ -Transaction confirmation event. - -### getBundleHash(): String - -The bundle hash. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionEvent.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionEvent.mdx deleted file mode 100644 index 02666390b84..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionEvent.mdx +++ /dev/null @@ -1,13 +0,0 @@ -A transaction-related event data. - -### indexationId(): String - -Event unique identifier. - -### accountId(): String - -The associated account identifier. - -### message(): [Message](#message) - -The event message. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionIO.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionIO.mdx deleted file mode 100644 index 5539001e864..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionIO.mdx +++ /dev/null @@ -1,13 +0,0 @@ -Input or output data for PreparedTransactionData - -### address(): String - -Address - -### amount(): long - -Amount - -### remainder(): Optional<Boolean> - -Remainder diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionId.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionId.mdx deleted file mode 100644 index 529a526a5af..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionId.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### fromString(str_rep): [TransactionId](#transactionid) - -| Parameter | Type | Description | -| --------- | ------ | ----------- | -| str_rep | String | | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionInput.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionInput.mdx deleted file mode 100644 index 47c8fffd655..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionInput.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### kind(): [InputKind](#inputkind) - -### asUtxo(): [UtxoInput](#utxoinput) - -### asTreasury(): [TreasuryInput](#treasuryinput) diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionOutput.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionOutput.mdx deleted file mode 100644 index 5b1fe93a442..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionOutput.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### kind(): [OutputKind](#outputkind) - -### asSignatureLockedSingleOutput(): [SignatureLockedSingleOutput](#signaturelockedsingleoutput) - -### asSignatureLockedDustAllowanceOutput(): [SignatureLockedDustAllowanceOutput](#signaturelockeddustallowanceoutput) - -### asTreasuryOutput(): [TreasuryOutput](#treasuryoutput) diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionPayload.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionPayload.mdx deleted file mode 100644 index ac2ec94d7b6..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionPayload.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### essence(): [Essence](#essence) - -Return the essence of a `TransactionPayload`. - -### unlockBlocks(): [UnlockBlock[]](#unlockblock) - -Return unlock blocks of a `TransactionPayload`. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionReattachmentEvent.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionReattachmentEvent.mdx deleted file mode 100644 index 3500c9ee8ea..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransactionReattachmentEvent.mdx +++ /dev/null @@ -1,17 +0,0 @@ -Transaction reattachment event data. - -### indexationId(): String - -Event unique identifier. - -### accountId(): String - -The associated account identifier. - -### message(): [Message](#message) - -The event message. - -### reattachedMessageId(): [MessageId](#messageid) - -The id of the message that was reattached. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/Transfer.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/Transfer.mdx deleted file mode 100644 index c02139f1c8c..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/Transfer.mdx +++ /dev/null @@ -1,9 +0,0 @@ -### builder(address, amount, output_kind): [TransferBuilder](#transferbuilder) - -Creates a new Builder for making a Transfer object - -| Parameter | Type | Description | -| ----------- | --------------------------------- | --------------------------------------------------------- | -| address | [AddressWrapper](#addresswrapper) | The addres we want to send to | -| amount | long | The amount we want to send | -| output_kind | [OutputKind](#outputkind) | The kind of output we wish to use, can be OutputKind.NONE | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransferBuilder.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/TransferBuilder.mdx deleted file mode 100644 index 342ba4ee3f7..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransferBuilder.mdx +++ /dev/null @@ -1,49 +0,0 @@ -### TransferBuilder(address, amount, output_kind): [TransferBuilder](#transferbuilder) - -Initialises a new transfer to the given address. - -| Parameter | Type | Description | -| ----------- | --------------------------------- | --------------------------------- | -| address | [AddressWrapper](#addresswrapper) | The addres we want to send to | -| amount | long | The amount we want to send | -| output_kind | [OutputKind](#outputkind) | The kind of output we wish to use | - -### newFromOutputs(outputs): [TransferBuilder](#transferbuilder) - -Creates a transfer with multiple outputs. - -| Parameter | Type | Description | -| --------- | ----------------------------------- | --------------- | -| outputs | [TransferOutput[]](#transferoutput) | List of outputs | - -### withRemainderValueStrategy(strategy): [TransferBuilder](#transferbuilder) - -Sets the remainder value strategy for the transfer. - -| Parameter | Type | Description | -| --------- | ------------------------------------------------- | --------------------------------------------------- | -| strategy | [RemainderValueStrategy](#remaindervaluestrategy) | The type of strategy we use to handle the remainder | - -### withRemainderToAccountWithAddress(address): [TransferBuilder](#transferbuilder) - -Move the remainder value to an address that must belong to the source account. - -| Parameter | Type | Description | -| --------- | --------------------------------- | ------------------------------------- | -| address | [AddressWrapper](#addresswrapper) | The address we send the remainder t o | - -### withIndexation(indexation): [TransferBuilder](#transferbuilder) - -(Optional) message indexation. - -| Parameter | Type | Description | -| ---------- | --------------------------------------- | ------------------------------------------- | -| indexation | [IndexationPayload](#indexationpayload) | Build a transfer with this specific payload | - -### withSkipSync(): [TransferBuilder](#transferbuilder) - -Skip account syncing before transferring. - -### finish(): [Transfer](#transfer) - -Builds the transfer. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransferOutput.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/TransferOutput.mdx deleted file mode 100644 index e2831facca4..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransferOutput.mdx +++ /dev/null @@ -1,23 +0,0 @@ -Transfer output. - -### TransferOutput(address, amount, output_kind): [TransferOutput](#transferoutput) - -Transfer output - -| Parameter | Type | Description | -| ----------- | --------------------------------- | -------------------------------------------------------------------------- | -| address | [AddressWrapper](#addresswrapper) | The addres we want to send to | -| amount | long | The amount we want to send | -| output_kind | [OutputKind](#outputkind) | The kind of output we wish to use. Default used is SIGNATURE_LOCKED_SINGLE | - -### getAmount(): long - -The output value. - -### getAddress(): [AddressWrapper](#addresswrapper) - -The output address. - -### getOutputKind(): [OutputKind](#outputkind) - -The output type diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransferProgress.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/TransferProgress.mdx deleted file mode 100644 index fc9d3b7df89..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransferProgress.mdx +++ /dev/null @@ -1,7 +0,0 @@ -Type container for handling the different TransferProgress events. - -### getType(): [TransferProgressType](#transferprogresstype) - -### asPreparedTransaction(): [PreparedTransactionData](#preparedtransactiondata) - -### asGeneratingRemainderDepositAddress(): [AddressData](#addressdata) diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransferProgressListener.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/TransferProgressListener.mdx deleted file mode 100644 index 087f776e337..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransferProgressListener.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### onTransferProgress(event): void - -| Parameter | Type | Description | -| --------- | ------------------------------------------------- | ----------- | -| event | [WalletTransferProgress](#wallettransferprogress) | | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransferProgressType.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/TransferProgressType.mdx deleted file mode 100644 index 0ec3fd14d51..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/TransferProgressType.mdx +++ /dev/null @@ -1,29 +0,0 @@ -Transfer event data. - -### SYNCING_ACCOUNT - -Syncing account. - -### SELECTING_INPUTS - -Performing input selection. - -### GENERATING_REMAINDER_DEPOST_ADDRESS - -Generating remainder value deposit address. - -### PREPARED_TRANSACTION - -Prepared transaction. - -### SIGNING_TRANSACTION - -Signing the transaction. - -### PERFORMING_POW - -Performing PoW. - -### BROADCASTING - -Broadcasting. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/TreasuryInput.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/TreasuryInput.mdx deleted file mode 100644 index 4f998c30d30..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/TreasuryInput.mdx +++ /dev/null @@ -1,13 +0,0 @@ -`TreasuryInput` is an input which references a milestone which generated a `TreasuryOutput`. - -### TreasuryInput(id): [TreasuryInput](#treasuryinput) - -Create a new TreasuryInput - -| Parameter | Type | Description | -| --------- | --------------------------- | -------------------------------------------------- | -| id | [MilestoneId](#milestoneid) | The MilestoneId which Generated a `TreasuryOutput` | - -### milestoneId(): [MilestoneId](#milestoneid) - -Returns the milestones id of a `TreasuryInput`. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/TreasuryOutput.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/TreasuryOutput.mdx deleted file mode 100644 index 30a399ec980..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/TreasuryOutput.mdx +++ /dev/null @@ -1,11 +0,0 @@ -### from(amount): [TreasuryOutput](#treasuryoutput) - -Creates a new TreasuryOutput with the amount supplied - -| Parameter | Type | Description | -| --------- | ---- | ----------- | -| amount | long | | - -### amount(): long - -Returns the amount of a `TreasuryOutput`. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/TreasuryPayload.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/TreasuryPayload.mdx deleted file mode 100644 index 73a637605e5..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/TreasuryPayload.mdx +++ /dev/null @@ -1,3 +0,0 @@ -### output(): [TreasuryOutput](#treasuryoutput) - -### input(): [TreasuryInput](#treasuryinput) diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/UnlockBlock.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/UnlockBlock.mdx deleted file mode 100644 index 44f44637118..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/UnlockBlock.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### kind(): [UnlockBlockKind](#unlockblockkind) - -### asReference(): [ReferenceUnlock](#referenceunlock) - -### asSignature(): [SignatureUnlock](#signatureunlock) diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/UnlockBlockKind.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/UnlockBlockKind.mdx deleted file mode 100644 index fba94f0f65c..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/UnlockBlockKind.mdx +++ /dev/null @@ -1,3 +0,0 @@ -### ED25519 - -### REFERENCE diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/UtxoInput.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/UtxoInput.mdx deleted file mode 100644 index 58bafa9e529..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/UtxoInput.mdx +++ /dev/null @@ -1,18 +0,0 @@ -Represents an input referencing an output. - -### from(id, index): [UtxoInput](#utxoinput) - -Create a new `UtxoInput` - -| Parameter | Type | Description | -| --------- | ------------------------------- | ---------------- | -| id | [TransactionId](#transactionid) | The ouput Id | -| index | int | The output Index | - -### transactionId(): [TransactionId](#transactionid) - -Returns the `TransactionId` of the Output. - -### index(): int - -Returns the index of the Output. diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/Value.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/Value.mdx deleted file mode 100644 index 1679576bfb9..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/Value.mdx +++ /dev/null @@ -1,12 +0,0 @@ -### Value(value, unit): [Value](#value) - -| Parameter | Type | Description | -| --------- | ----------------------- | ----------- | -| value | long | | -| unit | [ValueUnit](#valueunit) | | - -### withDenomination(): String - -### withoutDenomination(): long - -### value(): long diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/ValueUnit.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/ValueUnit.mdx deleted file mode 100644 index c22ebaed544..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/ValueUnit.mdx +++ /dev/null @@ -1,11 +0,0 @@ -### I - -### Ki - -### Mi - -### Gi - -### Ti - -### Pi diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/WalletException.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/WalletException.mdx deleted file mode 100644 index 29bd3576dac..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/WalletException.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### WalletException(): [WalletException](#walletexception) - -### WalletException(errorMessage): [WalletException](#walletexception) - -| Parameter | Type | Description | -| ------------ | ------ | ----------- | -| errorMessage | String | | diff --git a/docs/build/wallet.rs/0.1/docs/reference/java_api/WalletTransferProgress.mdx b/docs/build/wallet.rs/0.1/docs/reference/java_api/WalletTransferProgress.mdx deleted file mode 100644 index 5d98607b563..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/java_api/WalletTransferProgress.mdx +++ /dev/null @@ -1,7 +0,0 @@ -### accountId(): String - -The associated account identifier. - -### event(): [TransferProgress](#transferprogress) - -Get the event linked to this progress diff --git a/docs/build/wallet.rs/0.1/docs/reference/nodejs.md b/docs/build/wallet.rs/0.1/docs/reference/nodejs.md deleted file mode 100644 index 9d61e88fa56..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/nodejs.md +++ /dev/null @@ -1,593 +0,0 @@ ---- -description: Official IOTA Wallet Library Software Node.js API reference. -image: /img/logo/logo.svg -keywords: - - api - - nodejs - - param - - type - - reference ---- - -# Node.js API Reference - -## initLogger(config: LogOptions) - -Initializes the logging system. - -### LogOptions - -| Param | Type | Default | Description | -| ------------- | ------------- | ----------- | --------------------------------------- | -| color_enabled | `boolean` | `undefined` | Whether to enable colored output or not | -| outputs | `LogOutput[]` | `undefined` | The log outputs | - -### LogOutput - -| Param | Type | Default | Description | -| -------------- | ---------- | ----------- | ---------------------------------------------------- | -| name | `string` | `undefined` | 'stdout' or a path to a file | -| level_filter | `string` | `'info'` | The maximum log level that this output accepts | -| target_filters | `string[]` | `[]` | Filters on the log target (library and module names) | - -## addEventListener(event, cb) - -Adds a new event listener with a callback in the form of `(err, data) => {}`. - -Supported event names: - -- ErrorThrown -- BalanceChange -- NewTransaction -- ConfirmationStateChange -- Reattachment -- Broadcast -- TransferProgress -- MigrationProgress - -## AccountManager - -### constructor([ManagerOptions]) - -Creates a new instance of the AccountManager. - -| Param | Type | Default | Description | -| --------------------------------- | -------- | ----------- | -------------------------------------------- | -| [ManagerOptions](#manageroptions) | `object` | `undefined` | The options to configure the account manager | - -#### ManagerOptions - -You can use any of the following parameters when constructing the ManagerOptions. All the parameters are optional. - -| Param | Type | Default | Description | -| -------------------------------- | --------- | ----------- | ----------------------------------------------------------------------------------------- | -| storagePath | `string` | `undefined` | The path where the database file will be saved | -| storagePassword | `string` | `undefined` | The storage password | -| outputConsolidationThreshold | `number` | `100` | The number of outputs an address must have to trigger the automatic consolidation process | -| automaticOutputConsolidation | `boolean` | `true` | Disables the automatic output consolidation if false | -| syncSpentOutputs | `boolean` | `false` | Enables fetching spent output history on account sync | -| persistEvents | `boolean` | `false` | Enables event persistence | -| allowCreateMultipleEmptyAccounts | `boolean` | `false` | Enables creating accounts with latest account being empty | -| skipPolling | `boolean` | `false` | Enables creating accounts without automatic polling (background syncing) | -| pollingInterval | `number` | `30` | Sets the polling interval in seconds | - -### setStrongholdPassword(password): void - -Sets the Stronghold password and initialises it. - -| Param | Type | Default | Description | -| -------- | -------- | ----------- | -------------------------------- | -| password | `string` | `undefined` | The Stronghold snapshot password | - -### changeStrongholdPassword(currentPassword, newPassword): void - -Changes the Stronghold password. - -| Param | Type | Default | Description | -| --------------- | -------- | ----------- | ------------------------------- | -| currentPassword | `string` | `undefined` | The current Stronghold password | -| newPassword | `string` | `undefined` | The new Stronghold password | - -### createAccount(account): Account - -Creates a new account. - -| Param | Type | Default | Description | -| --------------------- | --------------------------------- | ------------------------- | -------------------------------------------------------- | -| account | `object` | `{}` | The account to be created | -| account.clientOptions | `[ClientOptions](#clientoptions)` | `undefined` | The node configuration | -| [account.mnemonic] | `string` | `undefined` | The account BIP39 mnemonic | -| [account.alias] | `string` | `Account ${index + 1}` | The account alias | -| [account.createdAt] | `string` | the current date and time | The ISO 8601 date string of the account creation | -| [account.signerType] | `number` | 1 = Stronghold | The account signer type. 1 = Stronghold, 2 = EnvMnemonic | - -### getAccount(accountId) - -Gets the account with the given identifier or index. - -| Param | Type | Default | Description | -| --------- | ------------------ | ------- | --------------------------------------- | -| accountId | `string \| number` | `null` | The account identifier or account index | - -Returns the associated Account instance or undefined if the account wasn't found. - -### getAccountByAlias(alias) - -Gets the account with the given alias (case-insensitive). - -| Param | Type | Default | Description | -| ----- | -------- | ------- | ----------------- | -| alias | `string` | `null` | The account alias | - -Returns the associated Account instance or undefined if the account wasn't found. - -### getAccounts() - -Gets all stored accounts. - -Returns an array of [Account objects](#account). - -### removeAccount(accountId) - -Removes the account with the given identifier or index. - -| Param | Type | Default | Description | -| --------- | ------------------ | ------- | --------------------------------------- | -| accountId | `string \| number` | `null` | The account identifier or account index | - -### startBackgroundSync(pollingInterval, automaticOutputConsolidation): Promise - -Starts the background polling and MQTT monitoring. - -| Param | Type | Default | Description | -| ---------------------------- | --------- | ------- | ------------------------------------------------ | -| pollingInterval | `number` | `null` | The polling interval in seconds | -| automaticOutputConsolidation | `boolean` | `null` | If outputs should get consolidated automatically | - -### stop_background_sync(): void - -Stops the background polling and MQTT monitoring. - -### syncAccounts([options]) - -Synchronize all stored accounts with the Tangle. - -| Param | Type | Default | Description | -| ---------------------- | -------- | ---------------------- | ----------------------------------------------------- | -| [options] | `object` | `{}` | The sync options | -| [options.addressIndex] | `number` | `latest address index` | The index of the first account address to sync | -| [options.gapLimit] | `number` | `10` | The number of addresses to check on each account sync | - -Returns a promise resolving to an array of [SyncedAccount](#syncedaccount). - -### internalTransfer(fromAccount, toAccount, amount) - -Transfers an amount from one sub-account to another. - -| Param | Type | Default | Description | -| ----------- | --------------------- | ----------- | ----------------------- | -| fromAccount | `[Account](#account)` | `null` | The source account | -| toAccount | `[Account](#account)` | `null` | The destination account | -| amount | `number` | `undefined` | The transfer amount | - -Returns a promise resolving to the transfer's Message. - -### backup(destination, password) - -Backups the database. - -| Param | Type | Default | Description | -| ----------- | -------- | ----------- | ------------------------------ | -| destination | `string` | `undefined` | The path to the backup file | -| password | `string` | `undefined` | The backup Stronghold password | - -Returns the full path to the backup file. - -### importAccounts(source) - -Imports a database file. - -| Param | Type | Default | Description | -| -------- | -------- | ----------- | ------------------------------ | -| source | `string` | `undefined` | The path to the backup file | -| password | `string` | `undefined` | The backup Stronghold password | - -### isLatestAddressUnused() - -Determines whether all accounts have unused their latest address after syncing with the Tangle. - -Returns a promise resolving to the boolean value. - -### setClientOptions(options) - -Updates the client options for all accounts. - -| Param | Type | Default | Description | -| ------- | --------------------------------- | ------- | ------------------------------ | -| options | `[ClientOptions](#clientoptions)` | `null` | The new account client options | - -### generateMigrationAddress(address) - -Convert a Ed25519 to a Tryte migration address with checksum (last 9 Trytes) - -| Param | Type | Default | Description | -| ------- | -------- | ------- | ------------------------------ | -| address | `string` | `null` | Bech32 encoded Ed25519 address | - -### getBalanceChangeEvents([count, skip, fromTimestamp]) - -Gets the persisted balance change events. - -| Param | Type | Default | Description | -| --------------- | -------- | ------- | ------------------------------------------------------------ | -| [count] | `number` | `0` | The number of events to return (`0` to return all) | -| [skip] | `number` | `0` | The number of events to skip | -| [fromTimestamp] | `number` | `null` | Filter events that were stored after the given UTC timestamp | - -Event object: { indexationId: string, accountId: string, messageId?: string, remainder?: boolean, balanceChange: { spent: number, received: number } } - -### getBalanceChangeEventCount([fromTimestamp]) - -Gets the number of persisted balance change events. - -| Param | Type | Default | Description | -| --------------- | -------- | ------- | ------------------------------------------------------------ | -| [fromTimestamp] | `number` | `null` | Filter events that were stored after the given UTC timestamp | - -### getTransactionConfirmationEvents([count, skip, fromTimestamp]) - -Gets the persisted transaction confirmation change events. - -| Param | Type | Default | Description | -| --------------- | -------- | ------- | ------------------------------------------------------------ | -| [count] | `number` | `0` | The number of events to return (`0` to return all) | -| [skip] | `number` | `0` | The number of events to skip | -| [fromTimestamp] | `number` | `null` | Filter events that were stored after the given UTC timestamp | - -Event object: { indexationId: string, accountId: string, message: Message, confirmed: boolean } - -### getTransactionConfirmationEventCount([fromTimestamp]) - -Gets the number of persisted transaction confirmation change events. - -| Param | Type | Default | Description | -| --------------- | -------- | ------- | ------------------------------------------------------------ | -| [fromTimestamp] | `number` | `null` | Filter events that were stored after the given UTC timestamp | - -### getNewTransactionEvents([count, skip, fromTimestamp]) - -Gets the persisted new transaction events. - -| Param | Type | Default | Description | -| --------------- | -------- | ------- | ------------------------------------------------------------ | -| [count] | `number` | `0` | The number of events to return (`0` to return all) | -| [skip] | `number` | `0` | The number of events to skip | -| [fromTimestamp] | `number` | `null` | Filter events that were stored after the given UTC timestamp | - -Event object: { indexationId: string, accountId: string, message: Message } - -### getNewTransactionEventCount([fromTimestamp]) - -Gets the number of persisted new transaction events. - -| Param | Type | Default | Description | -| --------------- | -------- | ------- | ------------------------------------------------------------ | -| [fromTimestamp] | `number` | `null` | Filter events that were stored after the given UTC timestamp | - -### getReattachmentEvents([count, skip, fromTimestamp]) - -Gets the persisted transaction reattachment events. - -| Param | Type | Default | Description | -| --------------- | -------- | ------- | ------------------------------------------------------------ | -| [count] | `number` | `0` | The number of events to return (`0` to return all) | -| [skip] | `number` | `0` | The number of events to skip | -| [fromTimestamp] | `number` | `null` | Filter events that were stored after the given UTC timestamp | - -Event object: { indexationId: string, accountId: string, message: Message } - -### getReattachmentEventCount([fromTimestamp]) - -Gets the number of persisted transaction reattachment events. - -| Param | Type | Default | Description | -| --------------- | -------- | ------- | ------------------------------------------------------------ | -| [fromTimestamp] | `number` | `null` | Filter events that were stored after the given UTC timestamp | - -### getBroadcastEvents([count, skip, fromTimestamp]) - -Gets the persisted transaction broadcast events. - -| Param | Type | Default | Description | -| --------------- | -------- | ------- | ------------------------------------------------------------ | -| [count] | `number` | `0` | The number of events to return (`0` to return all) | -| [skip] | `number` | `0` | The number of events to skip | -| [fromTimestamp] | `number` | `null` | Filter events that were stored after the given UTC timestamp | - -Event object: { indexationId: string, accountId: string, message: Message } - -### getBroadcastEventCount([fromTimestamp]) - -Gets the number of persisted transaction broadcast events. - -| Param | Type | Default | Description | -| --------------- | -------- | ------- | ------------------------------------------------------------ | -| [fromTimestamp] | `number` | `null` | Filter events that were stored after the given UTC timestamp | - -## SyncedAccount - -The result of a `sync` operation on an Account. - -## Account - -### id() - -Returns the account's identifier. - -### index() - -Returns the account's index. - -### alias() - -Returns the account's alias. - -### balance(): AccountBalance - -Returns the account's balance information object. - -Balance object: { total: number, available: number, incoming: number, outgoing: number } - -### messageCount([type]) - -Returns the number of messages associated with the account. - -| Param | Type | Default | Description | -| ------ | -------- | ------- | ---------------------------------------------------------------------------------------- | -| [type] | `number` | `null` | The message type filter (Received = 1, Sent = 2, Failed = 3, Unconfirmed = 4, Value = 5) | - -### listMessages([count, from, type]) - -Returns the account's messages. - -| Param | Type | Default | Description | -| ------- | -------- | ------- | ---------------------------------------------------------------------------------------- | -| [count] | `number` | `0` | The number of messages to return (`0` to return all) | -| [skip] | `number` | `0` | The number of messages to skip | -| [type] | `number` | `null` | The message type filter (Received = 1, Sent = 2, Failed = 3, Unconfirmed = 4, Value = 5) | - -Message object: { confirmed: boolean, broadcasted: boolean, incoming: boolean, value: number } - -### listAddresses([unspent]) - -Returns the account's addresses. - -| Param | Type | Default | Description | -| --------- | --------- | ------- | ------------------------- | -| [unspent] | `boolean` | `null` | The unspent status filter | - -Address object: { address: string, keyIndex: number } - -### sync([options]) - -Synchronizes the account with the Tangle. - -| Param | Type | Default | Description | -| ---------------------- | -------- | ---------------------- | -------------------------------------- | -| [options] | `object` | `{}` | The sync options | -| [options.addressIndex] | `number` | `latest address index` | The index of the first address to sync | -| [options.gapLimit] | `number` | `10` | The number of addresses to check | - -Returns a [SyncedAccount](#syncedaccount) instance. - -### send(address, amount[, options]) - -Send funds to the given address. - -| Param | Type | Default | Description | -| ------- | ----------------- | ----------- | ----------------------------------------- | -| address | `string` | `null` | The bech32 string of the transfer address | -| amount | `number` | `undefined` | The transfer amount | -| options | `TransferOptions` | `undefined` | The transfer options | - -#### TransferOptions - -| Param | Type | Default | Description | -| ---------------------- | -------------------------------------- | ----------------------- | ----------------------------------------------------- | -| remainderValueStrategy | `RemainderValueStrategy` | `null` | The strategy to use for the remainder value if any | -| indexation | `{ index: string, data?: Uint8Array }` | `null` | Message indexation | -| skipSync | `boolean` | `false` | Send transfer without synchronising the account first | -| outputKind | `OutputKind` | `signatureLockedSingle` | Output kind | - -#### RemainderValueStrategy - -##### changeAddress() - -Send the remainder value to an internal address. - -###### reuseAddress() - -Send the remainder value to its original address. - -###### accountAddress(address: string) - -Send the remainder value to a specific address that must belong to the account. - -### getNodeInfo([url, auth]): NodeInfoWrapper - -Gets information about the node. - -| Param | Type | Default | Description | -| ----- | -------- | -------------------------- | --------------------- | -| url | `string` | `Node from client options` | The node url | -| auth | `Auth` | `undefined` | The node auth options | - -Returns the [NodeInfoWrapper](#nodeinfowrapper) - -#### NodeInfoWrapper - -| Param | Type | Default | Description | -| -------- | --------------------- | -------------------------- | ------------- | -| url | `string` | `Node from client options` | The node url | -| nodeinfo | [NodeInfo](#nodeinfo) | `null` | The node info | - -##### NodeInfo - -All the values are for the NodeInfo are set by the nodes. - -| Param | Type | Default | Description | -| ----------------------------- | ---------- | ------- | -------------------------------------------- | -| [name] | `string` | `null` | The node name | -| [version] | `string` | `null` | The node version | -| [isHealthy] | `boolean` | `null` | Indicates if the node is healthy | -| [networkId] | `number` | `null` | The network ID | -| [bech32HRP] | `string` | `null` | The human-readable part of the bech32 string | -| [minPoWScore] | `number` | `null` | The node minimum proof of work score | -| [messagesPerSecond] | `number` | `null` | The node messages per second | -| [referencedMessagesPerSecond] | `number` | `null` | The node references per second | -| [referencedRate] | `number` | `null` | The node reference rate | -| [latestMilestoneTimestamp] | `number` | `null` | The node's latest milestone timestamp | -| [latestMilestoneIndex] | `number` | `null` | The node's latest milestone index | -| [confirmedMilestoneIndex] | `number` | `null` | The node's confirmed milestone index | -| [pruningIndex] | `number` | `null` | The node's pruning index | -| [features] | `string[]` | `null` | The node's features. | - -### retry(messageId) - -Retries (promotes or reattaches) the given message. - -| Param | Type | Default | Description | -| --------- | -------- | ------- | ------------------------ | -| messageId | `string` | `null` | The message's identifier | - -### reattach(messageId) - -Reattach the given message. - -| Param | Type | Default | Description | -| --------- | -------- | ------- | ------------------------ | -| messageId | `string` | `null` | The message's identifier | - -### promote(messageId) - -Promote the given message. - -| Param | Type | Default | Description | -| --------- | -------- | ------- | ------------------------ | -| messageId | `string` | `null` | The message's identifier | - -### consolidateOutputs([includeDustAllowanceOutputs]) - -Consolidate the outputs on all account addresses. - -| Param | Type | Default | Description | -| --------------------------- | --------- | ------- | ------------------------------------------------- | -| includeDustAllowanceOutputs | `boolean` | `false` | If true, also consolidates dust allowance outputs | - -### isLatestAddressUnused() - -Determines whether the account has an unused latest address after syncing with the Tangle. - -Returns a promise resolving to the boolean value. - -### setAlias(alias) - -Updates the account alias. - -| Param | Type | Default | Description | -| ----- | -------- | ------- | --------------------- | -| alias | `string` | `null` | The new account alias | - -### setClientOptions(options) - -Updates the account client options. - -| Param | Type | Default | Description | -| ------- | --------------------------------- | ------- | ------------------------------ | -| options | `[ClientOptions](#clientoptions)` | `null` | The new account client options | - -### getMessage(messageId) - -Gets the message associated with the given identifier. - -| Param | Type | Default | Description | -| --------- | -------- | ------- | ------------------------ | -| messageId | `string` | `null` | The message's identifier | - -### getAddress(addressBech32) - -Gets the address object by its bech32 representation. - -| Param | Type | Default | Description | -| ------------- | -------- | ------- | --------------------------------- | -| addressBech32 | `string` | `null` | The address bech32 representation | - -### generateAddress() - -Generates a new unused address and returns it. - -| Param | Type | Default | Description | -| ------ | -------- | ----------- | ----------------------- | -| amount | `number` | `undefined` | The amount of addresses | - -### latestAddress() - -Returns the latest address (the one with the biggest keyIndex). - -### getUnusedAddress() - -Synchronizes the account addresses with the Tangle and returns the latest address in the account, -which is an address without balance. - -## ClientOptions - -| Field | Type | Default | Description | -| ------------------- | ------------------- | ---------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| [network] | `number` | `undefined` | The tangle network to connect to (Mainnet = 1, Devnet = 1, Comnet = 3) | -| [primaryNode] | `NodeUrl | [Node](#node)` | `undefined` | A node URL to alway connect to first | -| [primaryPoWNode] | `NodeUrl | [Node](#node)` | `undefined` | A node URL to alway connect to first when using remote PoW, will be used before primaryNode | -| [node] | `NodeUrl | [Node](#node)` | `undefined` | A node URL to connect to | -| [nodes] | `NodeUrl | [Node](#node)[]` | `undefined` | A list node URL to connect to | -| [quorumSize] | `number` | `undefined` | If multiple nodes are provided, quorum size determines the number of nodes to query to check for quorum. | -| [quorumThreshold] | `number` | `undefined` | Minimum number of nodes from the quorum pool that need to agree to consider a result true. | -| [localPow] | `boolean` | `true` | Whether to use local or remote PoW. | -| [MqttBrokerOptions] | `MqttBrokerOptions` | `undefined` | Options for the MQTT broker | - -## MqttBrokerOptions - -All fields are optional. - -| Field | Type | Description | -| ----------------------- | --------- | ----------------------------------------------------------------------------------------------------- | -| automaticDisconnect | `boolean` | Whether the MQTT broker should be automatically disconnected when all topics are unsubscribed or not. | -| timeout | `number` | MQTT connection timeout in seconds | -| useWs | `boolean` | Defines if websockets should be used (true) or TCP (false) | -| maxReconnectionAttempts | `number` | Defines the maximum reconnection attempts before it returns an error | -| port | `number` | Defines the port to be used for the MQTT connection | - -### Auth - -| Field | Type | Default | Description | -| ---------- | -------- | ----------- | ------------------------------------------ | -| [jwt] | `string` | `undefined` | Optional JSON Web Token. | -| [username] | `string` | `undefined` | Optional name for basic authentication | -| [password] | `string` | `undefined` | Optional password for basic authentication | - -### Node - -NodeUrl = string - -| Field | Type | Default | Description | -| ---------- | --------- | ----------- | ------------------------------------------ | -| [url] | `NodeUrl` | `undefined` | Node url | -| [auth] | `Auth` | `undefined` | Optional authentication options | -| [disabled] | `boolean` | `false` | Optional password for basic authentication | - -### OutputKind - -Possible output kinds. - -| Field | Type | Default | Description | -| ------------------------------ | -------- | ------- | -------------------------------------------------- | -| [signatureLockedSingle] | `string` | `null` | Default output type | -| [signatureLockedDustAllowance] | `string` | `null` | Output type to enable receiving dust on an address | diff --git a/docs/build/wallet.rs/0.1/docs/reference/python.md b/docs/build/wallet.rs/0.1/docs/reference/python.md deleted file mode 100644 index cedf4e0de31..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/python.md +++ /dev/null @@ -1,1127 +0,0 @@ ---- -description: Official IOTA Wallet Library Software Python API reference. -image: /img/logo/logo.svg -keywords: - - api - - python - - param - - type - - reference ---- - -# Python API Reference - -:::info -The following APIs will throw an exception if an error occurs. -For all optional values, the default values are the same as in the [Rust API](rust.md). -::: - -## init_logger(config) - -| Param | Type | Default | Description | -| ------ | ----- | ----------- | ------------------------ | -| config | `str` | `undefined` | The logger configuration | - -The config is the dumped string from the JSON, which key:value pairs are from the [fern logger](https://github.com/iotaledger/common-rs/blob/main/fern-logger/src/config.rs). - -Please check the `example/logger_example.py` to see how to use it. - -## AccountManager - -### constructor(storage_path (optional), password (optional), polling_interval (optional), automatic_output_consolidation(optional), output_consolidation_threshold(optional), sync_spent_outputs(optional), persist_events(optional)): [AccountManager](#accountmanager) - -Creates a new instance of the AccountManager. - -| Param | Type | Default | Description | -| -------------------------------------- | --------- | ----------- | ---------------------------------------------------------------------------------------------- | -| [storage_path] | `str` | `./storage` | The path where the database file will be saved | -| [storage_password] | `str` | `undefined` | The storage password to encrypt/decrypt accounts | -| [polling_interval] | `int` | `30000` | The polling interval in seconds | -| [automatic_output_consolidation] | `bool` | `true` | Disables the automatic output consolidation process | -| [output_consolidation_threshold] | `int` | `100` | Sets the number of outputs an address must have to trigger the automatic consolidation process | -| [sync_spent_outputs] | `boolean` | `false` | Enables fetching spent output history on account sync | -| [persist_events] | `boolean` | `false` | Enables event persistence | -| [allow_create_multiple_empty_accounts] | `boolean` | `false` | Enables creating accounts with latest account being empty | - -:::info -If the _storage_path_ is set, then the _storage_ needs to be set too. An exception will be thrown when errors happened. -::: - -Returns the constructed [AccountManager](#accountmanager). - -### start_background_sync(polling_interval, automatic_output_consolidation): void - -Starts the background polling and MQTT monitoring. - -| Param | Type | Default | Description | -| ------------------------------ | --------- | ----------- | ------------------------------------------------ | -| polling_interval | `number` | `undefined` | The polling interval in seconds | -| automatic_output_consolidation | `boolean` | `undefined` | If outputs should get consolidated automatically | - -### stop_background_sync(): void - -Stops the background polling and MQTT monitoring. - -### set_storage_password(password): void - -Sets the password used for encrypting the storage. - -| Param | Type | Default | Description | -| -------- | ----- | ----------- | -------------------- | -| password | `str` | `undefined` | The storage password | - -### set_stronghold_password(password): void - -Sets the Stronghold password. - -| Param | Type | Default | Description | -| -------- | ----- | ----------- | -------------------- | -| password | `str` | `undefined` | The storage password | - -### is_latest_address_unused(): bool - -Determines whether all accounts have the latest address unused. - -Returns _true_ if the latest address is unused. - -### store_mnemonic(signer_type, mnemonic (optional)): bool - -Stores a mnemonic for the given signer type. -If the mnemonic is not provided, we'll generate one. - -| Param | Type | Default | Description | -| ----------- | ----- | -------------------- | ---------------------------------------------------------------- | -| signer_type | `str` | `undefined` | Should be _Stronghold_ , _LedgerNano_ , or _LedgerNanoSimulator_ | -| mnemonic | `str` | `randomly generated` | The provided mnemonic or the randomly generated one | - -### generate_mnemonic(): str - -Generates a new mnemonic. - -Returns the generated mnemonic string. - -### verify_mnemonic(mnemonic): void - -Checks is the mnemonic is valid. If a mnemonic was generated with _generate_mnemonic()_ , the mnemonic here should match the generated. - -| Param | Type | Default | Description | -| -------- | ----- | ----------- | --------------------- | -| mnemonic | `str` | `undefined` | The provided mnemonic | - -### create_account(client_options): [AccountInitialiser](#accountinitialiser) - -Creat a new account. - -| Param | Type | Default | Description | -| -------------- | --------------------------------- | ----------- | ------------------ | -| client_options | `[ClientOptions](#clientoptions)` | `undefined` | The client options | - -Returns a constructed [AccountInitialiser](#accountinitialiser). - -### remove_account(account_id): void - -Deletes an account. - -| Param | Type | Default | Description | -| ---------- | ----- | ----------- | -------------------------------------- | -| account_id | `str` | `undefined` | The account with this id to be deleted | - -### sync_accounts(): [AccountsSynchronizer](#accountssynchronizer) - -Returns the [AccountsSynchronizer](#accountssynchronizer) to setup the process to synchronize the accounts with the Tangle. - -### internal_transfer(from_account_id, to_account_id, amount): WalletMessage - -Transfers an amount from an account to another. - -| Param | Type | Default | Description | -| --------------- | ----- | ----------- | ------------------------------------------------ | -| from_account_id | `str` | `undefined` | The source of account id in the transfering | -| to_account_id | `str` | `undefined` | The destination of account id in the transfering | -| amount | `int` | `undefined` | The transfer amount | - -Returns the transfer's [WalletMessage](#walletmessage). - -### backup(destination, Stronghold_password): str - -Backups the storage to the given destination. - -| Param | Type | Default | Description | -| ------------------- | ----- | ----------- | ------------------------------ | -| destination | `str` | `undefined` | The path to the backup file | -| Stronghold_password | `str` | `undefined` | The backup Stronghold password | - -Returns the full path to the backup file. - -### import_accounts(source, Stronghold_password): void - -Imports a database file. - -| Param | Type | Default | Description | -| ------------------- | ----- | ----------- | ------------------------------ | -| source | `str` | `undefined` | The path to the backup file | -| Stronghold_password | `str` | `undefined` | The backup Stronghold password | - -### get_account(account_id): [AccountHandle](#accounthandle) - -Gets the account with the given identifier or index. - -| Param | Type | Default | Description | -| ---------- | ----- | ----------- | ---------------------------------------------------- | -| account_id | `str` | `undefined` | The account id, alias, index or one of its addresses | - -Returns the associated AccountHandle object or undefined if the account wasn't found. - -### get_accounts(): list[[AccountHandle](#accounthandle)] - -Gets all stored accounts. - -Returns a list of [AccountHandle](#accounthandle). - -### retry(account_id, message_id): [WalletMessage](#walletmessage) - -Retries (promotes or reattaches) the given message. - -| Param | Type | Default | Description | -| ---------- | ----- | ----------- | ---------------------------------------------------- | -| account_id | `str` | `undefined` | The account id, alias, index or one of its addresses | -| message_id | `str` | `undefined` | The message's identifier | - -Returns the retried [WalletMessage](#walletmessage). - -### reattach(account_id, message_id): [WalletMessage](#walletmessage) - -Reattach the given message. - -| Param | Type | Default | Description | -| ---------- | ----- | ----------- | ---------------------------------------------------- | -| account_id | `str` | `undefined` | The account id, alias, index or one of its addresses | -| message_id | `str` | `undefined` | The message's identifier | - -Returns the reattached [WalletMessage](#walletmessage). - -### promote(account_id, message_id): [WalletMessage](#walletmessage) - -Promote the given message. - -| Param | Type | Default | Description | -| ---------- | ----- | ----------- | ---------------------------------------------------- | -| account_id | `str` | `undefined` | The account id, alias, index or one of its addresses | -| message_id | `str` | `undefined` | The message's identifier | - -Returns the promoted [WalletMessage](#walletmessage). - -### get_balance_change_events(count (optional), skip (optional), from_timestamp (optional)) - -Gets the persisted balance change events. - -| Param | Type | Default | Description | -| -------------- | -------- | ------- | ------------------------------------------------------------ | -| count | `number` | `0` | The number of events to return (`0` to return all) | -| skip | `number` | `0` | The number of events to skip | -| from_timestamp | `number` | `null` | Filter events that were stored after the given UTC timestamp | - -Event object: { accountId: string, address: string, balanceChange: { spent: number, received: number } } - -### get_balance_change_event_count(from_timestamp (optional)) - -Gets the number of persisted balance change events. - -| Param | Type | Default | Description | -| -------------- | -------- | ------- | ------------------------------------------------------------ | -| from_timestamp | `number` | `null` | Filter events that were stored after the given UTC timestamp | - -### get_transaction_confirmation_events(count (optional), skip (optional), from_timestamp (optional)) - -Gets the persisted transaction confirmation change events. - -| Param | Type | Default | Description | -| -------------- | -------- | ------- | ------------------------------------------------------------ | -| count | `number` | `0` | The number of events to return (`0` to return all) | -| skip | `number` | `0` | The number of events to skip | -| from_timestamp | `number` | `null` | Filter events that were stored after the given UTC timestamp | - -Event object: { accountId: string, message: Message, confirmed: boolean } - -### get_transaction_confirmation_event_count(from_timestamp (optional)) - -Gets the number of persisted transaction confirmation change events. - -| Param | Type | Default | Description | -| -------------- | -------- | ------- | ------------------------------------------------------------ | -| from_timestamp | `number` | `null` | Filter events that were stored after the given UTC timestamp | - -### get_new_transaction_events(count (optional), skip (optional), from_timestamp (optional)) - -Gets the persisted new transaction events. - -| Param | Type | Default | Description | -| -------------- | -------- | ------- | ------------------------------------------------------------ | -| count | `number` | `0` | The number of events to return (`0` to return all) | -| skip | `number` | `0` | The number of events to skip | -| from_timestamp | `number` | `null` | Filter events that were stored after the given UTC timestamp | - -Event object: { accountId: string, message: Message } - -### get_new_transaction_event_count(from_timestamp (optional)) - -Gets the number of persisted new transaction events. - -| Param | Type | Default | Description | -| -------------- | -------- | ------- | ------------------------------------------------------------ | -| from_timestamp | `number` | `null` | Filter events that were stored after the given UTC timestamp | - -### get_reattachment_events(count (optional), skip (optional), from_timestamp (optional)) - -Gets the persisted transaction reattachment events. - -| Param | Type | Default | Description | -| -------------- | -------- | ------- | ------------------------------------------------------------ | -| count | `number` | `0` | The number of events to return (`0` to return all) | -| skip | `number` | `0` | The number of events to skip | -| from_timestamp | `number` | `null` | Filter events that were stored after the given UTC timestamp | - -Event object: { accountId: string, message: Message } - -### get_reattachment_event_count(from_timestamp (optional)) - -Gets the number of persisted transaction reattachment events. - -| Param | Type | Default | Description | -| -------------- | -------- | ------- | ------------------------------------------------------------ | -| from_timestamp | `number` | `null` | Filter events that were stored after the given UTC timestamp | - -### get_broadcast_events(count (optional), skip (optional), from_timestamp (optional)) - -Gets the persisted transaction broadcast events. - -| Param | Type | Default | Description | -| -------------- | -------- | ------- | ------------------------------------------------------------ | -| count | `number` | `0` | The number of events to return (`0` to return all) | -| skip | `number` | `0` | The number of events to skip | -| from_timestamp | `number` | `null` | Filter events that were stored after the given UTC timestamp | - -Event object: { accountId: string, message: Message } - -### get_broadcast_event_count(from_timestamp (optional)) - -Gets the number of persisted transaction broadcast events. - -| Param | Type | Default | Description | -| -------------- | -------- | ------- | ------------------------------------------------------------ | -| from_timestamp | `number` | `null` | Filter events that were stored after the given UTC timestamp | - -## AccountSynchronizer - -### gap_limit(limit): void - -Set the number of address indexes that are generated. - -| Param | Type | Default | Description | -| ----- | ----- | ----------- | ------------------------------------------------ | -| limit | `int` | `undefined` | The number of address indexes that are generated | - -### skip_persistence(): void - -Skip saving new messages and addresses on the account object. -The found [SyncedAccount](#syncedaccount) is returned on the _execute_ call but won't be persisted on the database. - -### address_index(address_index): void - -Set the initial address index to start syncing. - -| Param | Type | Default | Description | -| ------------- | ----- | ----------- | ------------------------------------------ | -| address_index | `int` | `undefined` | The initial address index to start syncing | - -### execute(): [SyncedAccount](#syncedaccount) - -Syncs account with the tangle. -The account syncing process ensures that the latest metadata (balance, transactions) associated with an account is fetched from the tangle and is stored locally. - -## AccountsSynchronizer - -### gap_limit(limit): void - -Set the number of address indexes that are generated on each account. - -| Param | Type | Default | Description | -| ----- | ----- | ----------- | ---------------------------------------------------------------- | -| limit | `int` | `undefined` | The number of address indexes that are generated on each account | - -### address_index(address_index): void - -Set the initial address index to start syncing on each account. - -| Param | Type | Default | Description | -| ------------- | ----- | ----------- | ---------------------------------------------------------- | -| address_index | `int` | `undefined` | The initial address index to start syncing on each account | - -### execute(): list[SyncedAccount](#syncedaccount) - -Syncs the accounts with the tangle. - -## Transfer - -### constructor(amount, address, indexation (optional), remainder_value_strategy (optional): str, skip_sync (optional), output_kind (optional)): [Transfer](#transfer) - -The _Transfer_ object used in [SyncedAccount](#syncedaccount) - -| Param | Type | Default | Description | -| ------------------------ | --------------------------- | ----------------- | ------------------------------------------------------------------- | -| amount | `int` | `undefined` | The amount to transfer | -| address | `str` | `undefined` | The address to send | -| indexation | `[Indexation](#indexation)` | `null` | The indexation payload | -| remainder_value_strategy | `str` | `_ChangeAddress_` | Should be _ReuseAddress_ or _ChangeAddress_ | -| skip_sync | `bool` | `False` | Whether to skip the sync process | -| output_kind | `str` | `null` | Should be _SignatureLockedSingle_ or _SignatureLockedDustAllowance_ | - -## TransferOutput - -| Param | Type | Default | Description | -| ----------- | ----- | ----------- | ------------------------------------------------------------------- | -| amount | `int` | `undefined` | The amount to transfer | -| address | `str` | `undefined` | The address to send | -| output_kind | `str` | `null` | Should be _SignatureLockedSingle_ or _SignatureLockedDustAllowance_ | - -## TransferWithOutputs - -### constructor(outputs: list[TransferOutput], indexation (optional), remainder_value_strategy (optional): str, skip_sync (optional)): [TransferWithOutputs](#transferwithoutputs) - -The _Transfer_ object used in [SyncedAccount](#syncedaccount) - -| Param | Type | Default | Description | -| ------------------------ | --------------------------- | ----------------- | ------------------------------------------- | -| outputs | `list[TransferOutput]` | `undefined` | The amount to transfer | -| indexation | `[Indexation](#indexation)` | `null` | The indexation payload | -| remainder_value_strategy | `str` | `_ChangeAddress_` | Should be _ReuseAddress_ or _ChangeAddress_ | -| skip_sync | `bool` | `False` | Whether to skip the sync process | - -## SyncedAccount - -The result of a _sync_ operation on an Account. - -### account_handle(): [AccountHandle](#accounthandle) - -Get the [AccountHandle](#accounthandle) of this account - -Returns the [AccountHandle](#accounthandle). - -### deposit_address(): [Address](#address) - -Get the deposit_address of this account. - -Returns the [Address](#address). - -### messages(): [WalletMessage](#walletmessage) - -Get the messages of this account. - -Returns the [WalletMessage](#walletmessage). - -### addresses() - -Get the addresses of this account. - -Returns the list of [WalletMessage](#walletmessage). - -## AccountHandle - -### id(): str - -Returns the account ID. - -### signer_type(): str - -Returns the signer type of this account. - -### index(): int - -Returns the account index. - -### alias(): str - -Returns the account alias. - -### created_at(): int - -Returns the created UNIX timestamp. - -### last_synced_at(): int or None (it did not be synced before) - -Returns the last synced UNIX timestamp. - -### client_options(): [ClientOptions](#clientoptions) - -Returns the client options of this account. - -### bech32_hrp(): str - -Returns the Bech32 HRP string. - -### sync(): [AccountSynchronizer](#accountsynchronizer) - -Returns the [AccountSynchronizer](#accountsynchronizer) to setup the process to synchronize this account with the Tangle. - -### transfer(transfer_obj): [WalletMessage](#walletmessage) - -Transfer tokens. - -| Param | Type | Default | Description | -| ------------ | ----------------------- | ----------- | ---------------------------- | -| transfer_obj | `[Transfer](#transfer)` | `undefined` | The transfer we want to make | - -Returns the [WalletMessage](#walletmessage) which makes the transfering. - -### transfer_with_outputs(transfer_obj): [WalletMessage](#walletmessage) - -Transfer tokens. - -| Param | Type | Default | Description | -| ------------ | ----------------------- | ----------- | ---------------------------- | -| transfer_obj | `[Transfer](#transfer)` | `undefined` | The transfer we want to make | - -Returns the [WalletMessage](#walletmessage) which makes the transfering. - -### retry(message_id): [WalletMessage](#walletmessage) - -Retries (promotes or reattaches) the given message. - -| Param | Type | Default | Description | -| ---------- | ----- | ----------- | ------------------------ | -| message_id | `str` | `undefined` | The message's identifier | - -Returns the retried [WalletMessage](#walletmessage). - -### reattach(message_id): [WalletMessage](#walletmessage) - -Reattach the given message. - -| Param | Type | Default | Description | -| ---------- | ----- | ----------- | ------------------------ | -| message_id | `str` | `undefined` | The message's identifier | - -Returns the reattached [WalletMessage](#walletmessage). - -### promote(message_id): [WalletMessage](#walletmessage) - -Promote the given message. - -| Param | Type | Default | Description | -| ---------- | ----- | ----------- | ------------------------ | -| message_id | `str` | `undefined` | The message's identifier | - -Returns the promoted [WalletMessage](#walletmessage). - -### consolidate_outputs(): list[WalletMessage](#walletmessage) - -Consolidates the account addresses outputs. - -Returns the list of generated [WalletMessage](#walletmessage). - -### generate_address(): list[[Address](#address)] - -Returns a new unused address and links it to this account. - -### get_unused_address(): [Address](#address) - -Synchronizes the account addresses with the Tangle and returns the latest address in the account, which is an address without balance. - -Returns the latest address in the account. - -### is_latest_address_unused(): bool - -Syncs the latest address with the Tangle and determines whether it's unused or not. -An unused address is an address without balance and associated message history. -Note that such address might have been used in the past, because the message history might have been pruned by the node. - -Returns _true_ if the latest address in the account is unused. - -### latest_address(): [Address](#address) - -Returns the most recent address of the account. - -### addresses(): list[[Address](#address)] - -Returns a list of [Address](#address) in the account. - -### balance(): [AccountBalance](#accountbalance) - -Gets the account balance information. - -Returns the [AccountBalance](#accountbalance) in this account. - -### get_node_info(url (optional), auth (optional)): NodeInfoWrapper - -Gets information about the node. - -| Param | Type | Default | Description | -| ----- | ----------- | ----------- | --------------------- | -| url | `str` | `undefined` | The node url | -| auth | `list[str]` | `undefined` | The node auth options | - -Returns the [NodeInfoWrapper](#nodeinfowrapper) - -### set_alias(alias): void - -Updates the account alias. - -| Param | Type | Default | Description | -| ----- | ----- | ----------- | ------------------------ | -| alias | `str` | `undefined` | The account alias to set | - -### set_client_options(options): void - -Updates the account's client options. - -| Param | Type | Default | Description | -| ------- | --------------------------------- | ----------- | ------------------------- | -| options | `[ClientOptions](#clientoptions)` | `undefined` | The client options to set | - -### message_count(message_type (optional)): int - -Returns the number of messages associated with the account. - -| Param | Type | Default | Description | -| ------------ | ----- | ----------- | --------------------------------------------------------------------- | -| message_type | `str` | `undefined` | Should be _Received_ , _Sent_ , _Failed_ , _Unconfirmed_ , or _Value_ | - -### list_messages(count, from, message_type (optional)): list([WalletMessage](#walletmessage)) - -Get the list of messages of this account. - -| Param | Type | Default | Description | -| ------------ | ----- | ----------- | --------------------------------------------------------------------- | -| count | `int` | `undefined` | The count of the messages to get | -| from | `int` | `undefined` | The iniital address index | -| message_type | `str` | `undefined` | Should be _Received_ , _Sent_ , _Failed_ , _Unconfirmed_ , or _Value_ | - -### list_spent_addresses(): list[[Address](#address)] - -Returns the list of spent [Address](#address) in the account. - -### get_message(message_id): WalletMessage](#walletmessage) (optional) - -Get the [WalletMessage](#walletmessage) by the message identifier in the account if it exists. - -## AccountInitialiser - -### signer_type(signer_type): void - -Sets the account type. - -| Param | Type | Default | Description | -| ----------- | ----- | ------------- | ---------------------------------------------------------------- | -| signer_type | `str` | `signer_type` | Should be _Stronghold_ , _LedgerNano_ , or _LedgerNanoSimulator_ | - -### alias(alias): void - -Defines the account alias. If not defined, we'll generate one. - -| Param | Type | Default | Description | -| ----- | ----- | ----------- | ----------------- | -| alias | `str` | `undefined` | The account alias | - -### created_at(created_at): void - -Time of account creation. - -| Param | Type | Default | Description | -| ---------- | ----- | ----------- | ------------------------- | -| created_at | `u64` | `undefined` | The account creation time | - -### messages(messages): void - -Messages associated with the seed. -The account can be initialised with locally stored messages. - -| Param | Type | Default | Description | -| -------- | --------------------------------------- | ----------- | --------------------------- | -| messages | `list([WalletMessage](#walletmessage))` | `undefined` | The locally stored messages | - -### addresses(addresses): list([WalletAddress](#walletaddress)) - -Address history associated with the seed. -The account can be initialised with locally stored address history. - -| Param | Type | Default | Description | -| --------- | --------------------------------------- | ----------- | ------------------------ | -| addresses | `list([WalletAddress](#walletaddress))` | `undefined` | The historical addresses | - -### skip_persistence(): void - -Skips storing the account to the database. - -### initialise(): [AccountHandle](#accounthandle) - -Initialises the account. - -Returns the initilized [AccountHandle](#accounthandle) - -## Event Listeners - -### on_balance_change(callback): list[int] - -Listen to balance changes. - -| Param | Type | Default | Description | -| ---------- | ---------- | ----------- | --------------------- | -| [callback] | `function` | `undefined` | The callback function | - -Returns the event id as list[int]. - -### remove_balance_change_listener(list[int]): void - -Removes the balance change listener associated with the given identifier. - -| Param | Type | Default | Description | -| ----- | ----------- | ----------- | ------------ | -| [id] | `list[int]` | `undefined` | The event id | - -### on_new_transaction(callback): list[int] - -Listen to new messages. - -| Param | Type | Default | Description | -| ---------- | ---------- | ----------- | --------------------- | -| [callback] | `function` | `undefined` | The callback function | - -Returns the event id as list[int]. - -### remove_new_transaction_listener(list[int]): void - -Removes the new transaction listener associated with the given identifier. - -| Param | Type | Default | Description | -| ----- | ----------- | ----------- | ------------ | -| [id] | `list[int]` | `undefined` | The event id | - -### on_confirmation_state_change(callback): list[int] - -Listen to transaction confirmation state change. - -| Param | Type | Default | Description | -| ---------- | ---------- | ----------- | --------------------- | -| [callback] | `function` | `undefined` | The callback function | - -Returns the event id as list[int]. - -### remove_confirmation_state_change_listener(list[int]): void - -Removes the new transaction listener associated with the given identifier. - -| Param | Type | Default | Description | -| ----- | ----------- | ----------- | ------------ | -| [id] | `list[int]` | `undefined` | The event id | - -### on_reattachment(callback): list[int] - -Listen to transaction reattachment. - -| Param | Type | Default | Description | -| ---------- | ---------- | ----------- | --------------------- | -| [callback] | `function` | `undefined` | The callback function | - -Returns the event id as list[int]. - -### remove_reattachment_listener(list[int]): void - -Removes the reattachment listener associated with the given identifier. - -| Param | Type | Default | Description | -| ----- | ----------- | ----------- | ------------ | -| [id] | `list[int]` | `undefined` | The event id | - -### on_broadcast(callback): list[int] - -Listen to transaction broadcast. - -| Param | Type | Default | Description | -| ---------- | ---------- | ----------- | --------------------- | -| [callback] | `function` | `undefined` | The callback function | - -Returns the event id as list[int]. - -### remove_broadcast_listener(list[int]): void - -Removes the broadcast listener associated with the given identifier. - -| Param | Type | Default | Description | -| ----- | ----------- | ----------- | ------------ | -| [id] | `list[int]` | `undefined` | The event id | - -### on_error(callback): list[int] - -Listen to errors. - -| Param | Type | Default | Description | -| ---------- | ---------- | ----------- | --------------------- | -| [callback] | `function` | `undefined` | The callback function | - -Returns the event id as list[int]. - -### remove_error_listener(list[int]): void - -Removes the error listener associated with the given identifier. - -| Param | Type | Default | Description | -| ----- | ----------- | ----------- | ------------ | -| [id] | `list[int]` | `undefined` | The event id | - -### on_stronghold_status_change(callback): list[int] - -Listen to Stronghold status change events. - -| Param | Type | Default | Description | -| ---------- | ---------- | ----------- | --------------------- | -| [callback] | `function` | `undefined` | The callback function | - -Returns the event id as list[int]. - -### remove_stronghold_status_change_listener(list[int]): void - -Removes the Stronghold status change listener associated with the given identifier. - -| Param | Type | Default | Description | -| ----- | ----------- | ----------- | ------------ | -| [id] | `list[int]` | `undefined` | The event id | - -### on_transfer_progress(callback): list[int] - -Listen to transfer progress events. - -| Param | Type | Default | Description | -| ---------- | ---------- | ----------- | --------------------- | -| [callback] | `function` | `undefined` | The callback function | - -Returns the event id as list[int]. - -### remove_transfer_progress_listener(list[int]): void - -Removes the transfer progress listener associated with the given identifier. - -| Param | Type | Default | Description | -| ----- | ----------- | ----------- | ------------ | -| [id] | `list[int]` | `undefined` | The event id | - -### on_migration_progress(callback): list[int] - -Listen to migration progress events. - -| Param | Type | Default | Description | -| ---------- | ---------- | ----------- | --------------------- | -| [callback] | `function` | `undefined` | The callback function | - -Returns the event id as list[int]. - -### remove_migration_progress_listener(list[int]): void - -Removes the migration progress listener associated with the given identifier. - -| Param | Type | Default | Description | -| ----- | ----------- | ----------- | ------------ | -| [id] | `list[int]` | `undefined` | The event id | - -## WalletAddress - -A dict with the following key:value pairs. - -```python -wallet_address = { - 'address': str, - 'balance': int, - 'key_index': int, - 'internal': bool, - 'outputs': dict[(string, WalletAddressOutput)], -} -``` - -Please refer to [WalletAddressOutput](#walletaddressoutput) for the details of this type. - -## WalletAddressOutput - -A dict with the following key:value pairs. - -```python -wallet_address_output = { - 'transaction_id': str, - 'message_id': str, - 'index': int, - 'amount': int, - 'is_spent': bool, - 'address': str, - 'kind': str, -} -} -``` - -## Address - -A dict with the following key:value pairs. - -```python -address = { - 'address': AddressWrapper, - 'balance': int, - 'key_index': int, - 'internal': bool, - 'outputs': list[AddressOutput], -} -``` - -Please refer to [AddressWrapper](#addresswrapper) and [AddressOutput](#addressoutput) for the details of this type. - -## AddressWrapper - -A dict with the following key:value pairs. - -```python -address_wrapper = { - 'inner': str -} -``` - -## AddressOutput - -A dict with the following key:value pairs. - -```python -address_output = { - 'transaction_id': str, - 'message_id': str, - 'index': int, - 'amount': int, - 'is_spent': bool, - 'address': AddressWrapper, -} -``` - -Please refer to [AddressWrapper](#addresswrapper) for the details of this type. - -## AccountBalance - -A dict with the following key:value pairs. - -```python -account_balance = { - 'total': int, - 'available': int, - 'incoming': int, - 'outgoing': int, -} -``` - -## ClientOptions - -A dict with the following key:value pairs. - -```python -client_options = { - 'nodes': list[[Node](#node)] (optional), - 'primary_node': [Node](#node)] (optional), - 'primary_pow_node': [Node](#node)] (optional), - 'node_pool_urls': list[str] (optional), - 'network': str (optional), - 'mqtt_enabled': bool (optional), - 'mqtt_broker_options': [BrokerOptions](#brokeroptions) (optional), - 'local_pow': bool (optional), - 'node_sync_interval': int (optional), # in milliseconds - 'node_sync_enabled': bool (optional), - 'request_timeout': int (optional), # in milliseconds - 'api_timeout': { - 'GetTips': int (optional) # in milliseconds - 'PostMessage': int (optional) # in milliseconds - 'GetOutput': int (optional) # in milliseconds - } (optional) -} -``` - -Note that this message object in `wallet.rs` is not the same as the message object in `iota.rs`. - -## Node - -A dict with the following key:value pairs. - -```python -node = { - 'url': string, - 'auth': NodeAuth (optional), - 'disabled': bool, -} -``` - -## NodeAuth - -A dict with the following key:value pairs. - -```python -node = { - 'username': string, - 'password': string, -} -``` - -## BrokerOptions - -A dict with the following key:value pairs. - -```python -broker_options = { - 'automatic_disconnect': bool (optional), - 'timeout': int (optional), - 'use_ws': bool (optional), - 'port': u16 (optional), - 'max_reconnection_attempts': u64 (optional), -} -``` - -## WalletMessage - -A dict with the following key:value pairs. - -```python -wallet_message = { - 'id': str, - 'version': u64, - 'parents': list[str], - 'payload_length': int, - 'payload': Payload, - 'timestamp': int, - 'nonce': int, - 'confirmed': bool (optional), - 'broadcasted': bool -} -``` - -Please refer to [Payload](#payload) for the details of this type. - -## Payload - -A dict with the following key:value pairs. - -```python -payload = { - 'transaction': list[Transaction] (optional), - 'milestone': list[Milestone] (optional), - 'indexation': list[Indexation] (optional), -} -``` - -Please refer to [Transaction](#transaction), [Milestone](#milestone), and [Indexation](#indexation) for the details of these types. - -## Transaction - -A dict with the following key:value pairs. - -```python -transaction = { - 'essence': { - regular: RegularEssence - }, - 'unlock_blocks': list[UnlockBlock], -} -``` - -Please refer to [RegularEssence](#regularessence) and [UnlockBlock](#unlockblock) for the details of these types. - -## Milestone - -A dict with the following key:value pairs. - -```python -milestone = { - 'essence': MilestonePayloadEssence, - 'signatures': list[bytes], -} -``` - -Please refer to [MilestonePayloadEssence](#milestonepayloadessence) for the details of this type. - -## MilestonePayloadEssence - -A dict with the following key:value pairs. - -```python -milestone_payload_essence = { - 'index': int, - 'timestamp': int, - 'parents': list[str], - 'merkle_proof': bytes, - 'public_keys': bytes -} -``` - -## Indexation - -A dict with the following key:value pairs. - -```python -indexation = { - 'index': bytes, - 'data': bytes -} -``` - -## RegularEssenceEssence - -A dict with the following key:value pairs. - -```python -transaction_regular_essence = { - 'inputs': list[Input], - 'outputs': list[Output], - 'payload': Payload (optional), - 'internal': bool, - 'incoming': bool, - 'value': int, - 'remainder_value': int, -} -``` - -Please refer to [Input](#input), [Output](#output), and [Payload](#payload) for the details of these types. - -## Output - -A dict with the following key:value pairs. - -```python -output = { - 'address': str, - 'amount': int -} -``` - -## Input - -A dict with the following key:value pairs. - -```python -input = { - 'transaction_id': str, - 'index': int -} -``` - -## UnlockBlock - -A dict with the following key:value pairs. - -```python -unlock_block = { - 'signature': Ed25519Signature (optional), - 'reference': int (optional) -} -``` - -Please refer to [Ed25519Signature](#ed25519signature) for the details of this type. - -## Ed25519Signature - -A dict with the following key:value pairs. - -```python -ed25519_signature = { - 'public_key': bytes, - 'public_key': bytes -} -``` diff --git a/docs/build/wallet.rs/0.1/docs/reference/rust.md b/docs/build/wallet.rs/0.1/docs/reference/rust.md deleted file mode 100644 index f6fa1a2533e..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/rust.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -description: Official IOTA Wallet Library Software Rust API reference. -image: /img/logo/logo.svg -keywords: - - api - - rust - - cargo - - crate - - reference ---- - -# Rust API Reference - -If you would like to explore the implementation in more depth, you can generate docs for the whole crate by running the following command: - -``` -cargo doc --document-private-items --no-deps --open -``` diff --git a/docs/build/wallet.rs/0.1/docs/reference/specifications.md b/docs/build/wallet.rs/0.1/docs/reference/specifications.md deleted file mode 100644 index bb919bd9fb1..00000000000 --- a/docs/build/wallet.rs/0.1/docs/reference/specifications.md +++ /dev/null @@ -1,1182 +0,0 @@ ---- -description: The wallet.rs library is a stateful package with a standardized interface to build applications with IOTA value transactions. -image: /img/logo/logo.svg -keywords: - - wallet library methods - - Rust - - messages - - Required client library - - access modifiers - - types - - reference ---- - -# Wallet Library Specifications - -## Introduction - -The `wallet.rs` library is a stateful package with a standardized interface to build applications with IOTA value transactions. The package is compatible with different platforms such as web, desktop, and mobile. - -The package introduces the concept of an _account_ . An _account_ is a reference to, or a label for, a [seed](/introduction/reference/details#seed). It has certain properties such as [addresses](https://github.com/Wollac/protocol-rfcs/blob/bech32-address-format/text/0020-bech32-address-format/0020-bech32-address-format.md) and [messages](https://github.com/GalRogozinski/protocol-rfcs/blob/message/text/0017-message/0017-message.md). An account also maintains various behaviours, including moving funds, looking for new messages, and making copies of message histories. Additionally, it provides a degree of financial privacy and thus does not incur any overhead. - -[A similar account package was used before](/introduction/explanations/update/chrysalis_improvements#ed25519-signature-scheme) but it became obsolete with the introduction of Ed25519 signatures. The previous account package was also limited to a single account, whereas the new package manages multiple accounts. - -For IOTA, the motivation to use this package was to offer a simplified (stateful) approach to handle IOTA payments. - -## Considerations - -- Seeds should be stored and managed separately in a secure enclave and should never leave the secure environment. Secure enclaves include software enclaves such as IOTA’s Rust-based `Stronghold` library or hardware enclaves such as a `Ledger Nano`. - -- The secure enclave should have the ability to generate addresses and sign messages upon receipt, and return the output in a new message. If the secure enclave is initialized with a pre-generated seed, the sender process should immediately remove the seed traces from memory. - -## Naming Conventions - -The primary language is [Rust](https://github.com/rust-lang/rust). Therefore, you should follow the standard [Rust naming conventions](https://doc.rust-lang.org/1.0.0/style/style/naming/README.html). For reference, all interfaces (types) use _CamelCase_ while all function and variable names use _snake_case_. - -## Interfaces - -#### AccountConfiguration - -Account configuration or initialization object. It should support parameters accepted by high level [client](https://github.com/iotaledger/iota.rs) libraries. - -| Property | Required | Type | Description | -| ---------------- | -------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| seed | ✘ | string | BIP-39 mnemonic. When importing an account from Stronghold backup, the seed will not be required. | -| id | ✘ | string | SHA-256 hash of the first address on the seed (m/44'/0'/0'/0'/0'). Required for referencing a seed in Stronghold. The ID should be provided by Stronghold. | -| index | ✔ | number | Account index in [BIP-44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) derivation path | -| alias | ✘ | string | Account name. If not provided, `Account + { index }` should be used. When importing an account from Stronghold backup, the alias will be required from Stronghold. | -| pow | ✘ | `local`,`remote` | Proof of work settings. Defaults to `local`. `local` PoW should be performed on device; `remote` PoW should be performed on the node. | -| nodes | ✔ | [node](#node)[] | A list of nodes to connect to. | -| quorum_size | ✘ | number | If multiple nodes are provided, quorum size determines the number of nodes to query to check for quorum. | -| quorum_threshold | ✘ | number | Minimum number of nodes from the quorum pool that need to agree to consider a result true. | -| network | ✘ | `mainnet`\|`devnet` \| `comnet` | IOTA public network. | -| type | ✘ | `default` or `ledger` | Account type. Required for differentiating ledger vs non-ledger accounts. | -| provider | ✘ | string | Node URL. | -| created_at | ✘ | Date | Time of account creation | -| messages | ✘ | [Message](#message)[] Messages associated with account. Accounts can be initialized with locally stored messages. | -| addresses | ✘ | [Address](#address)[] | Address history associated with the account. Accounts can be initialized with locally stored address history | - -#### AccountObject - -| Property | Required | Type | Description | -| --------------------------- | -------- | -------- | --------------------------------------------------------------------------------------------------------------- | -| id | ✔ | string | SHA-256 hash of the first address on the seed (m/44'/0'/0'/0/0). Required for referencing a seed in Stronghold. | -| alias | ✔ | string | Account name. | -| created_at | ✔ | number | Account creation time. | -| last_synced_at | ✔ | string | Time the account was last synced with the Tangle. | -| sync() | ✔ | function | Syncs account with the Tangle. | -| reattach() | ✔ | function | Reattaches unconfirmed transaction to the Tangle. | -| total_balance() | ✔ | function | Gets total account balance. | -| available_balance() | ✔ | function | Gets available account balance. | -| set_alias() | ✔ | function | Updates account name. | -| list_messages() | ✔ | function | Gets messages. | -| list_received_messages() | ✔ | function | Gets all received messages. | -| list_sent_messages() | ✔ | function | Gets all sent messages. | -| list_failed_messages() | ✔ | function | Gets all failed messages. | -| list_unconfirmed_messages() | ✔ | function | Gets all unconfirmed messages. | -| get_message() | ✔ | function | Gets message for providedID. | -| list_addresses() | ✔ | function | Gets all addresses. | -| list_unspent_addresses() | ✔ | function | Gets all unspent input addresses. | -| generate_address() | ✔ | function | Gets the latest unused address. | - -#### SyncedAccountObject - -| Property | Required | Type | Description | -| --------------- | -------- | -------- | -------------------------------------------------------------------------------------------------- | -| deposit_address | ✔ | Address | Deposit address. Only exposed on successful completion of account syncing process. | -| send() | ✔ | function | Send transaction method. Only exposed on successful completion of account syncing process. | -| retry() | ✔ | function | Rebroadcasts failed transaction. Only exposed on successful completion of account syncing process. | - -#### AccountManagerObject - -| Property | Required | Type | Description | -| ----------------- | -------- | --------- | --------------------------------------------------------- | -| accounts | ✔ | Account[] | Account objects. | -| add_account() | ✔ | function | Adds a new account. | -| remove_account() | ✔ | function | Removes an account. | -| sync_accounts() | ✔ | function | Syncs all stored accounts with the Tangle. | -| move() | ✔ | function | Inititates an internal transaction between accounts. | -| backup() | ✔ | function | Creates a backup to a provided destination. | -| import_accounts() | ✔ | function | Imports backed up accounts. | -| get_account() | ✔ | function | Returns the account associated with the provided address. | -| reattach() | ✔ | function | Reattaches an unconfirmed transaction. | - -#### Address - -Useful [reference](https://medium.com/@harshagoli/hd-wallets-explained-from-high-level-to-nuts-and-bolts-9a41545f5b0) for address management in Hierarchical Deterministic (HD) wallets. - -| Property | Required | Type | Description | -| -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------- | -| address | ✔ | string | Address (Bech32) string. | -| balance | ✔ | number | Address balance. | -| index | ✔ | number | Address index. | -| internal | ✔ | boolean | Determines if an address is a public or an internal (change) address. See the concept of chain node for more details. | -| checksum | ✔ | string | Address checksum. | - -#### Node - -| Property | Required | Type | Description | -| -------- | -------- | --------------------------------- | ------------------------------------------------------------ | -| url | ✔ | string | Node URL. | -| pow | ✔ | boolean | Determines if the node accepts proof of work. | -| username | ✘ | string | Node username. Only required if node requires authorisation. | -| password | ✘ | string | Node password. Only required if node requires authorisation. | -| network | ✔ | `mainnet` \| `devnet` \| `comnet` | IOTA public network name. | - -#### Timestamp - -| Property | Required | Type | Description | -| --------------------------- | -------- | -------- | -------------------------------------------------------------------------------------------- | -| format(type: string):string | ✔ | function | Transaction timestamp in various formats.
For example: MM-DD-YYYY, DD MM YYYY hh:mm:ss. | - -#### Transfer - -Transfer object required for creating a transaction. It allows end-users to specify the transaction amount and recipient address. - -:::info -Currently, it is not possible to send multiple payloads as part of the message. That is why the _tag_ property is omitted from this interface. You can find more details in this [GitHub pull request](https://github.com/iotaledger/protocol-rfcs/pull/18#discussion_r468432794). -::: - -| Property | Required | Type | Description | -| -------------- | -------- | ------------------ | ------------------------------ | -| amount | ✔ | number | Transfer amount. | -| address | ✔ | string | Transfer address. | -| indexation_key | ✘ | Indexation Payload | (Optional) Indexation payload. | - -#### Value - -| Property | Required | Type | Description | -| ----------------------------- | -------- | -------- | -------------------------------- | -| with_denomination():string | ✔ | function | Transaction amount with unit. | -| without_denomination():number | ✔ | function | Transaction amount without unit. | - -#### Input - -| Property | Required | Type | Description | -| ------------ | -------- | ------ | -------------------------------------------------- | -| type | ✔ | number | Input type. Defaults to `0`. | -| id | ✔ | string | BLAKE2b-256 hash of the transaction. | -| output_index | ✔ | number | Index of the output on the referenced transaction. | - -#### OutputAddress - -| Property | Required | Type | Description | -| -------- | -------- | ------ | ------------------------------------------------------------ | -| type | ✔ | number | Set to value `0` to denote an Ed25519 address. | -| address | ✔ | string | If type is set to `0`, it should contain an Ed25519 address. | - -#### Output - -| Property | Required | Type | Description | -| -------- | -------- | ------------- | ----------------------------- | -| type | ✔ | number | Output type. Defaults to `0`. | -| address | ✔ | OutputAddress | Output address. | -| amount | ✔ | number | Amount of tokens to deposit. | - -#### UnsignedDataPayload - -| Property | Required | Type | Description | -| -------- | -------- | ------ | --------------------------------------------- | -| type | ✔ | number | Set to `2` to denote a unsigned data payload. | -| data | ✔ | string | Data of unsigned payload. | - -#### SignedDataPayload - -| Property | Required | Type | Description | -| ---------- | -------- | ------ | ------------------------------------------------ | -| type | ✔ | number | Set to `3` to denote a signed data payload. | -| data | ✔ | string | Data of signed data payload. | -| public_key | ✔ | string | Ed25519 public key used to verify the signature. | -| signature | ✔ | string | Signature of signing data. | - -#### IndexationPayload - -| _Property_ | _Required_ | _Type_ | _Description_ | -| ---------- | ---------- | ------ | ---------------- | -| index | ✔ | string | Indexation key. | -| data | ✔ | string | Indexation data. | - -#### UnsignedTransaction - -| Property | Required | Type | Description | -| -------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| type | ✔ | number | Transaction type. Defaults to 0. | -| inputs_count | ✔ | number | Amount of inputs proceeding. | -| inputs | ✔ | Input[] | Transaction inputs. | -| outputs_count | ✔ | number | Amount of outputs proceeding. | -| outputs | ✔ | Output[] | Output address. | -| payload_length | ✔ | number | Length of optional payload. | -| payload | ✔ | [UnsignedDataPayload](#unsigneddatapayload) \| [SignedDataPayload](#signeddatapayload) \| [IndexationPayload](#indexationpayload) | Payload containing data. As multiple payloads are not yet supported, only [unsigned data payload](#unsigneddatapayload) should be used. | - -#### Ed25519Signature - -| _Property_ | _Required_ | _Type_ | _Description_ | -| ---------- | ---------- | ------ | ------------------------------------------------------------------------ | -| type | ✔ | number | Set to value `1` to denote an Ed25519 signature. | -| public_key | ✔ | number | Public key of the Ed25519 keypair which is used to verify the signature. | -| signature | ✔ | string | Signature signing the serialized unsigned transaction. | - -#### SignatureUnblockBlock - -| _Property_ | _Required_ | _Type_ | _Description_ | -| ---------- | ---------- | ---------------- | ----------------------------------------------------------- | -| type | ✔ | number | Set to value `0` to denote a signature unlock block. | -| signature | ✔ | Ed25519Signature | An unlock block containing signature(s) unlocking input(s). | - -#### ReferenceUnblockBlock - -| _Property_ | _Required_ | _Type_ | _Description_ | -| ---------- | ---------- | ------ | ---------------------------------------------------- | -| type | ✔ | number | Set to value `1` to denote a reference unlock block. | -| reference | ✔ | number | Index of a previous unlock block. | - -#### SignedTransactionPayload - -| _Property_ | _Required_ | _Type_ | _Description_ | -| -------------------- | ---------- | --------------------- | ------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------- | -| type | ✔ | number | Payload type. Defaults to `0`. | -| transaction | ✔ | UnsignedTransaction | Essence data making up a transaction by defining its inputs and outputs and an optional payload. | -| unblock_blocks_count | ✔ | number | Number of inputs specifed. | -| unblock_blocks | ✔ | SignatureUnblockBlock | ReferenceUnblockBlock | Holds the unlock blocks unlocking inputs within an Unsigned Transaction | - -#### Message - -| Property | Required | Type | Description | -| ------------------------------------------- | ---------------------------------------------------------------------- | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| version | ✔ | number | Message version. Defaults to `1`. | -| parents | ✔ | string[] | Message ids this message references. | -| payload_length | ✔ | number | Length of the payload. | -| payload | ✔ | [SignedTransactionPayload](#signedtransactionpayload) | -| [UnsignedDataPayload](#unsigneddatapayload) | -| [SignedDataPayload](#signeddatapayload) | Transaction amount (exposed as a custom type with additional methods). | -| timestamp | ✔ | Timestamp | Transaction timestamp (exposed as a custom type with additional methods). | -| nonce | ✔ | string | Transaction nonce. | -| confirmed | ✔ | boolean | Determines if the transaction is confirmed. | -| broadcasted | ✔ | boolean | Determines if the transaction was broadcasted to the network. This will be true if the transaction was fetched from the network or if the transaction was successfully broadcasted from the client itself. This property may only be required for clients with persistent storage. | -| incoming | ✔ | boolean | Determines if the message is an incoming transaction or not. | -| value | ✔ | number | Message transfer value. | - -#### StorageAdapter - -| Property | Required | Type | Description | -| -------------------------------------- | -------- | -------- | -------------------------------------------------------- | -| get(key: string):Account | ✔ | function | Gets the account object for provided account name or ID. | -| getAll(): Account[] | ✔ | function | Gets all account objects from storage. | -| set(key: string, payload: string):void | ✔ | function | Stores account in storage. | -| remove(key: string): void | ✔ | function | Removes account from storage. | - -## Storage - -:::warning -Using Stronghold for storage is currently under research/development. -::: - -You should consider multiple storage options should for managing data that requires persistence: - -- You can use a simple key-value [storage](https://capacitor.ionicframework.com/docs/apis/storage/) could be leveraged for wallet basic metadata, such as user settings or theming options. -- For transactions and address data management you could use a relational database such as [SQLite](https://github.com/jepiqueau/capacitor-sqlite). - -What follows is an Entity Relationship Diagram (ERD) that shows the logical representation of the data. An _account_ is the basic entity in this database design. It has a one-to-many relationship with _addresses_. This means an account could have multiple addresses , but an address can only belong to a single account. An account has a many-to-many relationship with _transactions_ . Therefore, an account could have multiple transactions, but it is possible that a transaction belongs to multiple accounts. To accommodate this behaviour, an additional table that stores account IDs against transaction IDs (hashes) was added. - -A _storage adapter_ is required by the Rust layer to handle all the storage operations (read/write) from that layer. A generic storage adapter is defined in the [storage adapter section](#storage-adapter). - -![Storage - Entity Relationship Diagram](/img/specs/erdIOTA.svg) - -## Storage Adapter - -The package should have a default opinionated storage mechanism but should also provide the ability for users to override the storage by specifying an adapter. As a default option, a relational database such as [SQLite](https://www.sqlite.org/index.html) can be used. - -See [storage adapter](#storageadapter) for adapter interface. - -## Account - -### API - -#### Initialisation - -Initializes account -There are several scenarios in which an account can be initialized: - -- _Seed generated outside the Stronghold_: In this case, the _account_ should be initialized with a seed. It should communicate with the Stronghold using the `import_accounts` method and should expect an ID as a response. -- _Seed generated inside the Stronghold_: In this case, the _account_ should be initialized without a seed. It should communicate with the Stronghold using its `create_account` method and should expect an “id” in response; -- _Importing accounts from Stronghold backup_: In this case, the _account_ should receive all the initialization properties from the `Stronghold`. Please note that during backup, these configuration settings should be passed to the `Stronghold`. See [import_accounts()](#import_accounts). - -The following should be considered when initializing an account: - -- An _account_ should never be initialized directly. The only way an _account_ can be initialized is through the [add_account()](#add_account) method. -- An _account_ should always be initialized after a successful response from the `Stronghold`. If the `Stronghold` fails to create an _account_ , the _account_ initialization should error out. If the `Stronghold` successfully creates an _account_ , the _account_ should be stored in the persistent storage. Upon a successful store operation, the user should be returned an _account_ object. -- If a _provider_ property is not passed, a random node should be selected from the _nodes_ property. -- If a _type_ property is not passed, _default_ should be used as an account type. -- _quorum_size_ and _quorum_threshold_ should be validated. For example, _quorum_size_ should not be greater than the number of nodes provided by the user. -- The _nodes_ property should validate and remove duplicate node URLs. -- All the properties of the returned account object should be read-only. It should not be possible to manipulate them directly. - -##### Parameters - -| _Name_ | _Required_ | _Type_ | _Description_ | -| ------ | ---------- | ------------- | ------------------------------------------------------ | -| config | ✔ | AccountConfig | Initialization method receives a configuration object. | - -##### Returns - -| _Name_ | _Type_ | _Description_ | -| ------- | ------- | ----------------- | -| account | Account | Account instance. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------- | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | None | - -#### check_for_new_used_addresses() - -Sync addresses with the Tangle. The method ensures that the wallet's local state contains all used addresses and an unused address. - -The following should be considered when implementing this method: - -- The updated address history should not be written down in the database/persistent storage. Instead, the method should only return the updated address history (with transaction hashes). This ensures that there are no partial writes to the database. -- To sync addresses for an account from scratch, _gap_limit = 10_ should be sent as arguments. - -- To sync addresses from the latest address, _gap_limit = 1_ should be sent as arguments. - -##### Parameters - -| _Name_ | _Required_ | _Type_ | _Description_ | -| --------- | ---------- | ------ | --------------------------------------------- | -| gap_limit | ✔ | number | Number of address indexes that are generated. | - -##### Returns - -| _Name_ | _Type_ | _Description_ | -| --------- | --------- | -------------------------------------------- | -| addresses | Address[] | Address history up to latest unused address. | -| ids | string[] | Message IDs associated with the addresses. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Access modifiers | Private | -| Errors | List of error messages [TBD] | -| Required client library methods | [get_address_balances()](https://github.com/iotaledger/iota.rs/blob/dev/specs/iota-rs-ENGINEERING-SPEC-0000.md#get_address_balances)\| [find_messages()](https://github.com/iotaledger/iota.rs/blob/dev/specs/iota-rs-ENGINEERING-SPEC-0000.md#find_messages) \| [find_outputs()](https://github.com/iotaledger/iota.rs/blob/dev/specs/iota-rs-ENGINEERING-SPEC-0000.md#find_outputs) | - -#### sync_addresses_and_messages() - -Sync messages with the Tangle. The method should ensure that the wallet's local state has all messages associated with the address history. - -The following should be considered when implementing this method: - -- The updated message history should not be written down in the database/persistent storage. Instead, the method should only return the updated message history (with message IDs). -- This method should check if there are any local messages (with “broadcasted: false”) matching the messages fetched from the network. If there are such messages, their “broadcasted” property should be set to true. -- For newly-confirmed messages, the method should ensure that it updates the “confirmed” property of all its reattachments. - -##### Parameters - -| _Name_ | _Required_ | _Type_ | _Description_ | -| ------ | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------- | -| ids | ✔ | string[] | Message IDs. New message IDs should be calculated by running a difference of local message IDs with latest message IDs on the Tangle. | - -##### Returns - -| _Name_ | _Type_ | _Description_ | -| -------- | --------------------- | --------------- | -| messages | [Message](#message)[] | Message history | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| Access modifiers | Private | -| Errors | List of error messages [TBD] | -| Required client library methods | [find_messages()](https://github.com/iotaledger/iota.rs/blob/dev/specs/iota-rs-ENGINEERING-SPEC-0000.md#find_messages) | - -##### Required client library methods - -- - -#### select_inputs() - -Select inputs for funds transfer. - -:::info -This method should only be used internally by [send()](#send). The input selection method should also ensure that the recipient address doesn't match the remainder address. -::: - -See [Input Selection Process](#input-selection) for implementation details. - -##### Parameters - -| _Name_ | _Required_ | _Type_ | _Description_ | -| --------- | ---------- | ------ | --------------------------- | -| threshold | ✔ | number | Amount user wants to spend. | -| address | ✔ | string | Recipient address. | - -##### Returns - -| _Name_ | _Type_ | _Description_ | -| --------- | --------- | -------------------------------------------------------------------------- | -| inputs | Address[] | Selected Inputs | -| remainder | Address | Remainder address object. Empty or null if there's no need for a remainder | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------- | -| Access modifiers | Private | -| Errors | List of error messages [TBD] | -| Required client library methods | None | - -#### send() - -Sends a message to the Tangle. - -:::info -This method should only be used after a successful response from [sync()](#sync). -::: - -Currently, it is not possible to send multiple payloads. - -If you want to send a value transaction, please follow this process: - -1. Ensure _amount_ is not set to zero. -2. Ensure _amount_ does not exceed the total balance. -3. Ensure recipient address has correct checksum. -4. Validate _data_ property semantics and size. -5. Select inputs by using [select_inputs()](#select_inputs). -6. Pass the serialized [unsigned transaction](#unsignedtransaction) to the `Stronghold` for signing with its “signTransaction” method. -7. Perform proof-of-work. The _pow_ property in the account object should determine if the proof of work should be offloaded. -8. Once proof-of-work is successfully performed, the message should be validated and stored in the persistent storage. -9. After persisting the transaction, the transaction should be broadcast to the network. -10. In the event of a broadcast error, there should be three attempts for automatic rebroadcasting. If all attempts fail, the send process should terminate, and it should be left to the user to retry the failed message. For failed messages, the “broadcasted” property in the transaction objects should be set to false. - -##### Parameters - -| _Name_ | _Required_ | _Type_ | _Description_ | -| -------- | ---------- | -------- | ---------------- | -| transfer | ✔ | Transfer | Transfer object. | - -##### Returns - -| _Name_ | _Type_ | _Description_ | -| ------- | ------------------- | ------------------- | -| message | [Message](#message) | Newly made message. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| Access modifiers | Private | -| Errors | List of error messages [TBD] | -| Required client library methods | [find_messages()](https://github.com/iotaledger/iota.rs/blob/dev/specs/iota-rs-ENGINEERING-SPEC-0000.md#find_messages) \| [send()](https://github.com/iotaledger/iota.rs/blob/dev/specs/iota-rs-ENGINEERING-SPEC-0000.md#send) | - -#### retry() - -Rebroadcasts failed message. - -:::info -This method should only be used after a successful response from [sync()](#sync). -::: - -If you want to retry broadcasting a failed message, you can use the following process: - -1. Get the message by using [get_message()](#get_message). -2. Rebroadcast the message. -3. Update the account in persistent storage. - -##### Parameters - -| _Name_ | _Required_ | _Type_ | _Description_ | -| ------ | ---------- | ------ | ------------- | -| id | ✔ | string | Message ID | - -##### Returns - -| _Name_ | _Type_ | _Description_ | -| ------- | ------- | ------------------- | -| message | Message | Newly made message. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| Access modifiers | Private | -| Errors | List of error messages [TBD] | -| Required client library methods | [post_message()](https://github.com/iotaledger/iota.rs/blob/dev/specs/iota-rs-ENGINEERING-SPEC-0000.md#post_message) | - -#### sync() - -Syncs an account with the Tangle. The account syncing process should ensure that the latest metadata (balance, messages) associated with an account is retrieved from the Tangle and stored locally. -Please note that it is a proposed design decision to enforce account syncing before every send. An alternative way would be to have the _send_ method always exposed and internally ensuring that the account is synced before every message. - -If you want to sync an account, you can use the following process: - -1. Sync addresses using [check_for_new_used_addresses()](#check_for_new_used_addresses). -2. Sync messages using [sync_addresses_and_messages()](#sync_messages). -3. Store updated addresses and messages information in persistent storage (if not explicitly set otherwise by the user). - -##### Parameters - -| _Name_ | _Required_ | _Type_ | _Description_ | -| ---------------- | ---------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| index | ✘ | number | Address index. By default the number of addresses stored for this account should be used as an index. | -| gap_limit | ✘ | number | Number of address indexes that are generated. | -| skip_persistence | ✘ | boolean | Skips write to the database. This will be useful if a user wants to scan the Tangle for further addresses to find balance. You can find more details in the [snapshot transition feature](https://legacy.docs.iota.org/docs/wallets/0.1/trinity/how-to-guides/perform-a-snapshot-transition) provided by Trinity. | - -##### Returns - -| _Name_ | _Type_ | _Description_ | -| ------- | ------------------------------------- | ---------------------- | -| account | [SyncedAccount](#syncedaccountobject) | Synced account object. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | [find_messages()](https://github.com/iotaledger/iota.rs/blob/dev/specs/iota-rs-ENGINEERING-SPEC-0000.md#find_messages) \| [get_address_balances()](https://github.com/iotaledger/iota.rs/blob/dev/specs/iota-rs-ENGINEERING-SPEC-0000.md#get_address_balances) | - -#### reattach() - -Reattaches unconfirmed message to the Tangle. -The following should be considered when implementing this method: - -- Only an unconfirmed message can be reattached. The method should validate the confirmation state of the provided transaction. If a confirmed message ID is provided, the method should throw an error. -- The method should also validate if a reattachment is necessary, by checking if the message falls below max depth. The criteria for whether the message has fallen below max depth is determined through its timestamp. If 11 minutes have passed since the timestamp of the most recent reattachment, the message can be reattached. See [this implementation](https://github.com/iotaledger/trinity-wallet/blob/3fab4f671c97e805a2b0ade99b4abb8b508c2842/src/shared/libs/iota/transfers.js#L141) for reference. -- Once reattached, the message should be stored in the persistent storage. -- If the message was reattached via polling, a [reattachment](#monitor-for-reattachments) event should be emitted to notify all subscribers. - -##### Parameters - -| _Name_ | _Required_ | _Type_ | _Description_ | -| ------ | ---------- | ------ | ------------- | -| id | ✔ | string | Message ID. | - -##### Returns - -| _Name_ | _Type_ | _Description_ | -| ------- | ------- | ------------------------- | -| message | Message | Newly reattached message. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ------------------------------------------------------------------------------------------------------------ | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | [reattach()](https://github.com/iotaledger/iota.rs/blob/dev/specs/iota-rs-ENGINEERING-SPEC-0000.md#reattach) | - -#### total_balance() - -Gets total account balance. - -The total balance should be read directly from local storage. To read the latest account balance from the network, [sync()](#sync) should be used first. - -##### Returns - -| _Type_ | _Description_ | -| ------ | ---------------------- | -| Value | Account total balance. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------- | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | None | - -#### available_balance() - -Gets available account balance. The available account balance is the amount users are allowed to spend. It should subtract the pending balance from the total balance. - -For example, if a user with _50i_ total account balance has made a transaction spending _30i_, the available balance should be _20i_ (i.e. 50i - 30i). - -The available balance should be read directly from local storage. If you want to read the latest account balance from the network, you should use [sync()](#sync) first. - -##### Returns - -| _Type_ | _Description_ | -| ------ | ------------------------------- | -| Value | The accounts available balance. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------- | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | None | - -#### set_alias() - -Updates an account's alias/name. - -##### Parameters - -| _Name_ | _Required_ | _Type_ | _Description_ | -| ------ | ---------- | ------ | ----------------- | -| alias | ✔ | string | New account name. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------- | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | None | - -#### list_messages() - -Gets messages. Messages should be read directly from local storage. To ensure the local database is updated with the latest messages, you should use [sync()](#sync) first. - -##### Parameters - -| _Name_ | _Required_ | _Type_ | _Description_ | -| ------ | ---------- | ------ | ---------------------------------------------------------------------------------------------------------------------------- | -| count | ✔ | number | Number of (most recent) messages. | -| from | ✔ | number | Subset of messages. For example: count = 10, from = 5, it should return ten messages skipping the most recent five messages. | - -##### Returns - -| _Name_ | _Type_ | _Description_ | -| -------- | --------- | ------------- | -| messages | Message[] | All messages. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------- | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | None | - -#### list_received_messages() - -Gets all received messages. - -Messages should be read directly from local storage. To ensure the local database is updated with the latest messages, you should use [sync()](#sync) first. - -##### Parameters - -| _Name_ | _Required_ | _Type_ | _Description_ | -| ------ | ---------- | ------ | ---------------------------------------- | -| count | ✔ | number | Number of most recent received messages. | -| from | ✔ | number | Subset of received messages. | - -##### Returns - -| _Name_ | _Type_ | _Description_ | -| -------- | --------- | ---------------------- | -| messages | Message[] | All received messages. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------- | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | None | - -#### list_sent_messages() - -Gets all sent messages. - -Messages should be read directly from local storage. To ensure the local database is updated with the latest messages, you should use [sync()](#sync) first. - -##### Parameters - -| _Name_ | _Required_ | _Type_ | _Description_ | -| ------ | ---------- | ------ | -------------------------------------- | -| count | ✔ | number | Number of (most recent) sent messages. | -| from | ✔ | number | Subset of sent messages. | - -##### Returns - -| _Name_ | _Type_ | _Description_ | -| -------- | --------- | ------------------ | -| messages | Message[] | All sent messages. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------- | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | None | - -#### list_failed_messages() - -Gets all failed (broadcasted = false) messages. Messages should be read directly from local storage. - -##### Parameters - -| _Name_ | _Required_ | _Type_ | _Description_ | -| ------ | ---------- | ------ | ---------------------------------------- | -| count | ✔ | number | Number of (most recent) failed messages. | -| from | ✔ | number | Subset of failed messages. | - -##### Returns - -| _Name_ | _Type_ | _Description_ | -| -------- | --------- | -------------------- | -| messages | Message[] | All failed messages. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------- | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | None | - -#### list_unconfirmed_messages() - -Gets all unconfirmed (confirmed = false) messages. Messages should be read directly from local storage. - -##### Returns - -| _Name_ | _Required_ | _Type_ | _Description_ | -| ------ | ---------- | ------ | --------------------------------------------- | -| count | ✔ | number | Number of (most recent) unconfirmed messages. | -| from | ✔ | number | Subset of unconfirmed messages. | - -##### Returns - -| _Name_ | _Type_ | _Description_ | -| -------- | --------- | ------------------------- | -| messages | Message[] | All unconfirmed messages. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------- | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | None | - -#### get_message() - -Gets message for provided ID. - -Messages should be read directly from local storage. To ensure the local database is updated with the latest messages, you should use [sync()](#sync) first. - -##### Parameters - -| _Name_ | _Required_ | _Type_ | _Description_ | -| ------ | ---------- | ------ | ------------- | -| id | ✔ | string | Message ID. | - -##### Returns - -| _Name_ | _Type_ | _Description_ | -| ------- | ------- | --------------- | -| message | Message | Message object. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------- | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | None | - -#### list_addresses() - -Gets all addresses. - -##### Returns - -| _Name_ | _Type_ | _Description_ | -| --------- | --------------------- | -------------- | -| addresses | [Address](#address)[] | All addresses. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------- | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | None | - -#### list_unspent_addresses() - -Gets all unspent input addresses - -##### Returns - -| Name | _Type_ | _Description_ | -| --------- | --------------------- | ---------------------------- | -| addresses | [Address](#address)[] | All unspent input addresses. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------- | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | None | - -#### generate_address() - -Gets the latest unused address. - -##### Returns - -| _Name_ | _Type_ | _Description_ | -| ------- | ------- | --------------------- | -| address | Address | A new address object. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------- | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | None | - -## Account Manager - -An account manager class should be publicly available for users. With the account manager, the user can create, update, delete or manage multiple accounts. The implementation details of a specific account should be abstracted using this account manager wrapper. - -### API - -#### Initialisation - -Initializes the account manager. Account manager initialization should validate the adapter object semantics and return an _AccountManager_ instance. - -##### Parameters - -| _Name_ | _Required_ | _Type_ | _Description_ | -| ------- | ---------- | -------------------------- | ----------------------------------------------------------- | -| adapter | ✘ | [Adapter](#storageadapter) | Initialisation method receives an optional storage adapter. | - -##### Returns - -| _Name_ | _Type_ | _Description_ | -| ------- | --------------------------------------- | ------------------------- | -| manager | [AccountManager](#accountmanagerobject) | Account manager instance. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------- | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | None | - -#### add_account() - -Adds new account - -See account [initialisation](#initialisation) for detailed implementation guidelines. - -##### Parameters - -| _Name_ | _Required_ | _Type_ | _Description_ | -| ------ | ---------- | -------------------------------------- | ----------------------------- | -| config | ✔ | [AccountConfig](#accountconfiguration) | Account configuration object. | - -##### Returns - -| _Name_ | _Type_ | _Description_ | -| -------- | ------------------- | ---------------------- | -| accounts | [Account](#account) | Newly created account. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------- | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | None | - -#### remove_account() - -Removes an account. - -The following should be considered when removing an account: - -- An account should first be removed from the `Stronghold` using its _removeAccount_ method. -- Once the account references have been removed from the `Stronghold`, the account should be deleted from the persistent storage. - -##### Parameters - -| _Name_ | _Required_ | _Type_ | _Description_ | -| ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -| identifier | ✔ | { address: <string> } \| { alias: <string> } \| { ID: <number> } \| { index: <number } | Identifier. Could be one of address, alias, ID or index. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------- | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | None | - -#### sync_accounts() - -Syncs all stored accounts with the Tangle. Syncing should get the latest balance for all accounts and should find any new messages associated with the stored account. - -See [Accounts Syncing Process](#account-syncing-process) for further details. - -##### Returns - -| _Name_ | _Type_ | _Description_ | -| ------- | --------------------------------------- | ---------------- | -| account | [SyncedAccount](#syncedaccountobject)[] | Synced accounts. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------- | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | [sync()](#sync) | - -#### move() - -Moves funds from one account to another. This method should use the [send()](#send) method from the sender account and initiate a message to the receiver account. - -##### Parameters - -| _Name_ | _Required_ | _Type_ | _Description_ | -| ------ | ---------- | ----------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -| from | ✔ | { address: <string> } \| { alias: <string> } \| { ID: <number>\| { index: <number> } | Identifier. Could be one of address, alias, ID or index. | -| to | ✔ | { address: <string> } \| { alias: <string> } \| { ID: <number> } \| { index: <number> } | Identifier. Could be one of address, alias, ID or index. | -| amount | ✔ | number | Transaction amount. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------- | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | None | - -#### backup() - -Safely creates a backup of the accounts to a destination. The file could simply be JSON containing the address & transaction histories for accounts. - -This method should provide the `Stronghold` instance with the metadata of all accounts. - -##### Parameters - -| _Name_ | _Required_ | _Type_ | _Description_ | -| ----------- | ---------- | ------ | --------------------------------------- | -| destination | ✔ | string | Path where the backup should be stored. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------- | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | None | - -#### import_accounts - -Import (backed up) accounts. - -**The implementation details are not finalized.** - -##### Parameters - -| _Name_ | _Required_ | _Type_ | _Description_ | -| -------- | ---------- | --------------------- | --------------- | -| accounts | ✔ | [Account](#account)[] | Account object. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------- | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | None | - -#### get_account() - -Returns the account associated with the provided identifier. - -##### Parameters - -| _Name_ | _Required_ | _Type_ | _Description_ | -| ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -| identifier | ✔ | { address: <string> } \| { alias: <string> } \| { ID: <number> } \| { index: <number> } | Identifier. Could be one of address, alias, ID or index. | - -##### Returns - -| _Name_ | _Type_ | _Description_ | -| ------- | ------------------- | ----------------------------------- | -| account | [Account](#account) | Account associated with identifier. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------- | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | None | - -#### reattach() - -Reattaches an unconfirmed message. - -See [reattach()](#reattach) method for implementation details. This method is a wrapper method provided for convenience. A user could directly access the [reattach()](#reattach) method on an account object. - -##### Parameters - -| _Name_ | _Required_ | _Type_ | _Description_ | -| ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -| identifier | ✔ | { address: <string> } \| { alias: <string> } \| { ID: <number> } \| { index: <number } | Identifier. Could be one of address, alias, ID or index. | -| id | ✔ | string | Message ID. | - -##### Returns - -| _Name_ | _Type_ | _Description_ | -| ------- | ------------------- | ------------------------- | -| message | [Message](#message) | Newly reattached message. | - -##### Additional Information - -| _Name_ | _Description_ | -| ------------------------------- | ---------------------------- | -| Access modifiers | Public | -| Errors | List of error messages [TBD] | -| Required client library methods | None | - -## Events - -Events can have two categories: - -1. Reactive messages emitted from the node software whenever the state on the node changes. For example, emitting new messages received by the node. Clients (Wallet) can subscribe to these events to get notified if any relevant change occurs on the node. For further details, please visit the [Firefly GitHub repository](https://github.com/iotaledger/wallet-spec/tree/events). -2. Messages emitted from the wallet library whenever there are any important state changes. Please note that in cases where a user triggered action leads to a state change, the messages will not be emitted. For example, if a user explicitly triggers a [sync()](#sync) action leading to a state change, an explicit event is not necessary. - -### Category 1 events - -On every update sent from the node software via an event, the wallet library should update internal (persistent) storage and should also emit events via [category 2 events](#category-2-events). - -#### Monitor address for balance changes - -| _Event_ | _Returned Data_ | -| ----------------------- | ------------------------------------------------------- | -| < Address : Balance> | Index 1: Address \| Index 2: New balance on the address | - -#### Monitor address for new messages - -| _Event_ | _Returned Data_ | -| ---------------------- | -------------------------------------------------- | -| <Address : Message> | Index 1: Address \| Index 2: Id of the new message | - -#### Monitor message for confirmation state - -| _Event_ | _Returned Data_ | -| -------------- | ------------------- | --------------------------- | -| <MessageId> | Index 1: Message Id | Index 2: Confirmation state | - -### Category 2 events - -They could be triggered via events from [category 1](#category-1-events) or through [polling](#polling). - -#### Monitor for balance changes - -| _Event_ | _Returned Data_ | -| -------- | --------------------------------- | -| balances | [{ accountId, address, balance }] | - -#### Monitor for new messages - -| _Event_ | _Returned Data_ | -| -------- | ------------------------- | -| messages | [{ accountId, messages }] | - -#### Monitor for confirmation state - -| _Event_ | _Returned Data_ | -| ------------- | ------------------------- | -| confirmations | [{ accountId, messages }] | - -#### Monitor for reattachments - -| _Event_ | _Returned Data_ | -| ------------- | ------------------------- | -| reattachments | [{ accountId, messages }] | - -#### Monitor for broadcasts - -| _Event_ | _Returned Data_ | -| ---------- | ------------------------- | -| broadcasts | [{ accountId, messages }] | - -#### Monitor for errors - -| _Event_ | _Returned Data_ | -| ------- | --------------- | -| error | { type, error } | - -## Privacy - -To maintain the financial privacy of wallet users, you should enforce strategies in the application/wallet that will guarantee a certain level of anonymity: - -- The wallet should only use a single address per message. If an address has already been used in a message, it should not be used as a deposit address. Instead, a new address should be generated.- The input selection strategy should expose as little information as possible. Please see the [input selection process](#input-selection) for further details. - -Some other privacy enhancing techniques can be found [in this document](https://docs.google.com/document/d/1frk4r1Eq4hnGGOiKWkDiGTK5QQxKbfrvl7Iol7OZ-dc/edit#). - -## Input Selection - -The goal of input selection is to avoid remainder addresses. The remainder output leaves a clue to the user's future spends. There should be a standardized input selection strategy used by the wallet. - -The steps for input selection are as follows: - -1. Try to select an input with an exact match. For example, if a user intends to spend _X_ iotas, the wallet should try to find an address that has _X_ iotas as available balance. -2. If the previous step fails, try to select a combination of inputs that satisfy the amount leaving no change. For example, consider a scenario where the wallet with account name _Foo_ has three addresses _A_, _B_ and _C_ with _10_, _20_ and _50_ IOTA respectively. If a user intends to spend _X = 30_ IOTA, the application should search for an exact match (step no. 1). In this case, no address balance matches _X_. Therefore, the wallet should search for a subset of addresses with an accumulated balance of _X_. In this scenario, _A_ and _B_. -3. If both the previous steps fail, the wallet should select a combination of inputs that produce the minimum remainder. - -A reference implementation of different input selection algorithms for Bitcoin can be found [in this project](https://github.com/bitcoinjs/coinselect). - -The implementation of step no. 2 is also quite similar to the [subset sum problem](https://en.wikipedia.org/wiki/Subset_sum_problem). Given a _total_ and a set of non-negative numbers (_inputs_), we need to determine if there is a subset which adds up to the _total_. - -## Account Syncing Process - -The account syncing process should detect all used accounts on a seed with their corresponding address and message history. Once, all accounts and histories are detected, the wallet should accumulate the total balance. The syncing process should work as follows: - -1. Start with the account at index 0, generate [gap limit](https://blog.blockonomics.co/bitcoin-what-is-this-gap-limit-4f098e52d7e1) number of addresses. This defaults to 20. -2. Check for messages and balances on the generated addresses. -3. If there are no messages and balances of 0 on all addresses, the process for generating addresses and finding messages and balances should be stopped. -4. If any address has balance or associated messages, generate gap limit number of addresses from the index of the last address with messages or balance. -5. Steps (1-4) should also be performed for the account at index 1. The general idea is that _n + 1_ accounts should be checked if account _n_ has any messages or balance. - -Treat accounts like addresses. Only allow 1 latest unused account. - -_Scenario 1_: The wallet message and address history stored in Stronghold backup - -1. Start syncing from the latest address index stored in the Stronghold backup -2. Run the “Full sync” function to resync from index 0 across all accounts -3. Run the “Find more history” function to sync a further 50 addresses - -_Scenario 2_: User has no backup file - -1. Start syncing from account 0 address 0 - -## Polling - -A background process that automatically performs several tasks periodically should be part of the wallet library. The goal of the background process is to perform the following tasks: - -- _Sync accounts_: The background process should sync all accounts with the network. This should be done using the [`sync_accounts()`](#sync_accounts) method. - - If new messages are detected, a [messages](#monitor-for-new-messages) event should be used to notify all subscribers. - - If new balances are detected, a [balances](#monitor-for-balance-changes) event should be used to notify all subscribers. - - If new confirmations are detected, a [confirmations](#monitor-for-confirmation-state) event should be used to notify all subscribers. - :::info - If there are multiple failed messages, priority should be given to the old ones. - ::: -- _Reattach_: The background process should check if there are any unconfirmed messages that require reattachment. The detailed implementation flow for reattachment can be found in the [reattach section](#reattach). - -The following should be considered for implementation: - -- Invoking a task explicitly that is already being performed through polling should lead to an error. For example, if the polling process is already syncing accounts, and a user explicitly calls [sync()](#sync), it should throw an error. -- Errors during the polling process should be communicated to subscribers via error events. - -The background process should have a recurring checker that sequentially performs all the above tasks. The implementation should ensure that future tasks can easily be added to the background process. For reference, see [Trinity's implementation](https://github.com/iotaledger/trinity-wallet/blob/develop/src/mobile/src/ui/components/Poll.js) of the poll component. diff --git a/docs/build/wallet.rs/0.1/docs/troubleshooting.md b/docs/build/wallet.rs/0.1/docs/troubleshooting.md deleted file mode 100644 index af9f00d3f8d..00000000000 --- a/docs/build/wallet.rs/0.1/docs/troubleshooting.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -description: Troubleshooting the IOTA Wallet Library. -image: /img/logo/logo.svg -keywords: - - discussion - - channel - - problem - - solution - - discord - - stackexchange - - reference ---- - -# Troubleshooting - -## StackExchange - -If you have a problem you cannot solve, check out the [IOTA StackExchange](https://iota.stackexchange.com/) to see if you can find a solution. - -## Joining the Discussion - -If you want to get involved in discussions about this library, are looking for support, or have a question for us, feel free to join us in the [#wallet-discussion channel](https://discord.com/channels/397872799483428865/933883981311643698). diff --git a/docs/build/wallet.rs/0.1/docs/tutorials/.keep b/docs/build/wallet.rs/0.1/docs/tutorials/.keep deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/build/wallet.rs/0.1/docs/welcome.md b/docs/build/wallet.rs/0.1/docs/welcome.md deleted file mode 100644 index 5339329f596..00000000000 --- a/docs/build/wallet.rs/0.1/docs/welcome.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -description: The official IOTA Wallet Library Software can be used to integrate an IOTA Wallet into your application. -image: /img/logo/logo.svg -keywords: - - requirements - - wallet - - software - - library - - rust - - python - - nodejs - - java - - reference ---- - -# Welcome - -:::caution -This is documentation for wallet.rs, which is no longer actively maintained. -For up-to-date documentation, see the documentation for its successor the [IOTA SDK](/iota-sdk/welcome). -::: - -Welcome to the official IOTA Wallet Library Software documentation. You can use our documentation to help streamline integrating an IOTA Wallet into your applications. If you want to learn more about the IOTA client libraries, you can check out our [blog post](https://blog.iota.org/the-new-iota-client-libraries-harder-better-faster-stronger/) on how they work. - -## wallet.rs - -`wallet.rs` is a general wallet library written in Rust. It is currently utilized by our wallet software, [Firefly](https://firefly.iota.org/), and other software components across the IOTA ecosystem. - -`wallet.rs` contains all of the specs to safely build wallets or integrations that require value-based transfers, such as exchanges and pay-as-you-go systems. Additionally, amongst other features, `wallet.rs` includes account state management and backup, account creation, and transferring tokens. `wallets.rs` is also based on our official _one-source-code-of-truth_ [IOTA Rust library](https://github.com/iotaledger/iota.rs) and can be integrated with the [Stronghold enclave](https://blog.iota.org/iota-stronghold-6ce55d311d7c/) to achieve a maximum level of security. - -:::note - -You can use Stronghold to store account data of the `wallet.rs`. It integrates the best security practices and is open-source. - -::: - -### Stronghold and wallet.rs - -With the `wallet.rs` library, developers no longer need to use a self-generated seed anymore. By default, the security of `Stronghold` creates and stores the encrypted seed, at rest. Additionally, it is not possible to extract the seed from `Stronghold` as a security measure. - -`Stronghold` also uses encrypted snapshots that can easily be backed up and securely shared between devices. These snapshots are further secured with a password. - -## IOTA 1.5 (Chrysalis) in a Nutshell - -For some background, you can checkout our [Developer Guide to Chrysalis](/introduction/explanations/update/what_is_chrysalis/) which explains all of the main concepts behind the IOTA Chrysalis in detail. - -You can also read our [Chrysalis documentation](/introduction/welcome/) to learn the history of versions between IOTA 1.0 and Chrysalis. - -## Testnet - -To join the Chrysalis public devnet, check out our [blog post](https://blog.iota.org/chrysalis-phase-2-testnet-out-now/). You can also learn more about the different Chrysalis components in our [Chrysalis documentation portal](/introduction/welcome/). diff --git a/docs/build/wallet.rs/0.1/resources/charts.pptx b/docs/build/wallet.rs/0.1/resources/charts.pptx deleted file mode 100644 index 2af02e6d47532bcdee14a9b44ded4a27b8ecbc11..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 44420 zcmeFYW00&%x31ki+dbR1XWO=I+qP}nw%tA3_H5g>ZM#pe_3kgez0Y0|@A-Z9d4AMW z8TnL1Wmb+m?{VcQSqUIuBmhtVZ~y=Re1Ia|WXU=}0DxgA002Y)@E;liHr9?t){Z)g zZnj1aTGXyqmU#KVKS*-{etbXw|E~YRGccYqV%Mz#4n44mzm$$`DYlUp;jAS3K9<*B#qUva$)nPaCK~`(HrvcNP6W=;fhfe7xN5 zGD*ZYl?L?s{9@q4NR%fHQ&Z}lWuRwy>Z`s`S#vIltG3{D^6(?A35ZkU9L{r0_Pr4t2mEE@E!k-#W! z+{Sl6D=|Q)ic_*D$4xSe#X$_`&i;NM5w%)7g3{rlKWY}fvmBD^ zjo>dh$0WW+U@U6h5v4o6Qv&DTdc*u9q#fLFs;`94yuOj(4e9!__(wGNDacut@fJfy zdED5M?jor%mEq=>5xKDw)}W&re{lr@y;e$WnH+y{1_C{k#IU0Vf3bRFq-@FRh+KAd zhwB}44Nu>BdS)pFMpO@L*9&Kcir`rQ81x7}1u&{#4K*A*I&1q^^=9mgn3%J$LMeyIK{prEFDjavm3u%Rn^E`3HXWO@z?2Ihk zsv&7DKf_G(rq4~I9atn4)o=jG=MsFy)nM0W942)VZ3r!sBxy22ozXuHLr%@bm0-g~ zRKgF)L{-mH2@T2exG^06^{~j~s4BX3z-!Y>E3;=)&01jwt>qzsjxUsc2 za`@gS^&HJ?tpD02|Gzi_{N5_RKkz^M>PVE6=%Ymn+5-6!Xt`pxS|F=)q#-!xgUjN< zYihQlmEyO~eB8ohrrJOo2-)3Z8{v9kg;1;NVxMR_7E>d{laSXn71tn}19#ov)Lj2j zfG72iyOk6 zZ%%Ma8Y00kOB7AsQtc?9k)gET{@1)PGf3P7%nd17E)V}o1{eo%ElRz%d?vP2eS(KW z{EoYH@bBI!5}S?VG^jEu^kIdV#M>p>Q66c%YWD8{9d9imqw_n*PH##VlcbR9@qqF^CD6zb4 zDou~5U!loS*q_Su9!@8ySS#kt*hv03e|z%zT65Vj(?Nw1W%)33X4ZfaaAD7Rda2Vi z`Vd=7g7$1ST_DHYE@(?dC2tSbR(Z(Or#!5vG&e5jSQYNlqAc%-Tzj`yVh*?vOmbrO zJ@}|QeJyLY&e&vEdYq1m^ERCIKvVlHqrR`d;;yKhFFHI0TktyNCcS%*QNc}AK&I7U zC>c?vrK*2<9#|gtw5*cU>mv51L$0682vR>GiJWL<%lNaub=vKqrLqYnZB23aw(9wE zhiG+YbSrrFQmFgMTZWUwWbMFei7{y+i_^ps&4Eev;=&`ztW|z$`RI{88%shaK$ZyC zhcBSlOC(-)Mlvr!cpCm?Zbl&Opp@?Rxun$rSG!Z7lvL4VgW4yyStV>DLkDz;ZyAYZ zb##^3N`K20>Dq754~#qvTP8@|M=!;72nuN0tN_3)Bf}8>!n$jB?2eMT11emx(Yn+8 zCgw3~pbP#`%h;v6{G>UG<1zI_x+ke#-NN5S?X{nN-k|VtEwECBrNx?2MvpsQX`-TA zWyQ`!$E+r?&9=T+WUb1AI|ecyann^rtDr92XkS(LYMFe%Ciq&o*s%B;MM-N5LS4j1 z&eqZfv{}_Ri3Ywafi`{ZP}^0B>9>1%fIIEwbh?!XhdamVrDA(!%YyyUH88Gr1yt703{429ld6)yJ)PSh0p9a!7w=}){qPuazk;v)Z7_PI(` z=HnC@hLX~G+nAmmuE2}ax-xsj)9L#r#mV+!tSXI%GoA)z%-~V?c_?FyfSc2lypg56 z5g4R&?bN!!X`~&-Xt)GA;n@SM7j1v^o*;;&H6F&IkXB8?#Q?wJW#sgPZRzREz-~ZO zW-B>%cHinh07n~ywA@QWt#0krPYssHyzUh+i$Y&7kd2dWYL|ug5B-FTVIjDrH@4$~ zkwU)ud0`>1v542Ke5&I7AHG3;%|n^K%kSewz&}TF2ynhG!iJU`f8I#?bHGm#y`vIk zm&|B13OMJxn~(r^GwA6UH6|<}k7p~W9FZ$DSBo??M_bzE4o3?}lY()I;G={N;Pd&3 zK+YXEw`dh zw$cLVTH5yd9C}_H>|EBlbmI| zflHzTQicP5;qD7%&;^$X#QB-uS>rEKMv}%+=P#qFuYL4Xxh+nPz9XXS%AgF8yC2)8 zkr;!U&nK0z(2!1xqT>V|&xUHGP)?o$@b+-BYxEMVK+Y80o!7K=YVKMg6rxFj|0V0f z0gU1wj8+u4m~DQMX@Ddwh6Pfy55AA%!ZA1>2)-lUCCoo0G}N4wu4&?=1(RVm;tc0} znS$L^z+WFjXOpd)0+A>{6107#o%q0widUMT`^mOP>$R z*Eu;q78C&le*e%8;VyReqY~Lul9Ml5l$&5BzqTDa+3IeP*O|pv5*BGVFQcCT9GF1R zwqKKlSC9NxKD-Pet?+C7)rVu;&&yU#Z@rl>cRT^fCMTsrfO4A5<21NV&5vc2CT-nk zlM8=yFNc1``ZD*=T#~mF?Gd^@9>r5tjWP>YOC0fJsT+KSl_8$uyev|Ky>d9V`F4JU z#cerXh+WDXc!@$@Z#=F2qH7SCKj4{{UOCsI=pv)80;8m(6Stwl1z>|DKKoZ zgV$~de|-FYWV?sb;pEHSf)8X%g5%@t>_{*_XlJVH5^$cbMM&U0p=qp*Cj3y4Ogn(+ z^%Y-sOfwP5H&ut${rNiB8m#^6@Rhs_W>qK)T2|AEmc`3~&I8VOEpFTq;JUO(8Q0`v zmYFh_G1$Rl1*y1!vYx;U(xl}A&oaFUaNF0cqAr!qX=OPc`na;Z*~|>w*dkpX^~fFX zFtMkV)@SMp@S0JU?B!6K9n*U(GK8CI7vdZIhYqH?*r!A;G8HWaC^2)pcJp>IEaP>FERCs z#1Hv*^B10qb|d48b*p%&h#j!Z2k3&=uM2|WE{KCjmwcUWD?1ma8$NNn(q_atT4)ed z>hQo6UTHplA}(~ob9{ zOTPWH({V!YHGlTZpl0NHkM~DXR z9B)46cXexv67A!T2^rMh-i4NJp}1sR*chqSOy&(8RMh3t-P6Rlj^WUqZKh|2Zmp(V z-Bn|lG?Wnp5^Hsja9Q`{pYsg?bt(_Hp0^o`th%+uyctNjw7GbpWj`dM`CNqIPYhj4`aanB|CC}=}jxItPG#}(>ffH^p^Swyb7JT~n&7}z-&`{u}VSOSQ%RPJ8U>4k6J9ef%3LpQjZIZHIY&aA!!8F9QcfQP291m70_X*H?XjeKP z>{WKIM+V>I)KUIw;%h`kP}LnJvYS*^#T#)c2*4wP5Xf303yd$oULrA3+GyZ0JQ%GH zyAzvxbG#U@YTaL5&PBumwsh8ZWf6uL0d^QTZznZF*>sA}kufG-D4Qc5pI&zrP#-%w>%2+^+Sc!UK>MrLY8T5t{H_dlxYEVZAYlCfM0&MU> zq#2=s7HNFxuNZse8FRL)6}5D*{jHw5lx3`QNA%Hnrm9U9Po24NW)Qx;okw zsVN8^=gqPB=)6pYdRdnfVju53^pV&4MU?4ozrwbqD)Bp}m zRmd+92`5SQn&A%VWwbvZ+&}!rBs7R#$gTSmJ29jMx1_#bwG`#ki6CuY>}k^^P6=XO;cMx^C!v}OKdeHf=4bC?(}(F1%>9CHN@3STZb5`Z0weD9BFB2MCr*d^nH z5*4nsxkM2+5I%pje!|+w{#)k$+55`dVY3@|!h?vg$=r^I>9Wg=emS_GSY*5(!{Z`& z3wSjdB;KM((Yv7_Xt=|8i!jAB1|&7?abLe7&9IOuW3DnQ^NNQvS`3L(Z@i6I&d>?Z<2y4CW}V(928FroKdhg zr-k(Q&s!CRlTdvPZmNeC5sIHm8mC4!Q_{UFRc17nQIjS~ZzkoZq2yL)lPOh(R=0Qk zn?)m#*JA_yZ>OSLw3_X$oipBy8`Ra|ivmqq)Yq9U=#JdKoNiydsn%{6=c*C}wlbTa ze4V{2>p(BcvhziS$rQ^DdDbzq5=2Pds%biaB9|m`QR}?mc`x8rLA;DFL33w-D!3=$o@j!>we~Np4Ob^yz^LQsy8Do^Yl4~neb+C2K$4m=K}Z1(|-vxKWXf=$cVGfcM$={Ms|pBFi>?6w6E6gTtZ)l04wz3;$OY9ba35R@Xk=sMN&?T!#rTp> zK8utn@6aw%vQJYVxKtMSnXaGLe6)bp7@uecQy~5)%*M_V_y~Ob5XP^Ii#RROU4^V> z@qH1xBfx7pya{;)1~@@^Agot)hkmC05bZB66e9RQQL+UqOzfONx(_@L;z-m9ha$_Rqdez(THJ%uKdGH`RpNMSUVpbOyL1EEPH~iLi zkb45rU9i}5|I2&46ALr}d{SOxHHcC}d|BBSJeUA*!XF>812#}%#OR72exrYV%dMK! zbr&Q5%WhvGnTH=J2#m_=A-sWpu%x}lZs`0VH8N?1l!dX_ZG)W0n52D06HBl5=W{H? zk}frMDmFQ<>68b?<+PfqXx+pd+NrM1KM`S_qhy@sRBeaZVDP5%thCk^(F5?n_ek%7 zbe>OysX^)JCas zWh0e5@#)=Ppz?&~ePs}8ka9YM1{}U83yR092!uff=sAH-dnPO1$NP#OMukBkh?_rS zh!Z?m-Z64ouGyBu%2xwcc!zQbtS8)pCOiYvCL2 z{_~;gxH$BpJ?;(nAK8R~CSgO*cMr?AFTwl1|0g!_FZA^{sQ8;u{0+S#r#j91XyL%F zxu#v2V!3CO!<=Ob+E*|7$@WoOn}BGkvivMJ(m1itirTw_h?-ua%QT22Hna8?yhjW4pLPW z)uoD%V-$K`UL~um5%Q);J;h@0fbGWPP6xC_n=MApOU0|G$&Y z^OP&=Ra&^7ZkbgM!B6%X-6L2C0!1UOVzI11@izc#eR0L1XiI^-xlOO5{zP7;GT2y| z<*vJrmlwfH_tJ zTy(q+yELmS{5MARH3HryL-jkN1Z>KMaep)A)Gki#auP|oST=gij_=E(K|4-k%`SGl zOEv19s<@R*41}p9p%buX28zMS_-3WABF5_OPnmrBROM825X!B$OPyah+!T_)NDsah zE8A$-hO|IP3Y=DgH0YXm`^23 z94J3Y9N3vl1c%M+l}8m<_qt%Qk#KIuKgQ0Kr-_nocjFoYDE)Sw;b z^+_%(_n)vS_}-o&eml=zL|iOMTIrA<_KH}!rC_A^5Md(#r3JeH10=kGL~^{rkbiZE z!A=tq@r8r&Vk3i*vH?QcrUy59paZCp!^o}zA&J-t27lp+6kTZYG^I`;EmoxjB{eH4 z1%JK|+uVXc_|LGy+{%ff%#ixUY?5|P1aS67U~+c7SiCu6t-w4VHIbvEu}K57zS1Jj zE9Dg?TR12UuR^1G6Y8Xy8!k+uraB_>Eg1+<4s9{Be|aLLf1h^!1HKQ3;~S>?PNL|T z|2pgbPf{kO=iq2${~xgRUyXkuSM?9;0#SsouR;&7{tq{ONgqCgsQS9v6>KsNOshIr z-#l!GKRtXL8RO=KZpj`IYeQ)yE2qItBOzQPn}SCp>ID!|PI8J%)!qxZ&lfH%73*y% zP6ls8*QI_@aN@W2Z>#dXBhdm!G}YeZ1AHs;apI z$=PcGW8BDUpy+99EZK3_9i&E37U?A=xx*_%cV> zHe&x6`q($1x1-CD86kPt%RaUzNIAwCq-jP7#+}7H>)KpZANQewv;&bL zG#{3GAnU@PH4+Ib9SD)5#{)@s!(Cny$0BK-$LEofzAvx|)T5#%pCZ*7YZGt3U=%IJ z+k-Jf{gF7--D*IemW$`enIj03MZbGZ+XHhmJ)dL8Lr{NhfC_cJqWM4yy0P4jhbEhT z+8|klQ9%mG7-Sc*BU}KYtW{C;%Z4H}Me*kJepPy7S@>P9g>8oxD~j+2t@oY!de|t` zO`H!u9Nc)E(8V??L}_FAN~pC?(ZFztAP%GS8AEuv90U16;Y^GvktKn?Qz_k{<;T0M z#P*AknorH|cdePoa{xKW6`}`dBktggwk?M4Il{Y|ai`A#p&!n|&IA@05`g2_)kdwu z>@lk<woI`zbv_{-{Gf^RX(63njJbjM{EP}P8K6^>@8Z8c8oiZ&=1c)2(@6y$!V|CiM1Y!q zX-o>qqm(5@Sj6%CA^5Bth%i#-*~q1KeuEZ1XiFX=(I}LuNu_#3^VH_bE6$cQaC2e* z1*R@z-2X7c8t8(+?qIqPBHe@TGMFj21I&OLQ$nL7BM(ur1WOyws^jP+M6#6gn*zr# zEy3x;@D%cq%rD76L;3!FtgCiJ33dnxVWVp@ZuEh*J5Y}VV<0eBRbNpI_wEUeok>-M~!b&pBr?F#T+N{MDd30(bdgu@08Q&^TmU3V__AV zv!~<`op zDo3h3?jB3GCTfJT*T#e04)N6&DmIBW1oW0QgcX(4(tx-2@(l5|ldS5k6d{lOS&Bv4 zpT1x!`N}%-+3GDEb6!+jL|Ousjk8Pwer<^&h5j-IyQZ zG9IwGssj&Y<%*dgu}5lv3t0ZAXn%I_eq|^t`J}mlD=YT)w?s|0OzK~^g-6u+X`r?v zs=COwr2F*DlP8SOhpVVnEn?t_CfjX*x29Dcp1~2RbJp?ryvk5q6ag(_2BwIH=&P_J zwa?})=fJduHOC5k_B zadA$UQ*P5c1Yo6{{xMMW$rtn@yXHM)<%8*c`+au%4}N1#(3kA*%q&qu1pqDXHEIE@`E(bF+iX#o});N%2 z$!Ch;vru0Fj8yYtAZoP2(@3h|UrkP1wAKY!3yF1WBc-np7e`~AW2h90GnrjKO|MrL z->6{jZkotvvziFsn=rFDNE1d=UQO5;q@B=I#+*xASNEoKP6!w?(l|wd)YFo-+P0|R zA#s<~Ca1Uno7*sLV{bLFZcE={@SwM*U0G8!Spaik!KN>sL*-u@>bILOqsw>7kh!R~ zll;LPLl&MFQi>>xG+q{?zZ=fBV<)P4C0;$a$+s#lFk-VpN_D=GS3f@2ba`6jp0aq5 z8zHCNLsSfuz&=_H5B&on4xm=82Ob(t#Cv}r6k;kOAFtT%Tn8G&H+5*ykPiJ88v!@$ zIK6=VV_i)NTF^|}W3$TS-te?Z4ccB@$zqgI^5QCEvTFLNE)qR2Isn=S4UrVNeWWGE zjE9c_0{I}@A!G`tolQ1{FU#uT)WOtms8C#miPP(d%Xp?NXccAlo(07EK5;jn{sz;V zq4gabw4JAf`JBO;as1-V11;*4R;{t7RJ5Uf7}87qeyyypW_WHYxtuEPVDvTBQM@VH z?Y_qyKoICL@qRl>%tW%!@X;Wytw0p@><%ZTLoO>k79Pjdp}#LJh7>4kl7K}JFu)d% zk}q@R?5sf}=ZQTix8XIrNM*?(Q~-Jq$bA53|D-i$;VgiFD&cW>Sxwt$`?T0Yq2=hz zz%>Hhmkat#)y87kaRerbJ{rV>{XS|)U=Mow5(dM3=e9&7DrgSTA&P}}4x7=L&G`I8 zZ!gOW$`^=vtq(=ecKg9?8N;^c(Rn!#{1EXf?XSk6$8u&H8V`##G^=g|cGFK!#III6 ziypwWt-eRJlHI@FquL)^GtQ;ZnX#ukCX$+Ep@@;IIK}-DzQklYYrS$Hfk8|6AQDUr zM4DhFhU4Ft-<{}Fz4}}=&LUg8?hp?@FkR-_fn{%EGyj}co(PH?K!|Q5)*wzDYsCwt z8^_a_jDza}T7e8| zqClJ4v$RPc1D}T<#=n$jE%_BPryIvNae0v0;Xl>C6FJ2B7&jzvjcx+Ujrd)lNTmOa z%77Jak#oXWge>@^>hbbb?3WsJscBL2=f28W_u6jN?3AX?>U8}b%|DBeJEJglwfAUwh#Ot)^jF#${P6mHVfRYJQCQd_Rkw(p ziO)kMKflxJwZ)dG-LcNpSZkDD?aIND#jwVxs&QRsZgX^)Vc}n6b|2sL>$lt3;bHc} z;n-b{kNeETYg};QDOSN#d|TPIl^$XUCVk%UmjP{y_=rg#|bg9>+wnmEy<*y}KSOqXRi3jn||DIt%k-y5^} zQcTsik#AzeV^&rc-h@BKLkO&e#Dh|i_uxw&1Sy+hLunxHf5CLH0P@srwUnFvS?r+x z6Z4b+IjY%aMASR5j4uEMs>S$qDcoiM2( zBmS!hn%!3TAf4(IXCm;lQQksu-VsPP;yY|-W8!t~Ee=86gE(6; zq!sI|w7eMw>yuLhAWR2oFE!*365g(#RKR=7!GQ)GHP{?|@C~seWIeLV(1Z&Y!Zl-2 zufndw1O+yR$_%TU3$>h2mEZ^$>|oq}U>FZg9r^yBpRr+IK~{hInR{DL!E|mXe2P5- zC`-^Et@fYoet=VICNBTP)T0^A8oybG<1s_T&D9d4gS(u9MviR@b09gtED2)I%++30 z8i`!WI6TDJ{=)#m8C-x);v6l{BmXOfi1fjdwas8kjTOy@?yuLaUlwgM!fJKYCD z3Ohs2*Z6fgXbp$gz2Gg~RVW~SyBeKfoxZ#brh&x7z{zkFi*Ye$lHzn=sl=0L<#4`B zl6_W6Y!gw}%Id7sEgt8X#b+WFr({(Sy+Og$G9~T(d1B_ms5oHeykOk`M3=rp%Hh1E z?jjN~5L>O31ue5G&2(+K@aR;$)6}hsXGCtGhmG9JvffxDE1udrI6nl|-yQQey63ukpOdGU;ILyUU4Ouc` zp317yYUdJ}cX~0G=dnOxBs}rB)WvZ%>3(*v@3F{Xq~|X=d8zMCo3^rMYylR*afy0I z%h9I!(Adh)lsRUAD%wu}g=#FVWln-ia<^gGmH!tc5K3NP5aXdL zwcC%17!ZK*y9MLg)Y~kCoG`SuIc6UYR;izY=-MKiRaC9fVc2^-JTFwRO{ zDf(iy`-Cp4u70_<%xlYgsc$$qW<>Fbd;?naL(3a+U6HH1qb=Qj6tSsHFKs~|PsUK{ z(65?0N~6)u$k}+v<_}Xo+m<^}c8rZCMc%cxi@wA{eUlJT`knAF?WBBW8%VEDWRCDDLoFt74Me2G^v5C-P>~xI<6es z314R&S4R!CYh?~}%wBZrg&2k;+5sA^B37wA)^1}&B5Jk;VCo7FWG@WNV&-vzY6jT( zk2%}YA*bGPjYWKjP*wx7?HsUNixYtKfrT#lW?sK?bO3MC0N%jD{ndrcat$d=$KC&m z5sRqZ+9#nmmaq+XX2C1%8i48QMV-p|SI?6RF(?W?3prx|L$^)urO{dKpog zax*)!du|q_ktC%8RzBViR4r{RX)eBSSYdW30q94G>$7yxbk)KQI%+>23z5+_-=Cr(uJZx;Lfpfc!5^&iM!#oo_2(*5 zFs;ZsD5y+IoixiTTa|OU^L_#b5xbU<@an4Bgx6P2jia;?PJIL0SSCjL~g{kd+)m1w=V?$a=`mEVdh(a59V z1!GcZuWfnC;sSmIChkg}JQM#jJWz(eU)5J{Y~@*Yx2_3xGt#`z(&{5SV@e}*X_w356`w^ZORKv zRqLrUqZvu~kDPvbet2UteK9=Q)K{z`ENv`1qP|q>C};L@?j;z>%aW`ruaeg)stZ`Z z<&1rUH4yS2;}C$2l8jLpD|t-)IT`Oe>JL-(mj{dCg-te3%hFE5sRbvK{rlWsw{EvI z|Cm9aiNuKh{x*SDi2q)B8UHSU`c~ddRbZU;}yW%H=%Q z9eJ8}O=#I+*)Fe};=@g{ukzU*NtDzL7fm<0SBTYAr;}NWV_u693+2>q#G_JU984H- z9b}2oKB`L}v>InmwTlwmrVP#xDfnd-+9nm${UaIOnnRNb8e9l1BJ2w00>-TLJS9Lm%C9_qoja*66TIfIL#FsLxCFjnKnj5jN25;|LHLx_R z3@y~PAdYUQ7kstSe5N9ABn}eybXzg0mPlO2sg@!*j6Ldst{6&)E9hF*PI}m~>eZRn z=^kqBuwc!jO$pBgp1iXAfN5^w_S?Ytc_8@ezzJgo`cYyJ$prTU)Uaa%yxa|CS&Ft(Bh=pONlQeJRR=>V*(TJa|KU4GiJ~#Un%tG)wj)nk4m=le826kzONz_AuVNR^X!ATH-MKDTo*dJc)ns4n zUaW7@N5Gn6lv54ZoUCOL_;lKyfqL)vK58Hn??RC(!u~@d9v~!4@WTLin{te=MHEhy zwn*160Bgo{hk?gK5(DbW@m;8%en<0?*eB?x%WxJxsF$G=7Hud5kq$X77$x3k;W69} z0KT)rQo%{5+9IaERmNG=-cBXMAGKL%mzv9BRE-2154Br)$E3MyDx1d|@T+FmrmBNa z(3uZVhuS#v&gKDI*ocQyOisO4;|H2f;Fmt!&}6P_tNtL=SwS@ldq>q@o|0 zct{4vBoRYAo=T&g5AWDh9X$KAO|#X&%o^jg`H6hKcD{Vz4>$g`!%HA0+>by!MvPyy z-Fk``0!q!C)l)3-IhNxR{Z=S!0u{5ts2h#Z3-Gt4)QnKhp0n_(^X;b%u>(2HY0q4i zgbZu;_~YK!Y+Kie2bjfXybk;TzZ403OaW9y5jP?TuoW*&$UHo|ekWoDcn6nFXTAqe;R5M>>VEQJIK(;KR{j9awyhMQtWYovgho9f97m7da42iqH z0mMxgUpki_zha~GT;fhBp_?$n0pwShu;*EPlZ3?AMIU>J8SvA4ak9jil@@8fdi+b} zy1ibXuV9z8EE#-|(kiSy5MAO0yAz5i0ma}>1GG@&;EsR;unK4;5m8D^^;+h@cC0Rs z|9rH}Mf{}pkXx%3_T!l`(MTl(EDGce_2m4+Xm5!68_?VAcFBrR2jydAF}|?Tq;MYQ zAvkq!egi4t?LF=MnCBn0j$Uh10S5HD>pLI*cP^9ZZ>>}N{}W!MWQn5!+(%8qtcFGSabyRm>d83jVKw$wui}B*0|cCe!eDSC}amZk!RDtt`~mM)3^h ziqQ=SZv&aihR6yc3K{IVf_<(!nni%y$(p zoDp+s$TSfR=kBq@69q8mHmGVF(WVc~rcMb>00zc7Ol9q*f7UK5*|~YRD`2EQQ&o*^ z>;0`cSAf3u3OH*=OMRnr$xlm1R?8V(R$p7h6gJ3Jx|tv3yp~fTaFs)%l73<6rn08N zumtNJnzYhKoiv`57%;4|<*)>G^;)YQwIhPB27P9qcHMW>?{+b0KMh6%XbcWUTqn=W z+4-Fe=C4+4wq#t!&SdRXjwwjk#MByeUkFDeOEq!46e8WIm6FO&^Upt$-3pu%2w|Zk zX{|>J2-AleRh_2`{>3eS$NH z7IZ{$A6A$Znjhd+iLaaP%L#!7$QY`)(Pw|=VC4qQ|NT_)Jhezp0iGCbf!jO=??wC2 zs2!O(>%ka#W|KbXo?-)C>!^tz6qeP8PJC-#Q#(Ps$9!23irtImQZ-Z;QsvU-&@E1V ze~;LLQ6Spde|2mdB!y9@h8o{TYA0zTnzM&m!a+9O1qGlHFwD?wfF*`_~ z?WYb9uHC%FdyxZ}S%u2nv@Sz-6feIz(8n1*CzM1|1L>A`P7uzK3hoE~$PcV}7hCA> zOUDmPU1VNtJT*m)EoT*b*uN)A3_U`dg680yWYj~a2WlEGw%d|wIYvi8z9$5N;4>=_ z?Z|MU6s?!8BskF}mtQH#o8&YHK*`fHV_^L2}(n*Ykfq8h1)$pRp@rqImbKW8g#dGlS<>Wzq?>W^drk*-zRk6a{=bIV~ z3*Q3^RemA|2p`VMK@8mi(8^qxL75t51Lzui=rdm1us2`}rbU1=>mGaJQcwRzj0zi@ z{XjY0PH?Ce&MMrhVRnZoyk;3?Lw0g|*(7XMccH|r6!Ot|7_Joe;k+FvInf{c4y;cn z<0XC~WQ2d}!|S472u65}vD#<^h^RI4>p6LiXu~{Na9oxGX8p{;6(U zu&{bi*ZBA{r|{OX8qh8kl!z8Mu=mgH-wl0DC4i+z4T~kq_tc;}<#e%fQc9jEdo@+- zD(G5`Jy?1@ZR~1e@)=0&t}m6SCZh4l8#!~!9!ruX#Y2i;Qi6OLe}eZUy$3g|zkWHZ zC_JmEh!P=M@AmIv2%EsXrDCwkCJ|sFO9P4#1EzD;=2z@4N|-!^vx#ov-diOlb z&~7FT}mxKaoveVm|5lYDG5_RJWH~`M9dv* zWp9{KPW~G#!xNF_fiDwY$6a>RfRzz$fItxEiSAZQ=Y?TMl>QCSGs9)V>VWfeuwpjE z_VO)w6`!q%5929y?0Z0) zJK)Fj#Z;d?t?>d!VUTP9IVX5jz~jgZze(UgJhlW#?%6)Sj`=j@kOtthrlgc=ozItp zvlO51fVR}JXWWC9vtlOOp{Kl>pM^2GNk$>1R;eS_ z^jEI4uB$qJPgvi&+h(43VaGtGf@H={YEnE6o?N@S&x9dJ{!Ut#L`>ZVy?gpAmFqHGV;BEafl`_Hb>Xy1U~9RX{7d-k>=F^w~57L?c~; z>@CO$dLWs_lJ(4evv;)^5jx?Ttm?OX4b66Y8I|Rl-$G3}6N$$S(wlXC8DzH8K-JD~ ztSoSC28bKjwQ^izn-7JK2Y=XYVT~^aBDZsV4YiSUorZ@Q#)k6cfN46FSg+bDi2@^N z@T$b*yoLGEX&s2kh02XD>Q^TpvW7ozA4Rm~@@%P4QWol|^Y|e*b8g&^xm<;bdV7V4a?e``5KmYA`QRYfX*h1$-n(_$jLTaRxM09CwufA z-z5BnU?XFXkTwis5Yx46qK1*4NXLB zznc?G9D?hC!m#%=3K9w?mjS2KWTzh#BVlrpqzf|`m~hL*bC?+l9zPBmgrv!a!&#i) zouRo6fi_X8&&;V4@m-&UDe$Sx2r5d_Vsdqjm_VfpnLn@AVHZ&_SI%Zkf_OP32`w9+qZy7fG8YcAH+K_RKx)Zo}|~?cyIj;_qi!fpJ+XYgE;rw zXBw}WY_H$(UrfnXpOxZ^;B0SFfMD&7JAJJ4IUgF@?uSO{hjTs8Jx2@JPf3}+ z-}?4VK$$<19zKJ-LP_n#1~c;WrSj+08XPl_4Tc&9_6q2e{A%_xmW^$K+fY~=i@Eao zc-(v2n)(Z6ZcQAPpRM#~5rzH8j0gS|EwU317v!tGO?cX#okC0`y`gDW;?fba4!ASd zGUuYxa@;Piql4{{Kb5_3E%M8HdzqDpVU$ordWL*^iQEUx;wJh5)k7*?_-jLf>J*ty zWFaAZ)T^ty+WWg|^S`TtX))24|FY#KT6zqVd0e|w>Fz{VQP9w-nX5@bshp9aXlinikER$( zE62WCc4Ut12yt2CbCm2YXt6W@!`-*4bq2QtofXa0+1Vda(hs|4rEsHP`iOmX&=I;# zl@R;YU@#WJzFJ+Dz}#c=GWdGAnEpE zgg!>g12rbc2-e6!U+Hri$MV4L*;4SnI#FGj7=oOAZtFA z{Duvf=Sdn*m?Bq)l`n``Zs+YkXv^173d?3d?Y4#FBxT{Y0j7oF!}t0@u4^${mM8W? zy&3qc{RCDVGnrXD{?I(hE0Fq{PqR4w*er;_9Bxl=8&mVC_~mxV29K1kt5n%)80%-; zSzVo~>$9n0Kz&szhann0v+`9j!C+p{hsS5Ya~AcU?@mZWY$hgwG-&4cPCzBcFAyG1 zj87ekZ^5ThYxC>w-B(pt@RuL?f$e(nu6n$2 zU_iGLlCtVOLn^wv{OWo*`%HKkw1gOW>nS{d-A6xc7>uP3-w)HT#jO zSO?rZ*G!0o%wSiz8av6K$cCR}8d*p*YGFvis$l9rnb2=L{m8OgH=`L`%;d{)cLwPsbmMahci@Zyb zvQeDbq>kE`(kf9PAC~a(qhJ)3uwB4fv@1K9#_*UX_1WcFvTK?StEPaJPD<1vtG8JJ z9YTkA}6p`UiCK1@_FXiNTzLJ z+)-^P8B27Mwt3Dyn62T2=Xl%Xl~>C6h}_a(1$UXPMT(pi_jdPWa0KVZ37^&&kKy`P zOW{~ub2aQsf$&P}yVctS)nB!6hZ9FGURc|+ytMT^>t6FRqj=f)j>^O3E^D-fjtPkx zo&dbu(!cd8u^PKCnq|O@OW9S2H7CpD%*J5gYxoR~Z_W4oV!ja#(N4=b1^v zqlv?vhY`;wPM%I`PZ8SqK7H3Vzd2Oals8dK;x4dKUw`!L2JcM+rrVe9cC?j9g|n~U zS7|tcar)|%W|efjvXp2xl!eVIi^j%A^0*ji@FjyJLkKEFgBsq}F*9h~m3}XlF=!!5 zDa_~7?%4GDu2zLLJ&l$z3CJO}7Jn>dPLI!5ZLYfRCq+gQ7FLNO0bGH82N zB%c)=SNiCQ>#hC&vTn2+75w4 zvN8?K%UBKDf)%-`RRW)Rj#%1#B}0>tcuVW{iMTZJX*Z-_RwDgBA-Gno$v?`>sB8F( z^?w(d;e|X~ffQF)YQ$Dg%;sBZ+J0_C8A2gap8E8KzObemH2y17W86 zPN9G@rh*@U2!8y&tjC{4aT7iHWY?e9GU5b-*TryBw>6^<~4f;39rXwx3H_!Lu*avS(3N+YQg9x##3r?sv!Q;^d^6TV)ox_ra|Tmjbol6*@sQhu&k*50b2^r;;OoXcKCA~(lFunl zM1_v5zEr(~Kh>2n27V2=t<4RfAr$y$MJBdG8 zpe@T#x3%9?r)l-dZCE(O@cOX%VjB7{6NEI8Depo7aWw@;-RB($ULH~O-VQO}9@>40lsm#^Bc5hES{Kw5ct_GwNPi^WON}?=afua@V zECpi?-=C&6HfqQZ7L`O7@^Ngl2&c`P&F}u~1-f-_qQ29KM%r&{+M~$+e9+llVZJCJ zcjB4AR>8AxIIgVKY9IcceTBwuw$O8?3k<4fTkoh&^`zMN`DS-nr%CiFL&j zx!lcTH`dl&a+BfJipsjF0^<=l=xNR){-$y;>=IQPkktjo1WyC zSj+GG37N5M@EnBqkKQ*w7TmjfoTZrz9ui}b@u7JfL|jQw;Tr@GsgoyUp{LUj&p%PP z=o(ZTeI1kx8C5Wys_VA-%w#+NGaMnKo{%N}C>13qG4kU!8|2E4T!`oGGF|Y)bpmi* z1PifowDG#9QsD8JAj*dmmnWM2-Co^oOmyGZE1xg8YiXjYB~AL*%!c?Y`P#;3m3WED zna&+%S-p9EDG_#S{BhkQu=C#}yxCTl%qN%ch_a0)oYlbV8Bl}nO>RZ*-{6&qztU&y zqtsfeN2%Dn3P^5+M%CLe^(EDoZ2E4v*Q24O9Snprf}uq|8vGJ{iG1&5cS#g@`v@1={<>6+Vv3k{%g>B$le|rzHwCjTMVvl zgBH}p6^|_PwdE;@vXT|jvDpPvHlZfm2u}9vy3oNyA zq9l&e`g*OKlHP@;SzJz19`yG#R}1qlCMugZiacJf7*%PVB*B$Y`2=L?u|13gemeCQ z5X90Ba_=%oV>0AmGs=yw^H-xj{xb9U@zS@UKBYD7!~Mh8KdJ5=DE4jt5MwT{{jO;Y zmE5@VC}}A&jW(eDV0AE?UvpBoch+lVNW-50h_S(|o*DDOu-+;Q!((g$Egpgr&QApJ zt+VRQSqTSd@h{R`yU{uK1y?_5=inS&B@H8D&mH-v3lhB_X`dWo_u)mk&?yVMzy1H&1N3iGHI6o=!}RI z5`!+fM-7Zw)aO=LOX6uxrp+wepRAVFb20yEm^xF+L6KSggn1#pVPDtL`k>PoB7A+8 zkayFony}%sX!{ZU>CE!`^ckC+tNYy)VO5r}!|WXy>;tXTH?{BNJl8(PHlxog?->If z@gVJD(Y=K3-2<({uLR*GQ+%14SwxSmOInbx49?n%iXpOkoSh)+{(VjZ^=q2Uz>fUB zR9gz6xr zI)g0EHD5Pj-#4(|aDC%p_J_8m6FH%ier$W=S&hKmAiJD2Vgue7vvtar?HDYry)|#r zVG(@~LPdQ}DTXdAMa-O@ya+~#eJ_qj;9Rt~LnoG*4!ItAEf%yvhz8aL9IaUtRmw@i z8kp_p!%0_I@<-A5+R!^r&o0u>Wi#UC)?=cHv@)kLxFt zSdJ9lj%xR9fAuge7$h>!DcbN+mDKGL8|SwiL5X^0%^4xNVLbKuA(HQmJT$4LM7>y3PAr3ATS=;?2F@Tv zzFb-R9^1`&3N8BJN>wl+XTu<8S){e7=264K;7r0%OJqcxj+77QjB;q{i`MHO`Ap)A8c`I&`=qxln4%fL3Z02~JUs&O7^Za_e?bx`%!(dFMrXEGGSKXG;xNEAu%|7-(7Qr+`)Oy@nxK|@)E^YjZ=K3&38mRvfna&-jU-ADl{aL?9FMy z$P*q=OT)mf4r%0~yKG0rGgACep~o$dHzj&O5zj~%{xYJCIpB-Iyee-5p@HgMND^qR z^t%7cL)+GR(^;SZ2e4IJE6o?f2K`*nhXXnS6`{AakAhi`6-C>YJcb2%T4K<}9_lE@ z^$$I9_llnTOXXveH>=sA=DPE!GtOL+VRGykA(kF+k>#&FuN^B@VY{`1njUn{fKp zuFlxGD9DdI7vH&obtD$*QfEIK2zi<^-i0?BtTOveP3xdsBHr1M%R3cijg436G0J&% z8~lXtmr=R0fjbF}vMYt^H5Gm0j&LBS6Au~KB*%6bTYhZkW?E&IF9PJIR~_+KPrY1O zX*wv@{8H3PY_5}H+k3-efVta%0%^<4L>2a!UYOP7$G!53+MJl;V$;zHGaC_Wo0Rfm zlTodYZ^&L$UwSjqmn{#?Klye9ZJJi-5%A!KWxB1nMn8@<8k@O5i7 zZjqkXXt;DypOLNE^37Ws$UJuIs-Le68*g^KaK3tG_l9=XZuGUYVz$rAH~k(WyhFV0 z-#Cr-l4hoyxHSywxsI@B`8GYQqszsi0_?+LWs`Ny~hWcA-u2yBN;f5qSwz{i_hIk&Y$N zD4ASU&u@pie!Fo>TW6~OWI2vG!tI8AU%WwG`&qF+p)5BC>Ge;On{&KrlhpZ#wgVV1 z7lG*;l#%s&QM~oe1jHnKw!_o37GwOGx{2u&&L*6uXxxbpO}f!KDX<8g^^=59o>5OW zYt@%Q)iFy@uCr1?gKzYV1vDRi&(P~714eF&KKEh>n({0c_1~lj^`DJSNlit)kmiBN zaJ$|yTj6sJrOL5WD#??7J8+WU`0Y`59%g?C&W(ooApacd4H{Gv(9u9U{AAy;)qn{fPf{VG?R%=RN_`KdO^`Py ztg@s4I1e8hqg{xS<-9xf`aC|5ExPE3^NFl9DztHlv|v%`6p%GJt}Uiul_=FL7Vgy9 zobIQ$8AX(XU;84L>;=BQ_&z{qYH6l^($Lsz>bb3pf;Q9YE#{97l+TL{$sjgtA0fci zp0`eKt;0I|E5lASXKY4pnT zMc>uT1D2b*h`ms;S^X+B3F8-;-}`Qzh_?+;KEHNbKA(DFUz5ZTxgSH+IL-<<5pTk^ zYdErH>tE+BevZT*H2}`zb_JO~Ig!7{yMJ&Zf4TLi)nx7gtIT5@8XP`o+j~?T5W?q5 z*xD*{iW0Rtb9a_uHFI+|dE{Nditi0VzXGb9<)Lmu))1ttMcb2XoO)Ja1u~hh7-25L;h2Le5|M67#U9a;WPlez0 z3IFj__&vz`A5VqfqaFVjQ-S@DUGM*S)bu-7`2Wc8e`EC6-1bm&5||t?MEm!Z_*^W_ zZOu7<|Nk51U7dk&DgokVvMUIVv%5&O1-z_-YPT#^xjdOohlx?Hn0?5yn1VuK!QlQK zMxirx=IopVNqf=G>M*irF*rEP5P6N2x(*r|B4XBE2Ytn+4kg$}z3vcx+eC|==T|U|8B!U^ zwt(Ed{Ah!@CSCn|YM<$oV|EIL^zAsfs1rU>dYy>?Wo;P$_KaiE56q)SkIU4T#+zmGtk(7@vd^Ks{95c;xTdQ#w-;o*{OAg-P7!s z)@A`eW1kq^)F>m(pzrbqsSe7-cEqPBA7bKyHs}@cgv#6$2qc%3Rr}F!gw69dG?t*p z8(-t;{HwWs$mdC+mT?1f!8_i@g}#{)kSI*`Z}2(#wR?0@(cPRb>gjY2o4lM$b`oaB zD|ae|UahBtn<^2Az3xes<|ivMq{!`rQp2004QN3EW${5;qZeX#?ZOCocJczXp>yOF z=>iiW>4dG1$-Frs+b|c3*s49#2tHx2V&yOKFXW6ocU`oDD6h_O)XZ9{%IvzYsYe5` zJbb;f3B@okHHc6TwaBenM7u1L9aoa<7@f_Fxgt?dR(+B>=Vdmh_-dNh*Y;iRII1YI z+z{CCT|BO(Mi=ZFRZJ`6?z&rs@!ryHo*s1&jY?q$rEDgITzQl!SeLK(y_-Cm-{;Sm z@0y>??#|cDL?n&7AC^VEZ}iVsV9ZUTD9tL6j)~z8vm~txH?ySk)&MxNE-th~m{HA!-MqSEVa(SS9 zPToV^7=YtvLm|Iw|0Y>1a|W&O?G}ALkJ1*YG~Y$3bnISsN3LvLOp}$i9dikZC}HSO z@!JV&@WINs7`SM=4(7$gnNy@K}vb-Lm{eOv=+n%_cY;{Q`hY@IA5cPbPb;#w??8$41nx9P6>}$d`0w zz;z>}${vl4SlhaieAg)T^8apUKp=0n7$p6gCsn#rJhPfyB>27Vbl^8j@|WZH&+6F5 zC+Aol1a+9}$S>wT627N;f68_Af~EOzKhXQ>P~ug2U(nhUq7t$dt4Qfbb1p=mxp0;b zUxJ&AjRdqfer_`6PGzeVLNSe)6wKHKhF>1&Fn!x#p~Yu zKw!^5h3d+Hr|&)Xv;>{ft8KOKh!FXHc1607vmz?XhF@ANld(_yGFK@F^DKnUKDqMH zL>`K-M-+WOWYaY9xk_8gZqF6JqNPrI8SL`ofR5{R-$%m=ts&%DfDXRbGFrUzOm(v!kjsshxAN5iW#7#MF3E;N3K=JK8TK9{XY} z1tK>0F#T24k88?8KG)KX?_G40YpFyBP+GJ6;zwioj1jow$AeMWY?wS_>{7f35w)9R z#-i47s3vOKUl+P|Y~4K2Vix_aT@`cWIeVUGz|YAzAB`z}ktLg6)6jkKJn3Aj+osNM z`ULy={0`|{*becwVWGOEr(w?cnd0+213xs`m{%Idqjlbgrs;$0_6I*5M-I|8y!=p@f}X#o z%gNBZUj*dl)i;YYC-#(BnAVN&g2NV!0 z3LWSUAqpxX3bNyN-X97&0PQWn|KmWp1HgC}0~6~WHt>Zi0?-{4RMb0YsJBo9-}VLm z4niYDCwj;&areI3D-1eEVjlmP3`}~-vQ`rHkwXSv6Q_4r_ejaeDJU5qF)=@8;d{a_ zASm=yN?Jx%PF_Lrg@&e<_DdaIQ#13|7M51l&MvNQ?jD|A0q+BYfXV&gu3icd)V zoRpcBos*lFU+}fOqOz*Grnc^TTYE=mS9eeEkI}L5pA(Z)(=*GzR#w;6H#WDnkB(1H z&(1GkmshuV-QxMz<1dK)173sxUU$&YP|+}M@j|)d4xFfjXy^~Q?-EIbQ*i)at{t$5H$z45}|b z1Yn3h=kXLd_SO!7t0F-$NRTcPRI+%@T4lXCw&Qv`x=(t%*CrH_>JAU}I>a4je&)b;Muw>!51u zsp*1lC1(AEv_99MEP1r`G7_|`>#>1&dmp;E*$n#%OL_e&d9>p>F|#4o<}MP{e_^@& z%{h-kqrhU@o7d;%VVoKHTtLeDlyh9%Wzvfy(>AC3iK`~=_Yo0z&KJ!h&W1wvha27e zC*7QI`k_Z%xK(Q*1+9aai=#CUM|^xS;E`w*)Fug7!Zf<9*klZr6Kgscu>AVh;-`CmDnmh#x+ zdhGmAO(O~f?}05jXdn%kf~e3Rf~!y#nZw2Ccsa*qc?o0jbw~m|wcl~+wUhu7ln%M1 zM}m0#iUSbPPH4cW#-wdu3>0k3%P zL3-@(VXmK`dLBI^N&(4^3OG*|n*(509u3`q9w9-^BhVwwh!eJL&iVF5#5{Ce-=UVQ z@tM!a?&4v!2xAS6-U@m5bg7brb>9nDw9XBG*% zH`Wa~1tlYpAQ>d6Q@a_?GivW*gl=`76alelP+nVMcu?mgM;{f`=u=3M_{;i-;1B(n z>ZB(H-Qih5IcS@MyPHW}(-q$r=unEC@?7Zl(pc2 zMEvTC>|uH|M6=QCM-isG?YZtyF~6#Sqlz{$+M~P0c`8{}d)}0i>XIelmHR_SgogJ2 zgi+VZ(Pc5U($;dmvxM&8Q2EKew}+1yp3BFtAi|NLu%f)r z7HT#L_|R)tBeTg`9E0~!23 zf4GbRIj4M(t7|Pyf&NL^FF4;neU$SBCdyu==WOHl+MSyeM_jO5QqKB}r{T4ENXc?U zRv(r9>#8vXR&RJlV4m_*-uhtM}o+3S=zA4f_Hl#+k{LfGt^|^36cP}+h4#E5WX&@*C$L!5Ot|0?9(B>EbP-S z^q-|wtg}KLtayD+$@1#*A^}5>>QrE65L_f^*j)n&YRW=_e%UDF(-n*8CA+L;{P@SV zvJjN%9nB{@Inc$=5ZIcl(P57t6(EiK1xS#u91_$qf&}3NFE?M|ZKq$1L*dFaTM1>| zP@(?=4Q+Z;yPu?#!k<7wp&OHmfZ5@J9{qqU7r>t(L1N#vZ!Y7IpeSw4e*ggdPY~`0 z0}u)7!e7E-9Ks)u@+I2-z!KR)nIXOz>v+GkYKoe&k@p05qe~@(UtK!ZDoJe1r>#~5 zT^dg(I{7#6?v7tN;4P*4m)!_WPcU@;QQ@~Z`14g@@ab5T4deFBA zEQdESE+nfqSG5Nhw|uusKkRLKu<0ZB6}s4S(>#3+{zQpU-iZVWtRO+49HuTLh$f4F zUO@gMrSJI*eNK5o``W61R(Z#qCTp5rS1O*_^h#Wwk0VmWk@>^Pj`u;0L z_~!@zp=FxC$nQTw1Q;T}C-p}c0a-uoO@oAHtmx_H<@F!0yi++TeFBh9?r`V^$GxL=L0?hMYueqz&Fy3Y5<#;EwozE|&@>vLm zVk``b$?VN;!7j2fLJ`Acqf#q3?_@!`a{h7KKi3y$oS;LpfNhENitau@fu(oQJk=Xu zlB;d1zKJ4+CNCCY*5ED8)eZ>Rdf4Pl!RDAmXBwueag;iUMeQ$^CuNg2_i23_HxJ z=bqFXaKLxlxIvxo1V#Ji^)NmCG~Xf3x&K}o-i@MdG|;WR`v+e zd`WTe_Hq$Dq-i2K`sinD1X_L>e^1k)_#N@t2E~x*$*}Rg3q$Oq;tr00mi?lUMEF3+ zOJK>FU1*Cb^@hyzuSVF=M`)QF?S@XI=}Z5XdNQ9Kj8ZmbhKx0 zM`_O;+2FG`UFU!&r*8)jG@v0k$|O66V~*@Af7QJ2lv>L`eF0dy%JD<@NTM0$=4JHP z+=1e9Y_U?J7w`aCH-Wi`5;T~uNMZIivbOqqT!w3_REK z1Pvf^_aU0b0eTOWE+RXNLlmo*DRr8n?nGW^y@rka*W=!l^XYRPPJd^gm4}6T9D+!c zm8ceC6Ap{M=oEedb6!c6l~450+Qtpje)HUz`SYxV09>lbTjYC_wG7>GMIze=mU5mo1dHMWfFkx+Yr zdA4uzA)*TE=ss`#Fg=hU#9I#NUV{-_)5|mPY24bm^)=$H$xX%LS=L?}5>#vpZHob{ z;SIev1-U__TknxCBW}HLBwMc;^u)nNwT3h~Qz;RSC$zD3{oDNLx`8y}tL^;aD zRg{-R0jLi=TX%*qzGY+J9+|EH&Y^vg1eax^Yr+FD7)O>^y<284H5T>@=;?i}f?lC- z0S*%higbgLh~3rkd49y_)pA5THZ(m7eoUxO&1)P`>&gTUbZkEC<=1mYg0Rxb2Ymv! zQkxggR(7;fROpHvqwJ>}(Ezjj^(PXvNtTDONAN-0HLU?5!yW@1B@#rbbrbt0fdMuI zvJmq3Xl+G^b$x0!OMWtVKtUMUvW~v;02*E6w2-3VNfS@eY2E2`7`eie01R%0z zArOdhs=ycFR*L`-p55?Aaw14jANnp2G_gQ&I}69<1>8N8+~vI z1aSWgn4A#3{I-!zJWRsk9oU0jP_W;4_%*{cKju-IL>Kp+lQ@64?*Lhdlj$`=HZAU2 z5>}}Ha;96NtagzzmcPQk9<;((HoQ?Pt|D%weg5vqhFfiUR#Mu;4%;{bEeOM%{@!BD z>DTJ!@`EW;y4mhY(xddmkPpn;cRir07~}WiRi-oDu-AR08|Xx0>S2z@=_@NG5Nh>? zXR2L#+Lxs4P)mGbgCO&f)A2|Xo&H$)AN4Qq;IkiG31s97>|y-M)|sxPBKUUK3UA{Q z1Ufl!Yy~HN9rf$$wuoO4O;yu=J;VmO^A@uU(Sm~@-ndCLbBPsz`MdmBvB~1Z0RbKG zK@5l@C&5~mJ3O2KF>J_I8_^&Ju1G*-%h&&O1)oy`11||B=RD^~!a@l$7sWEhb9ek9 zV6>x|aBk$f>;rY;A#ot9=D}DzrJ!j`2Je2Ck~KZrYk5`m!Wt)HH6IKakM0WZ5OPdK zf{1nOXYO}~m8b+4b&UnBmE)76*=;*<32%hucwej7eD`gA=gXv`putMgck~I({q%{5 zQ3Y#ZH=U1oEyL3v&9wAxvJ=F||Lgj1bS$(cp70Lu*4LdH*d2$K3UyGVYXgifH zcohgu{va%tf98HMz*`Q5qcqT<^PQuB0Jv`?t6wj_P3i&n>(jS&;SzD1w>lKMhJf|=sFN(JqOxVs2GGS^9XGqUUI&QgZrfbVu}-I zkpgWqbMA(JGhCsE-3VnK;VD6(J@)V?TBU&DXoQ?VkAR-S-(`C&;as8OjqOp4(9B(0 zL+3Hr^?A0@^rPNyauLUP+#zHsDflbxKkDC!>qKnc6uqr{PZyv%R=}s>9?MVk?hH zo)-^MtYC!2uMBUu%Ms^YZ)8l^B0^Cl;XG+(Yo>8(#~uD!6aW%wYm=?&Gb zQjeDZtI@hOT#gHDu!`ko^z8tZpLVN3n_Y}EA1dJ4AB0e+CIsMo0`H)k4+RjY5SVtN z-v}7j$LLonm=O`2tpGJY7hK_C2&pyJqeqKYGkkSx&40<=U~7Xft{@1OCJ0&L`p3dS zVoSrvzw=JlDWuvTwc6WqeB{_>emb*5P`3_XmiB=oy0y2d7$oRO18`cf7$ivYXZH;v8t6ZlsO%}NApDz;wGkHf=VE~HNElu6 zL3^&e|I`vQ!0wcz9KDw9GpVon&881KL+SxjNyBxnPOGE~6FqQH+olK7tpbNJE+$~i>Uy~GOQwTJRs`SvzAy&Qmk_}Xkq6UYL~{;4&j33d439Tj z$7bz4D2Bq*AgjLUfF|QErC(tx13kGR1TnN-%7dx&{QVRXRC>#U!=OV*2fxuJQ~YaL zG~REap*_^c^Ui6$Hx-&ihzD@FD*1L84OQ%yfQ?Hwv1@@JyvH}Yrg^Agkje_6UyK3p zCgC#p+)%~l`Y-Q8`LEum0ux8j^OOKxJ{{qbk#!!K*gGp=DD?+?rK48rp9asCOFL4Z zDU;^4W-h)-Zl7&X=-R>?6>vKdJSP_Ewmvt@XY7#8&v3ODZKp}Ob38e3Qq!90l2Q6*L)0E=$O-sKbZ-OWhjZ&0{5u4`sljV9>r%=9ugspm;fWPf7IU6d@&Hr zUhA;5y_U_jP^-M@WX&xwksFlul=94J&JIGT(@r86&%ZEWljqzy;6PzV`YsI*SlQCX zK$Pv8eiSfbSEj3NVa#9d04M(ABeJgg)cXeGF0e`omv|>)p3smbcY3Q%FT8+)p%N=M z_g1ZWJGvly_7Bylv?iz)>5UOfE+UkNDx|Mfh+$nKJ>qV@`D=0yhUn?@z)P&N@H_QB zOgRr~2XgAJYlrsfH$)N5!Peq$0_(`<`Gi&=-|3qnom&WHDm%bJmjnZfohDZTT{vCY z8LIM$xz_ZE-%y05QWMS(5J4?ETGe`}D<-1=k+Anff*=>*i?img-1Q%+KllA2%I8i( zGcZzK(|I4k4bxXu`y2$%d%y$T_a3@Lf^N-X zF@jIuulE8X>o#X`<080$&`Ey|37>?EZq7QUpAD}>U%vJgLU0-#UX%{n!;}vo8;BJI zqUJUz!)n}sBSCY}#R(v~^wV$0|t2sMPUd|m1EYE1BD~o;tr|3tF^VF zN-4)-OFQ7M;w2kw9EezO}$cn#FZn*Seg-&tBal6^l?B-iouojfCB35t_QW8HP)PE1r5RkSLvsy-}T zA?nd_gF^l@rs?^~H3yMlKMkQX>WymA&EIc`tO1O$0Up58c#E<0UuQ@Vz8A?q&}L`Z z{D>_0(K8j^j;p||T{_>4Rf;*cZx^gJ^kqzGTqZ_@9=^pt6FMmqW@w0{pHpZFxpAW; zW6-+|J3Iwn?D0 z9Ck%5JwSpyXduDghDxhm*@$spi+$O8^;Lh!nuNb+l#BiNodU(uhKSpiO!scX&~TSt znj;_WNkoT=A0&JX9!6m&G|NYSV9FhLir|>P@hv<_{c+(jV91}wix{th|F@IK;(lR9I^#etN7t6|($3IR4 zW^z$dLj`e_t(6Ln3)AwbW3l5yXZXn%>Lt){R?y5gcCIwe?n1{L(=RQ?9L`R6VB@F# z@4}dKQGlJHF$U7OKGPq`g|E1Ux+}T`vyi8GnOQX3+vi_!f{>t|yqrUfE5>GVIrz8e z$t$SHWQa!v_ODX1I4WKW^1Cf9?9~IJep7k3#90PLg_}52ZnA$lsDE(yT3v@9AFklS<%Hg}$ zh{=ovgMHTMdBtS$K`%VGpQi76Ib$_U_rh+D`4zuJx4JmR1|NFNHrN7Yb(_e>xPe8( zng580p%$s@FRx<=`J-L-|pkHv1<4qW_2$$uFZn0iU%? zmVUAf*x0wDK)w`%W#79vDEjb1GDNC2wW6A@CL%7%msJlzvKZLBX)uZe9TEWq z0mF<;-I@f(Qg`=FWfpX@{m1b?L}hCaYY?3Z^@;(pDD(7U`;2;KL_B}Y629T5z(2uM z&+f#ZAk!?ZJ~(j<$|?|6AvwVsJHYr&*cK}YED41*ZTe47{5P;5`R|dS*qbb9p3uItLh{vl&reF9eAw8juE7x(x~N=(S;xAl-t5@`*dh*cbi(P^yA{2EzJml!{L0JxK;WCEgamc>H`X)dLh2WR?x9{7 z>4Hp`o%tKv?fWUN2pXUds-$tMiiT}Z+hvz4*sYqfgap+u<}gjK&PG=$k5ROFZ9v?| zfY|?uNf;X%uKmM7j$Dc%@f0)QYqL4H_VgBHJSFZfSY2LFe7nUGYcJ+I_!YhBu*-yI zv(xSiZ&xH}$5C#2bqMa$H(Tyydfj-11fA6uY<|J~XGm15k8xgan?|@|4dMe|1OP*a zR`k|@t&?+k-=7Wo9pr&k{H$~rq*4r&c+>m^flh;ajbhqw!2SUc%WIL(NKo`=?{gI; zsC$hOqJ~727zN{>0Lidj)qlON)wPfz)NQnUuz1?3A_EftGaTx^Y09m9>pQR-LEnO&Fgc{9%Y&5D@Zzbp>^qYcSufV5@p06^)z3n{6KOyG{u`Y|56p$VNz5-paX*& z--M^4s1<*!b>RFYFS58O&TvrTed5&skeJ$KRSPi1td{J#kSho@qF~+d;HS)!3DI*G z54azFbVoFU*fgk8mA7`aK6*9TQKNA+7qW#ZNapCI%Yeu)f)>AqsPBD`cF(qbqb?R$ zDyFa1+gm^>;*LJ+YCa(zw1xMY;n^!aH+Hj>;X9`9k}EwfKPi`6t2U9@!7@7~+yd_D zqaB6OPlH8@y(}6i+P?~1jWU(5t39vE!5SbEtx1!Qtrq0e- zc8rLhedC*Lvg_c>Fz0uR5l+N;kJ)7HegYlnO5@JO5brei>)d4m_jRZH@X4MEz?r|6oc*15 zHJ{eM2j9+J`~&aYtjyj2#=D4EWtDa=oS*}Fcrdg31YU02S69sUOXaAecQ2TazJK8l z{q@G>`mEOK0$td_W_Pj_T%RVw@7l?~q^9@caG7=uC!$g@xqJy6KADU$$c33DZH`Oq zgWUtpo7BFaV9)2%>@9ouuCv;qCMJgp(MQ&Nbi5)|sk)rAD$LVU^UMa=qm}Q9c4K_c ztTS+dyfJipd1;bmP(>-)hDDaJdkD~iH%^>xTvA$)oMvMU@b#rDryFMZwUONtgn zu^~+C#a~DxOV02#h+`GL(TwB7`!AO)O?&XID-{L!svFthpsRQ~ebs+S7Pz7o->KoW zQ1a6xhlD!a$*>>|J<IauNCG{iGdC+|Q+&)A&VShLe@-MkIbrTs~1pK8M zIPU}Jt;V^$GI?YE!o~BAx$~{g;q)uuz2hPmUv3O_w?z1|OQ|ssx6!h?Z=|k%Q*m1%uIN>YsQC)TtXrG{$xHI<8HKffT{R|FD00I6ZkBC?Ul{PNopaW$%{<8zQi;Rr|-(F9gJj`QjNl%e2{Yq^%m~zr+(# zK78u1#U&e&ni`{G_5Nm+Byrz8e-@H$KbE(#|FucOR{M^8Jn6fP4x(~>0b?h260bUx z9sc#rAJ45+DvP*U)RNgS_!chm;0WC#JRvmOWyTsoS9{(B)j4};8T7=hqeZvcJ~>b! z_;kZ%aeNU5pX72GiaTog?1$v(s?3mwN)R=%d%9 zGHgmOKctZ3zbl%B!8!Z<0Kxiaqxq~|_ly9LP8DFmI)Xn+=qm?@|0ke-*TobKHTxMZ z0>AW1r151V+LSbtnZBk*NN_nF;f#eq6G35=?KF+e#g4lpt$6VFYR_JGcO$X%rn%1s zqLWE)S~1KA-s5@sDz*@7u~d8>b``6KNhpN0$!8S%WBK}vm%=7F-)t45f=STc5j|3} zB*~((&|zlDm)U$ZZJbltL`o>t-1|o7>m9o{M}>FqSG;P5{8$ot7emXb&m^zcdBpFh zr7@Ga#W}aZiFYR0m*J)>z2qLM?DP>8Seqk$mf5AmddXMG9mV^b;axw^-g45i|F5w# z4T&m>0`Rj)Xmcrz$g<4BG7AQmHc+Qh%aM?DjC^WtlVdIu&6G*eszDhUZKhVHWLQz= zpcN%pPLx@a61G^QEtIyqpxJ_T-+S7*bC`L(@sIQ4e4e?_d*{B(JKsrZuXJCwtfqg7 zW2-eAs6P_j()KDZBEL?bF#W~|tDA}@5AR1)k7k8#VGMdt)m4X>)anh&R|cz9HZJUk z_pEQ?bDN4HpEsjfjaA{C*|$GmIN`hRdAzK-zO>d^uXOPWY4VC0HKnm|>Fx%(*YFC5 zdRMK}J$6<}?~F3P1>;{W#J%syu67WoebXwk5mc$HRh&b&GZ;uE`7OJhAma zbH>12d%Nltsa2c(`iw1mY}IbRmR~N}+quhiZ+q@?dAEJndBYd`jF|&H{eFfp+e^l@ z#ZSx1b6_*@BX2VYJigy4T7B@Pdym7DdDrGQbbqz( z^SU2#taDmdOo#Oi#g&DT?VAim5w)rQUl;zFP>@}t`4;3mvG-^HSz~K^!8_yHsNdlG zwHh{;fz3y0?C}siS;p(e2w!9HpTqseF4d&#RO!04;h7s$+GuWKg(^$|>V91@c~F^o zLnb3>20*<&k^PLIUf^p6aiF`W@3ZkFP)VLNpGt+1cf%Wn(zQqhfx+qew4B{f^VA|B=MAcwRY`&Zg=kvlpA}omPrfmW-BA@K2F@l#T zU_?TcYvnESw>cBVG%5!&w3AE_l#v3e38mBQoh;G7>40gk)!VP1BG)KvtWeDf*e zXn3G8VZWWcPDTbu<|D|Vfzawq0PHeuXj)V&;VE8QsEP&q1(qx2mZhx_>g zE{8}#{#`yZIJ1`$_v8fJ1erLF7fRslaHBcE9U`MCmK|?qz&PB?32@uU1Q5gViUW+p z-8=wyUoMX0T>%(}+W-KrEkGQ{7u{nVmXZVR%nETFU%ifTSaS=wQ{?_kZ0z_laE!yY zMZl?);yA&*h(#cwt6f&4Xq?0q( zNg;!MLppg!k`yu+Eu@pP)l$e{i4Y@mt_67IBugO+E5(1OiYfZ=dP!)@`w#2{fUNUV z1T;1T2%p<>F(nX6Hd-vL#Dj;AHUY9GPe{Y$pc9AV(=`Zp%ooB<&f0J|KIVb&2L*$J zV0!3-0j5VO5Y8}Vh13`f9jxGR)B9XHJoq#fK6uv~su)2e4h-W)ep< iota.js library - -::: diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_note_replace_native_token_id.md b/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_note_replace_native_token_id.md deleted file mode 100644 index f4f9d5bfe43..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_note_replace_native_token_id.md +++ /dev/null @@ -1,8 +0,0 @@ -:::note Replace the native token ID - -Before you run the code example, make sure to update the token ID with one which is available in your account. If you -haven't done so already, you can follow the [how to mint a native token guide](../how_tos/native_tokens/01_mint_native_token.mdx). If you -don't know the token ID you can [check your accounts balance](../how_tos/accounts_and_addresses/04_check_balance.mdx) to retrieve -the available native tokens in your account. - -::: diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_note_replace_nft_id.md b/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_note_replace_nft_id.md deleted file mode 100644 index 4b55bf74f77..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_note_replace_nft_id.md +++ /dev/null @@ -1,8 +0,0 @@ -:::note Replace the NFT ID - -Before you run the code example, make sure to update the token ID with one which is available in your account. If you -haven't done so already, you can follow the [how to mint an NFT token guide](01_mint_nft.mdx). If you -don't know the token ID you can [check your accounts balance](../accounts_and_addresses/04_check_balance.mdx) to retrieve -the available native tokens in your account. - -::: diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_password_storage.md b/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_password_storage.md deleted file mode 100644 index e7abca479c9..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_password_storage.md +++ /dev/null @@ -1,7 +0,0 @@ -:::warning Password Storage - -It is not recommended to store passwords or seeds on a host's environment variables or in the source code in a production -setup. Please follow our [backup and security](/introduction/how_tos/backup_security/) -recommendations for production use. - -::: diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_tip_account_approaches.md b/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_tip_account_approaches.md deleted file mode 100644 index a566b2c0a1d..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_tip_account_approaches.md +++ /dev/null @@ -1,6 +0,0 @@ -:::tip Account Approaches - -Wallet.rs supports a [multi-account approach](./../explanations/account_approaches.md#multi-account-approach) and -a [single-account approach](../explanations/account_approaches.md#single-account-approach). - -::: diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_tip_faucet.md b/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_tip_faucet.md deleted file mode 100644 index e05c8654340..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_tip_faucet.md +++ /dev/null @@ -1,5 +0,0 @@ -:::tip Online Faucet - -You can request test funds from the [Shimmer Testnet Faucet](https://faucet.testnet.shimmer.network/). - -::: diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_warning_dot_env.md b/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_warning_dot_env.md deleted file mode 100644 index a0bc37d7dd8..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_warning_dot_env.md +++ /dev/null @@ -1,5 +0,0 @@ -:::warning Dotenv - -This example uses dotenv, which is not safe for use in production environments. - -::: diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_warning_safe_password_storage.md b/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_warning_safe_password_storage.md deleted file mode 100644 index 94e53d498a5..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_warning_safe_password_storage.md +++ /dev/null @@ -1,5 +0,0 @@ -:::warning Safe Password Storage - -In a production setup, do not store passwords in the host's environment variables or in the source code. See our [backup and security recommendations](/introduction/how_tos/backup_security) for production setups. - -::: diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_warning_unlock_conditions.md b/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_warning_unlock_conditions.md deleted file mode 100644 index bba2618177b..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/_admonitions/_warning_unlock_conditions.md +++ /dev/null @@ -1,11 +0,0 @@ -:::warning Unlock Conditions - -Outputs may have multiple [UnlockConditions](/tips/tips/TIP-0018#unlock-conditions), which may require [returning some or all of the transferred amount](/tips/tips/TIP-0018#storage-deposit-return-unlock-condition). The outputs could also [expire if not claimed in time](/tips/tips/TIP-0018#expiration-unlock-condition), or may not be [unlockable for a predefined period](/tips/tips/TIP-0018#timelock-unlock-condition). - -To get outputs with only the [`AddressUnlockCondition`](/tips/tips/TIP-0018#address-unlock-condition), you should synchronize with the option `syncOnlyMostBasicOutputs: true`. - -If you are synchronizing outputs with other unlock conditions, you should check the unlock conditions carefully before crediting users any balance. - -You can find an example illustrating how to check whether an output has only the address unlock condition and whether this address belongs to the account in the [Check Unlock Conditions how-to guide](../how_tos/outputs_and_transactions/06_check_unlock_conditions.mdx). - -::: diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/contribute.md b/docs/build/wallet.rs/1.0-rc.6/docs/contribute.md deleted file mode 100644 index fd7ec9d6163..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/contribute.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -description: Contribute to the IOTA Wallet Library joining the IOTA Libraries Initiative, contributing to the official GitHub repository or sharing your knowledge on Discord. -image: /img/logo/wallet_light.png -keywords: - - join - - documentation - - project - - contribute - - discord - - GitHub ---- - -# Contribute to the Project - -Thank you for thinking about contributing to the project! We have the following ways that you can contribute. - -## Join the IOTA Libraries Initiative - -The [IOTA Libraries Initiative](https://github.com/iota-community/X-Team_IOTA_Libraries) is a collaborative effort to help improve the developer experience. - -- Quality assurance and review -- Documentation -- Code samples - -If you'd like to get involved, join the #experience channel on [Discord](https://discord.iota.org). - -## Contribute to the project's GitHub Repository - -All the code is open source and hosted on [GitHub](https://github.com/iotaledger/wallet.rs) where you can do the following: - -- Report a bug -- Suggest a new feature -- Contribute to the documentation - -## Contribute to the Documentation - -This documentation is also open source and hosted on GitHub. - -If you want to contribute new documentation or fix an error, see the [contribution guidelines](https://github.com/iotaledger/documentation/blob/develop/.github/CONTRIBUTING.md). - -## Share Your Knowledge - -Helping others is an important part of any open source ecosystem. - -By sharing your knowledge with others, you can provide a lot of value to the community and maybe inspire someone else to learn and contribute. - -Take a look at what discussions are going on in the #clients-discussion channel on [Discord](https://discord.iota.org). - -Thanks :heart: diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/explanations/account_approaches.md b/docs/build/wallet.rs/1.0-rc.6/docs/explanations/account_approaches.md deleted file mode 100644 index 9b07af90b69..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/explanations/account_approaches.md +++ /dev/null @@ -1,23 +0,0 @@ -# Account Approaches - -In [wallet.rs](./../welcome.md), you can use an account model -to [create an account for each user](#multi-account-approach) -or [use one account and generate multiple addresses](#single-account-approach), which you can then link to the users in -your database. The wallet library is as flexible as possible and can back up any of your use cases. - -The library supports derivation for multiple accounts from a single seed. An account is simply a deterministic -identifier from which multiple addresses can be further derived. - -The library also allows consumers to assign a meaningful alias to each account. Since addresses are reusable, they can -be mapped to your users in a clear and concise way. - -## Multi-Account Approach - -You should use the multi-account approach if you want to create an account for each individual user. You can link the -accounts to the internal user IDs as an account alias, which are distinctly separated. - -## Single Account Approach - -You should use the single account approach if you want to create a single account and then create an address for each -user. You will need to link the associated addresses to the internal user IDs and store who owns which address in a -database. Most exchanges are familiar with the single account approach and find it easier to use, implement, and backup. diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/explanations/library_overview.md b/docs/build/wallet.rs/1.0-rc.6/docs/explanations/library_overview.md deleted file mode 100644 index beaf195e3f0..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/explanations/library_overview.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -description: 'The wallet library is a stateful package with a standardized interface for developers to build applications -involving IOTA value transactions.' -image: /img/logo/wallet_light.png -keywords: - -- layered overview -- high level -- low level -- stronghold -- value transactions - ---- - -# Library Overview - -The wallet library is a stateful package with a standardized interface for developers to build applications involving -IOTA value transactions. It provides abstractions to handle IOTA payments and can optionally interact -with [IOTA Stronghold enclave](https://github.com/iotaledger/stronghold.rs/) for seed handling, seed storage and state -backup. - -## High Level Layered Overview - -![High Level Layered Overview](/img/overview/iota_layers_overview.svg) - -## The Library in a Nutshell - -`wallet.rs` uses an account model, so you can create an account for each of your users. You could also take another -approach and use one account and generate many addresses, which you can link to your users in your database. - -The library allows users to assign a meaningful alias to each account. Users may also segregate their funds across -multiple accounts or multiple addresses. It is up to a developer whether he chooses a single-account approach or -multi-account approach. - -The library is based on -a [derivation for multiple accounts from a single seed](/introduction/reference/details#addresskey-space). -An account is simply a deterministic identifier from which multiple addresses can be further derived. - -The following image illustrates the relationships between seed, accounts and addresses. A single seed can contain -multiple accounts. Each account can also have multiple addresses which can be linked to users in your database. - -![Seed, accounts and Addresses](/img/libraries/address_generation.svg) diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/getting_started/getting_started.md b/docs/build/wallet.rs/1.0-rc.6/docs/getting_started/getting_started.md deleted file mode 100644 index fb1a544c17c..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/getting_started/getting_started.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -description: Get started with the IOTA Wallet Library and choose your programming language. -image: /img/logo/wallet_light.png -keywords: - - rust - - node.js - - python - - java - - javascript - - wallet - - accounts ---- - -# Getting Started - -You can use this section to get your wallet up and running in -the [programming language of your choice](#available-programming-languages), -[connect to the testnet](#connect-to-the-testnet-api), [explore the network](#explore-the-network), -and [get test tokens](#get-test-tokens) to develop your application. - -## Connect to the Testnet API - -We recommended that you start your interactions with Shimmer on a _testnet_ network. The _testnet_ will allow you to -safely get acquainted with the `wallet.rs` library, without the risk of losing any funds if you make a mistake along the -way. - -You can use this public load-balanced Shimmer Testnet API: - -```plaintext -https://api.testnet.shimmer.network -``` - -## Explore the Network - -You can use the [Shimmer Tangle Explorer](https://explorer.shimmer.network/testnet) to view transactions and data stored -in the Tangle. - -## Get Test Tokens - -In order to properly test value-based transactions on testnet network, you are going to need some tokens. You can get -some testnet tokens through the [Shimmer Faucet](https://faucet.testnet.shimmer.network). - -## Available Programming Languages - -The wallet.rs library is written in [Rust](./rust.mdx), and also has convenient bindings -in [Node.js](./nodejs.mdx), [Java](./java.mdx) and [Python](./python.mdx). Each of these languages has specific -instructions you will need to follow to use wallet.rs in your project. diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/getting_started/java.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/getting_started/java.mdx deleted file mode 100644 index 66dd05e1462..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/getting_started/java.mdx +++ /dev/null @@ -1,244 +0,0 @@ ---- -title: Getting Started With Java -description: Getting started with the official IOTA Wallet Java library. -image: /img/logo/iota_mark_light.png -keywords: - - Java - - jar - - Maven - - Gradle ---- - -import WarningPasswordStorage from '../_admonitions/_password_storage.md'; - - - -# IOTA Wallet Java Library - -Get started with the official IOTA Wallet Java library. - -## Requirements - -minimum Java version >= 8 - -## Use in your Android project (Android Studio) - -1. Download the `iota-wallet-1.0.0-rc.1.jar` file from the [GitHub release](https://github.com/iotaledger/wallet.rs/releases/tag/iota-wallet-java-1.0.0-rc.1-new) and add it as a library to your project. -2. Download the `iota-wallet-1.0.0-rc.1-android.zip` file from the [GitHub release](https://github.com/iotaledger/wallet.rs/releases/tag/iota-wallet-java-1.0.0-rc.1-new), unzip it and add the `jniLibs` folder with its contents to your Android Studio project as shown below: - -``` -project/ -├──src/ - └── main/ - ├── AndroidManifest.xml - ├── java/ - └── jniLibs/ - ├── arm64-v8a/ <-- ARM 64bit - │ └── libiota-wallet.so - │ └── libc++_shared.so - ├── armeabi-v7a/ <-- ARM 32bit - │ └── libiota-wallet.so - │ └── libc++_shared.so - │── x86/ <-- Intel 32bit - │ └── libiota-wallet.so - │ └── libc++_shared.so - └── x86_64/ <-- Intel 64bit - └── libiota-wallet.so - └── libc++_shared.so -``` - -## Use in your Java project (Linux, macOS, Windows) - -Depending on your operating system, add one of the following dependencies to your `build.gradle` file: - -#### linux-x86_64 - -``` -implementation 'org.iota:iota-wallet:1.0.0-rc.1:linux-x86_64' -``` - -#### windows-x86_64 - -``` -implementation 'org.iota:iota-wallet:1.0.0-rc.1:windows-x86_64' -``` - -#### aarch64-apple-darwin - -``` -implementation 'org.iota:iota-wallet:1.0.0-rc.1:aarch64-apple-darwin' -``` - -#### osx-x86_64 - -``` -implementation 'org.iota:iota-wallet:1.0.0-rc.1:osx-x86_64' -``` - -## Use the Library - -In order to use the library, you need to create a `Wallet` instance. -**Note**: Android applications must necessarily configure a suitable storage path for the wallet to avoid problems with file system permissions. Specify a suitable storage path as illustrated below: - -```java -// Copyright 2022 IOTA Stiftung -// SPDX-License-Identifier: Apache-2.0 - -import org.iota.Wallet; -import org.iota.types.AccountHandle; -import org.iota.types.ClientConfig; -import org.iota.types.CoinType; -import org.iota.types.WalletConfig; -import org.iota.types.exceptions.WalletException; -import org.iota.types.secret.StrongholdSecretManager; - -public class CreateAccount { - - private static final String DEFAULT_DEVELOPMENT_MNEMONIC = "hidden enroll proud copper decide negative orient asset speed work dolphin atom unhappy game cannon scheme glow kid ring core name still twist actor"; - - public static void main(String[] args) throws WalletException, InitializeWalletException { - // Set a suitable storage path for the wallet to avoid problems with file system permissions. - // Android applications must necessarily configure this: make sure you replace the ´com.example.myapplication´ with your own app naming. - String storagePath = "/data/data/com.example.myapplication/"; - - // Set up and store the wallet. - Wallet wallet = new Wallet(new WalletConfig() - .withClientOptions(new ClientConfig().withNodes("https://api.testnet.shimmer.network")) - .withSecretManager(new StrongholdSecretManager("PASSWORD_FOR_ENCRYPTION", null, storagePath + "stronghold/vault.stronghold")) - .withCoinType(CoinType.Shimmer) - .withStoragePath(storagePath) - ); - - // Store the mnemonic in the Stronghold vault. - wallet.storeMnemonic(DEFAULT_DEVELOPMENT_MNEMONIC); - - // Create an account. - AccountHandle a = wallet.createAccount("Alice"); - - // Print the account. - System.out.println(a); - } -} -``` - -## What's Next? - -Now that you are up and running, you can get acquainted with the library using -its [how-to guides](../how_tos/run_how_tos.mdx) and the -repository's [code examples](https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src). - -## Instead, build everything from scratch yourself - -If you don't like to use the provided libraries and instead want to build everything yourself from scratch: - -### Build for Android - -Requirements: - -- minimum Java version >= 8 -- Android Studio with NDK -- latest stable version of Rust -- cargo-ndk (https://github.com/bbqsrc/cargo-ndk) - -1. Generate the JAR: - -``` -git clone https://github.com/iotaledger/wallet.rs -cd wallet.rs/bindings/java -./gradlew jarWithoutNativeLibs -``` - -2. You will find the built JAR in the `lib/build/libs` directory. Add it as a library to your Android project. - -3. Install the Android targets you want to support: - -``` - rustup target add aarch64-linux-android armv7-linux-androideabi x86_64-linux-android i686-linux-android -``` - -4. Build the native library for your Android targets: - -``` -cd lib/native -cargo ndk -t arm64-v8a -t armeabi-v7a -t x86 -t x86_64 -o ./jniLibs build --release -``` - -5. On success, you will find the built native libraries in the `jniLibs/` directory like: - -``` -── jniLibs/ - ├── arm64-v8a/ <-- ARM 64bit - │ └── libiota-wallet.so - ├── armeabi-v7a/ <-- ARM 32bit - │ └── libiota-wallet.so - │── x86/ <-- Intel 32bit - │ └── libiota-wallet.so - └── x86_64/ <-- Intel 64bit - └── libiota-wallet.so -``` - -6. Each folder is missing its `libc++_shared.so`. You can find them in the configured Android NDK folder like: - -``` -find $ANDROID_NDK_HOME -name "libc++_shared.so" -``` - -7. Copy the found `libc++_shared.so` files to their respective folder inside the `jniLibs` directory: - -``` -── jniLibs/ - ├── arm64-v8a/ <-- ARM 64bit - │ └── libiota-wallet.so - │ └── libc++_shared.so - ├── armeabi-v7a/ <-- ARM 32bit - │ └── libiota-wallet.so - │ └── libc++_shared.so - │── x86/ <-- Intel 32bit - │ └── libiota-wallet.so - │ └── libc++_shared.so - └── x86_64/ <-- Intel 64bit - └── libiota-wallet.so - └── libc++_shared.so -``` - -8. Add the `jniLibs` folder with its contents to your Android Studio project as shown below: - -``` -project/ -├──src/ - └── main/ - ├── AndroidManifest.xml - ├── java/ - └── jniLibs/ - ├── arm64-v8a/ <-- ARM 64bit - │ └── libiota-wallet.so - │ └── libc++_shared.so - ├── armeabi-v7a/ <-- ARM 32bit - │ └── libiota-wallet.so - │ └── libc++_shared.so - │── x86/ <-- Intel 32bit - │ └── libiota-wallet.so - │ └── libc++_shared.so - └── x86_64/ <-- Intel 64bit - └── libiota-wallet.so - └── libc++_shared.so -``` - -### Build for Linux, macOS, Windows - -Please note, following instructions build the library for your host OS/architecture only. - -Requirements: - -- minimum Java version >= 8 -- latest stable version of Rust - -1. Generate the JAR: - -``` -git clone https://github.com/iotaledger/wallet.rs -cd wallet.rs/bindings/java -./gradlew jar -``` - -2. You will find the built JAR in the `lib/build/libs` directory. Add it as a library to your Java project. diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/getting_started/nodejs.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/getting_started/nodejs.mdx deleted file mode 100644 index ae23da59fa5..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/getting_started/nodejs.mdx +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: Getting Started With Node.js -description: Getting started with the official IOTA Wallet Node.js library. -image: /img/logo/wallet_light.png -keywords: - - Node.js - - dotenv - - install - - npm - - yarn - - security ---- - -import WarningPasswordStorage from '../_admonitions/_password_storage.md'; - - - -The [IOTA Wallet Node.js binding](https://www.npmjs.com/package/@iota/wallet) is published -on [npmjs.com](https://www.npmjs.com/). - -## Requirements - -- Make sure you have fulfilled the [Rust Getting Started](rust.mdx) requirements to compile the binding. - -One of: - -- [npm](https://www.npmjs.com/) -- [Yarn](https://yarnpkg.com/) - -## Install the Library - -The package is published in [npmjs](https://www.npmjs.com/package/@iota/wallet). We also use _dotenv_ for password -management in the examples. - -### npm - -To install with `npm`, you can run the following command: - -```bash -npm install @iota/wallet dotenv -``` - -### yarn - -To install with `yarn`, you can run the following command: - -```bash -yarn install @iota/wallet dotenv -``` - -## Use the Library - -After you have [installed the library](#install-the-library), you can create -a [`AccountManager`](./../references/nodejs/classes/AccountManager.md) -instance and interface with it. - -```javascript -const accountManagerOptions = { - storagePath: './alice-database', - clientOptions: { - nodes: ['https://api.testnet.shimmer.network'], - localPow: true, - }, - coinType: CoinType.Shimmer, - secretManager: { - stronghold: { - snapshotPath: `./wallet.stronghold`, - password: `${process.env.SH_PASSWORD}`, - }, - }, -}; - -const manager = new AccountManager(accountManagerOptions); -``` - -## What's Next? - -Now that you are up and running, you can get acquainted with the library using -its [how-to guides](../how_tos/run_how_tos.mdx) and the -repository's [code examples](https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples). diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/getting_started/python.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/getting_started/python.mdx deleted file mode 100644 index 9ec172a5c09..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/getting_started/python.mdx +++ /dev/null @@ -1,118 +0,0 @@ ---- -title: Getting Started With Python -description: Getting started with the official IOTA Wallet Python library. -image: /img/logo/iota_mark_light.png -keywords: - - Python - - install - - pip - - unpack ---- - -import WarningPasswordStorage from '../_admonitions/_warning_safe_password_storage.md'; - - - -## Requirements - -- [Python 3.x](https://www.python.org) -- [pip](https://pypi.org/project/pip) >= 19.1 -- [setuptools-rust](https://pypi.org/project/setuptools-rust/) >= 0.10.2 -- Make sure you have fulfilled the [Rust Getting Started](rust.mdx) requirements to compile the binding. - -## Install the Library - -### Clone the Repository - -You can clone the [wallet.rs client library](https://github.com/iotaledger/wallet.rs) by running the following command: - -```bash -git clone https://github.com/iotaledger/wallet.rs -``` - -### Change to the Python Binding Directory - -After you have cloned the repository, you should change directory to `wallet.rs/bindings/python`. You can do so -by -running the following command: - -```bash -cd wallet.rs/bindings/python -``` - -#### (optional) Create and use a virtual environment - -If you want to isolate the library from the rest of your system, you can create a virtual environment by running the -following commands: - -```bash -python3 -m venv iota_wallet_venv -``` - -##### Linux and macOS - -```bash -source iota_wallet_venv/bin/activate -``` - -##### Windows - -```bash -.\iota_wallet_venv\Scripts\activate -``` - -### Install the Required Dependencies and Build the Wheel - -Once you have [cloned the library](#clone-the-library), -and [moved to the binding's directory](#change-to-the-python-binding-directory), you should install dependencies and -build the wheel file. - -You can do so by running the following commands: - -```bash -pip install -r requirements-dev.txt -pip install . -``` - -#### (optional) Deactivate the virtual environment - -If you want to deactivate the virtual environment, you should run the following command from the virtual environment: - -```bash -deactivate -``` - -## Use the Library - -After you have [installed the library](#install-the-library), you can create a `IotaWallet` instance and interact with -it. - -```python -from iota_wallet import IotaWallet, StrongholdSecretManager - -# This example creates a new database and account - -client_options = { - 'nodes': ['https://api.testnet.shimmer.network'], -} - -# Shimmer coin type -coin_type = 4219 - -secret_manager = StrongholdSecretManager("wallet.stronghold", "some_hopefully_secure_password") - -wallet = IotaWallet('./alice-database', client_options, coin_type, secret_manager) - -# Store the mnemonic in the Stronghold snapshot, this only needs to be done once -account = wallet.store_mnemonic("flame fever pig forward exact dash body idea link scrub tennis minute " + - "surge unaware prosper over waste kitten ceiling human knife arch situate civil") - -account = wallet.create_account('Alice') -print(account) -``` - -## What's Next? - -Now that you are up and running, you can get acquainted with the library using -its [how-to guides](../how_tos/run_how_tos.mdx) and the -repository's [code examples](https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples). diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/getting_started/rust.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/getting_started/rust.mdx deleted file mode 100644 index 72a4a5cff53..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/getting_started/rust.mdx +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: Getting Started With Rust -description: Getting started with the official IOTA Wallet Rust library. -image: /img/logo/wallet_light.png -keywords: - - Rust - - install - - cargo - - system environment variables ---- - -import WarningPasswordStorage from '../_admonitions/_warning_safe_password_storage.md'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -The wallet.rs library is published on [crates.io](https://crates.io/crates/iota-wallet/versions). You can also download -the source code from the [official GitHub repository](https://github.com/iotaledger/wallet.rs). - -## Requirements - -- [Rust and Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html). - -:::info - -We recommend you update _Rust_ to the latest stable -version [rustup update stable](https://github.com/rust-lang/rustup.rs#keeping-rust-up-to-date). - -::: - -The library uses [_cmake_](https://cmake.org/documentation/) and [_openssl_](https://www.openssl.org/docs/). You may -need install additional build tools on your system to run the build process successfully using Cargo. - - - - -You can install all needed prerequisites on Windows with [Chocolatey](https://community.chocolatey.org/packages?q=msys). If you have any of the tools already installed just remove them from the command - -Install Chocolatey with - -``` -Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1')) -``` - -and install the needed packages with - -``` -choco install visualstudio2022buildtools visualstudio2022-workload-vctools rust-ms msys2 llvm -``` - - - - -You can install _cmake_ and _openssl_ with [_Homebrew_](https://docs.brew.sh/) by running the following commands: - -```bash -brew install cmake -brew install openssl@1.1 -# you may want to add this to your .zshrc or .bashrc since you'll need it to compile the crate -OPENSSL_ROOT_DIR=$(brew --prefix openssl@1.1) -``` - - - - -You can install _cmake_ and _openssl_ with your distro's package manager or download from their websites. On Debian and -Ubuntu you will also need the [_build-essential_](https://packages.debian.org/sid/build-essential) package. - - - - -## Include the Library - -The only thing you need to do to start using the library is to add it as dependency in your `Cargo.toml` file: - -```toml {2} -[dependencies] -iota-wallet = { git = "https://github.com/iotaledger/wallet.rs", branch = "develop" } -tokio = "1.21.2" -``` - -## Use the Library - -In order to use the library, you need to create an `AccountManager`: - - - -```rust reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/examples/01_create_wallet.rs -``` - -## What's Next? - -Now that you are up and running, you can get acquainted with the library using -its [how-to guides](../how_tos/run_how_tos.mdx) and the -repository's [code examples](https://github.com/iotaledger/wallet.rs/tree/develop/wallet/examples). diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/NFT/01_mint_nft.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/NFT/01_mint_nft.mdx deleted file mode 100644 index 37ebd0cea15..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/NFT/01_mint_nft.mdx +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: Mint NFTs -sidebar_label: Mint -description: '' -image: /img/logo/iota_mark_light.png -keywords: - - how to - - nodejs - - python - - java - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import NodejsCode from '../../libraries/nodejs/how_to/NFT/_01_mint_nft/_code_sample.mdx'; -import NodejsOutput from '../../libraries/nodejs/how_to/NFT/_01_mint_nft/_expected_output.md'; -import PythonCode from '../../libraries/python/how_to/NFT/_01_mint_nft/_code_sample.mdx'; -import PythonOutput from '../../libraries/python/how_to/NFT/_01_mint_nft/_expected_output.md'; -import JavaCode from '../../libraries/java/how_to/NFT/_01_mint_nft/_code_sample.mdx'; -import JavaOutput from '../../libraries/java/how_to/NFT/_01_mint_nft/_expected_output.md'; -import RustCode from '../../libraries/rust/how_to/NFT/_01_mint_nft/_code_sample.mdx'; -import RustOutput from '../../libraries/rust/how_to/NFT/_01_mint_nft/_expected_output.md'; -import TipFaucet from '../../_admonitions/_tip_faucet.md'; -import IOTAJsExample from '../../_admonitions/_info_iotajs.mdx'; - - - -You can use a node running the stardust update to mint -[non-fungible tokens (NFTs)](/introduction/stardust/explanations/what_is_stardust/tokenization#non-fungible-tokens-nfts). -To do so, you will only need to [add some funds to your account](../accounts_and_addresses/03_request_funds.mdx), define -the native token's options and call the `Account.mint_nfts(nft_options, options)` function. - - - -## Code Example - -The following example will: - -1. Create an account manager. -2. Get Alice's which was [created in the first guide](../accounts_and_addresses/01_create_a_wallet_account.mdx). -3. Create the `NftOptions`. -4. Mint the NFT by calling the `Account.mint_nfts(nft_options, options)` function. - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/NFT/02_send_nft.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/NFT/02_send_nft.mdx deleted file mode 100644 index 846932a414e..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/NFT/02_send_nft.mdx +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: Send NFTs -sidebar_label: Send -description: 'How to send NFTs using wallet.rs' -image: /img/logo/iota_mark_light.png -keywords: - - how to - - send - - NFT - - send NFT - - nodejs - - python - - java - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import NodejsCode from '../../libraries/nodejs/how_to/NFT/_02_send_nft/_code_sample.mdx'; -import NodejsOutput from '../../libraries/nodejs/how_to/NFT/_02_send_nft/_expected_output.md'; -import PythonCode from '../../libraries/python/how_to/NFT/_02_send_nft/_code_sample.mdx'; -import PythonOutput from '../../libraries/python/how_to/NFT/_02_send_nft/_expected_output.md'; -import JavaCode from '../../libraries/java/how_to/NFT/_02_send_nft/_code_sample.mdx'; -import JavaOutput from '../../libraries/java/how_to/NFT/_02_send_nft/_expected_output.md'; -import RustCode from '../../libraries/rust/how_to/NFT/_02_send_nft/_code_sample.mdx'; -import RustOutput from '../../libraries/rust/how_to/NFT/_02_send_nft/_expected_output.md'; -import ReplaceNFTId from '../../_admonitions/_note_replace_native_token_id.md'; - -After you have [minted](01_mint_nft.mdx) an -[NFT](/introduction/stardust/explanations/what_is_stardust/tokenization#non-fungible-tokens-nfts), -you can easily send it by calling the `Account.send_nft(addresses_nft_ids, options)` function. - -As with any output, you can set a -[storage deposit](/introduction/stardust/explanations/what_is_stardust/storage_deposit) and -[output unlock conditions](/introduction/stardust/explanations/what_is_stardust/unlock_conditions). -Keep in mind that if you set unlock conditions, whoever you send the native tokens to may need to -[claim them](../outputs_and_transactions/04_claim_outputs.mdx). - -## Code Example - - - -The following example will: - -1. Create an account manager. -2. Get Alice's account which was [created in the first guide](../accounts_and_addresses/01_create_a_wallet_account.mdx). -3. Define the type of native token and amount to send. -4. Send the native tokens calling the `Account.send_nft(addresses_nft_ids, options)` function. - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/NFT/03_burn_nft.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/NFT/03_burn_nft.mdx deleted file mode 100644 index 2cd6b4cdd85..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/NFT/03_burn_nft.mdx +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: Burn NFTs -sidebar_label: Burn -description: 'How to burn an NFT using wallet.rs' -image: /img/logo/iota_mark_light.png -keywords: - - how to - - NFT - - burn - - burn NFT - - nodejs - - python - - rust - - java ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import NodejsCode from '../../libraries/nodejs/how_to/NFT/_03_burn_nft/_code_sample.mdx'; -import NodejsOutput from '../../libraries/nodejs/how_to/NFT/_03_burn_nft/_expected_output.md'; -import PythonCode from '../../libraries/python/how_to/NFT/_03_burn_nft/_code_sample.mdx'; -import PythonOutput from '../../libraries/python/how_to/NFT/_03_burn_nft/_expected_output.md'; -import JavaCode from '../../libraries/java/how_to/NFT/_03_burn_nft/_code_sample.mdx'; -import JavaOutput from '../../libraries/java/how_to/NFT/_03_burn_nft/_expected_output.md'; -import RustCode from '../../libraries/rust/how_to/NFT/_03_burn_nft/_code_sample.mdx'; -import RustOutput from '../../libraries/rust/how_to/NFT/_03_burn_nft/_expected_output.md'; -import ReplaceNFTId from '../../_admonitions/_note_replace_native_token_id.md'; - -You may want to burn some of your circulating NFTs. To do so, you will need to call the -`Account.burn_nft(native_token, options)` function. - -## Code Example - - - -The following example will: - -1. Create an account manager. -2. Get Alice's account which was [created in the first guide](../accounts_and_addresses/01_create_a_wallet_account.mdx). -3. [Get the account's balance](../accounts_and_addresses/04_check_balance.mdx). -4. Burn an NFT of the supplied ID. - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/accounts_and_addresses/01_create_a_wallet_account.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/accounts_and_addresses/01_create_a_wallet_account.mdx deleted file mode 100644 index 0b5ee3ace2f..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/accounts_and_addresses/01_create_a_wallet_account.mdx +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: Create a Wallet Account -description: 'How to create a wallet account to start sending value transactions to a Hornet node.' -image: /img/logo/iota_mark_light.png -keywords: - - how to - - create account - - create wallet - - account manager - - multi account approach - - single account approach - - nodejs - - python - - java - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import NodejsCode from '../../libraries/nodejs/how_to/accounts_and_addresses/_01_create_a_wallet_account/_code_sample.mdx'; -import NodejsOutput from '../../libraries/nodejs/how_to/accounts_and_addresses/_01_create_a_wallet_account/_expected_output.md'; -import PythonCode from '../../libraries/python/how_to/accounts_and_addresses/_01_create_a_wallet_account/_code_sample.mdx'; -import PythonOutput from '../../libraries/python/how_to/accounts_and_addresses/_01_create_a_wallet_account/_expected_output.md'; -import JavaCode from '../../libraries/java/how_to/accounts_and_addresses/_01_create_a_wallet_account/_code_sample.mdx'; -import JavaOutput from '../../libraries/java/how_to/accounts_and_addresses/_01_create_a_wallet_account/_expected_output.md'; -import RustCode from '../../libraries/rust/how_to/accounts_and_addresses/_01_create_a_wallet_account/_code_sample.mdx'; -import RustOutput from '../../libraries/rust/how_to/accounts_and_addresses/_01_create_a_wallet_account/_expected_output.md'; -import TipAccountApproaches from '../../_admonitions/_tip_account_approaches.md'; - -The first thing you will need to do when you are getting started with the wallet.rs library is to create a wallet account. - - - -## Code Example - -The following example will: - -1. Create an account manager. -2. Use it to store the [Stronghold](/stronghold.rs/welcome) mnemonic. -3. Create a wallet with the alias "Alice". - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/accounts_and_addresses/02_generate_address.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/accounts_and_addresses/02_generate_address.mdx deleted file mode 100644 index 3c8dfc108e2..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/accounts_and_addresses/02_generate_address.mdx +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: Generate an Address -description: 'How to generate an address for a wallet account.' -image: /img/logo/iota_mark_light.png -keywords: - - how to - - generate address - - generate wallet address - - account manager - - multi account approach - - single account approach - - nodejs - - python - - java - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import NodejsCode from '../../libraries/nodejs/how_to/accounts_and_addresses/_02_generate_address/_code_sample.mdx'; -import NodejsOutput from '../../libraries/nodejs/how_to/accounts_and_addresses/_02_generate_address/_expected_output.md'; -import PythonCode from '../../libraries/python/how_to/accounts_and_addresses/_02_generate_address/_code_sample.mdx'; -import PythonOutput from '../../libraries/python/how_to/accounts_and_addresses/_02_generate_address/_expected_output.md'; -import JavaCode from '../../libraries/java/how_to/accounts_and_addresses/_02_generate_address/_code_sample.mdx'; -import JavaOutput from '../../libraries/java/how_to/accounts_and_addresses/_02_generate_address/_expected_output.md'; -import RustCode from '../../libraries/rust/how_to/accounts_and_addresses/_02_generate_address/_code_sample.mdx'; -import RustOutput from '../../libraries/rust/how_to/accounts_and_addresses/_02_generate_address/_expected_output.md'; -import TipAccountApproaches from '../../_admonitions/_tip_account_approaches.md'; -import IOTAJsExample from '../../_admonitions/_info_iotajs.mdx'; - -After you have [created an account](01_create_a_wallet_account.mdx), you have a single address in the account. But you can generate more addresses. - - - - - -## Code Example - -The following example will: - -1. Create an account manager. -2. Get Alice's account which was [created in the first guide](01_create_a_wallet_account.mdx). -3. Generate an address in Alice's account. - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/accounts_and_addresses/03_request_funds.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/accounts_and_addresses/03_request_funds.mdx deleted file mode 100644 index a6f95ea579f..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/accounts_and_addresses/03_request_funds.mdx +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: Request Funds -description: 'How to programmatically request testnet funds.' -image: /img/logo/iota_mark_light.png -keywords: - - how to - - faucet - - testnet - - test funds - - nodejs - - python - - java - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import NodejsCode from '../../libraries/nodejs/how_to/accounts_and_addresses/_03_request_funds/_code_sample.mdx'; -import NodejsOutput from '../../libraries/nodejs/how_to/accounts_and_addresses/_03_request_funds/_expected_output.md'; -import PythonCode from '../../libraries/python/how_to/accounts_and_addresses/_03_request_funds/_code_sample.mdx'; -import PythonOutput from '../../libraries/python/how_to/accounts_and_addresses/_03_request_funds/_expected_output.md'; -import JavaCode from '../../libraries/java/how_to/accounts_and_addresses/_03_request_funds/_code_sample.mdx'; -import JavaOutput from '../../libraries/java/how_to/accounts_and_addresses/_03_request_funds/_expected_output.md'; -import RustCode from '../../libraries/rust/how_to/accounts_and_addresses/_03_request_funds/_code_sample.mdx'; -import RustOutput from '../../libraries/rust/how_to/accounts_and_addresses/_03_request_funds/_expected_output.md'; -import TipFaucet from '../../_admonitions/_tip_faucet.md'; - -Once you have [created your account](01_create_a_wallet_account.mdx), -you can start using wallet.rs for value transactions. Since these examples target the testnet, you can request funds -using the `request_funds_from_faucet` function. - - - -## Code Example - -The following example will: - -1. Create an account manager. -2. Get Alice's account which was [created in the first guide](01_create_a_wallet_account.mdx). -3. Retrieve an [address](02_generate_address.mdx) related to Alice's account. -4. Request funds to the `FAUCET_URL` you defined in the `.env` file. - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/accounts_and_addresses/04_check_balance.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/accounts_and_addresses/04_check_balance.mdx deleted file mode 100644 index a508e42d5f5..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/accounts_and_addresses/04_check_balance.mdx +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: Check Balance -description: "How to check a wallet account's balance." -image: /img/logo/iota_mark_light.png -keywords: - - how to - - get balance - - check balance - - nodejs - - python - - java - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import WarningUnlockConditions from '../../_admonitions/_warning_unlock_conditions.md'; -import NodejsCode from '../../libraries/nodejs/how_to/accounts_and_addresses/_04_check_balance/_code_sample.mdx'; -import NodejsOutput from '../../libraries/nodejs/how_to/accounts_and_addresses/_04_check_balance/_expected_output.md'; -import PythonCode from '../../libraries/python/how_to/accounts_and_addresses/_04_check_balance/_code_sample.mdx'; -import PythonOutput from '../../libraries/python/how_to/accounts_and_addresses/_04_check_balance/_expected_output.md'; -import JavaCode from '../../libraries/java/how_to/accounts_and_addresses/_04_check_balance/_code_sample.mdx'; -import JavaOutput from '../../libraries/java/how_to/accounts_and_addresses/_04_check_balance/_expected_output.md'; -import RustCode from '../../libraries/rust/how_to/accounts_and_addresses/_04_check_balance/_code_sample.mdx'; -import RustOutput from '../../libraries/rust/how_to/accounts_and_addresses/_04_check_balance/_expected_output.md'; -import TipFaucet from '../../_admonitions/_tip_faucet.md'; - -You can retrieve the balance for any [account you created](01_create_a_wallet_account.mdx) by calling the -`Account.balance()` function. Bear in mind that you should always sync the account with the node to get the latest -transactions. - - - -## Code Example - -The following example will: - -1. Create an account manager. -2. Get Alice's account which was [created in the first guide](01_create_a_wallet_account.mdx). -3. Sync the account with the node to get the latest transactions. -4. Request the account's balance. - - - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/exchange_guide.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/exchange_guide.mdx deleted file mode 100644 index 1e6dae3d587..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/exchange_guide.mdx +++ /dev/null @@ -1,234 +0,0 @@ ---- -description: Easily integrate with your exchange, custody solution, or product using the wallet.rs library. -sidebar_label: Integrate wallet.rs With Your Exchange -keywords: - - integrate - - exchange - - account model - - addresses - - wallet.rs - - setup - - NodeJS - - explanation ---- - -import WarningUnlockConditions from '../_admonitions/_warning_unlock_conditions.md'; - -# Stardust Exchange Integration Guide - -:::note - -You can easily integrate wallet.rs with your exchange, custody solution, or product. - -::: - -:::warning - -Shimmer allows for complex tokenization schemes, but they can lead to monetary losses if used incorrectly. -Transaction outputs may have multiple unlocking conditions which may require returning some or all of the amount, which could expire if not claimed in time, or which may not be unlockable for a very long time. You can lose money if you do not check the unlock conditions before accepting a deposit! - -::: - -## Integration Guide - -This guide explains how to integrate the Wallet library in your exchange. - -Features of the Wallet Library: - -- Secure seed management. -- Account management with multiple accounts and multiple addresses. -- Confirmation monitoring. -- Deposit address monitoring. -- Backup and restore functionality. - -### How Does it Work? - -The Wallet Library is a stateful package with a standardized interface for developers to build applications involving value transactions. It offers abstractions to handle payments and can optionally interact with [Stronghold](/stronghold.rs/getting_started) for seed handling, seed storage, and state backup. - -:::note - -If you are not familiar with the wallet.rs library, you can find more information in the [documentation](../welcome.md). - -::: - -You can use the following examples as a guide to implementing _the multi-account approach_ using the `NodeJS` binding: - -1. [Set up the wallet.rs library](#1-set-up-the-wallet-library). -2. [Create an account for each user](#2-create-an-account-for-a-user). -3. [Generate a user address to deposit funds](#3-generate-a-user-address-to-deposit-funds). -4. [Check the user balance](#4-check-the-account-balance). -5. [Listen to events](#5-listen-to-events). -6. [Enable withdrawals](#6-enable-withdrawals). - -:::note - -If you are looking for other languages, please read the [wallet.rs library overview](./../explanations/library_overview.md). - -::: - -Since all `wallet.rs` bindings are based on core principles provided by the `wallet.rs` library, the outlined approach is very similar regardless of the programming language you choose. - -### 1. Set Up the Wallet.rs Library - -First, you should install the components that are needed to use `wallet.rs` and the binding of your choice; it may vary a bit from language to language. In the case of the [NodeJs binding](./../getting_started/nodejs.mdx), it is straightforward since it is distributed via the `npm` package manager. - -You can read more about [backup and security in this guide](/introduction/how_tos/backup_security). - -```bash -npm install @iota/wallet dotenv -``` - -#### 1 Generate a mnemonic - -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/exchange/0-generate-mnemonic.js -``` - -You can then create a `.env` by running the following command: - -```bash -touch .env -``` - -You can now add your `SH_PASSWORD` and `MNEMONIC` to the `.env` file. - -```bash -SH_PASSWORD="here is your super secure password" -MNEMONIC="here is your super secure 24 word mnemonic, it's only needed here the first time" -``` - -After you have updated the `.env` file, you can initialize the `AccountManager` instance with a secret manager([`Stronghold`](/stronghold.rs/welcome) by default) and client options. - -:::note - -Manage your password with the utmost care. - -::: - -By default, the Stronghold file will be called `wallet.stronghold`. It will store the seed (derived from the mnemonic) that serves as a cryptographic key from which all accounts and related addresses are generated. - -One of the key principles behind the `stronghold` is that no one can get a seed out of it, so you should also back up your 24-word mnemonic in a secure place because there is no way to recover it from the `.stronghold` file. You deal with accounts using the `AccountManager` instance exclusively, where all complexities are hidden under the hood and are dealt with securely. - -:::note - -Keep the `stronghold` password and the `stronghold` database on separate devices. See the [backup and security guide](/introduction/how_tos/backup_security/) for more information. - -::: - -#### 2 Create an account - -You can import the Wallet Library and create an account manager using the following example: - -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/exchange/1-create-account.js -``` - -The `Alias` must be unique and can be whatever fits your use case. The `Alias` is typically used to identify an account later on. Each account is also represented by an `index` which is incremented by one every time a new account is created. You can refer to any account via its `index`, or `alias`. - -You get an instance of any created account using `AccountManager.getAccount(accountId|alias)` or get all accounts with `AccountManager.getAccounts()`. - -Common methods of `account` instance include: - -- `account.addresses()` - returns list of addresses related to the account. -- `account.generateAddress()` - generate a new address for the address index incremented by 1. -- `account.balance()` - returns the balance for the given account. -- `account.sync()` - sync the account information with the tangle. - -### 3. Generate a User Address to Deposit Funds - -`Wallet.rs` is a stateful library. This means it caches all relevant information in storage to provide performance benefits while dealing with, potentially, many accounts and addresses. - -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/exchange/2-generate-address.js -``` - -Every account can have multiple addresses. Addresses are represented by an `index` which is incremented by one every time a new address is created. You can access the addresses using the `account.address()` method: - -```javascript -const addresses = account.addresses(); - -console.log('Need a refill? Send it to this address:', addresses[0]); -``` - -You can use the [Faucet](https://faucet.testnet.shimmer.network/) to add test tokens and test your account. - -There are two types of addresses, `internal` and `public` (external). This approach is known as a _BIP32 Hierarchical Deterministic wallet (HD Wallet)_. - -- Each set of addresses is independent of each other and has an independent `index` id. -- Addresses that are created by `account.generateAddress()` are indicated as `internal=false` (public). -- Internal addresses (`internal=true`) are called `change` addresses and are used to send the excess funds to them. - -### 4. Check the Account Balance - - - -You can get the available account balance across all addresses of the given account using the following example: - -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/exchange/3-check-balance.js -``` - -### 5. Listen to Events - - - -The `Wallet.rs` library supports several events for listening. A provided callback is triggered as soon as an event occurs (which usually happens during syncing). - -You can use the following example to listen to new output events: - -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/exchange/4-listen-events.js -``` - -**Example output:** - -```js -NewOutput: { - output: { - outputId: '0x2df0120a5e0ff2b941ec72dff3464a5b2c3ad8a0c96fe4c87243e4425b9a3fe30000', - metadata: [Object], - output: [Object], - isSpent: false, - address: [Object], - networkId: '1862946857608115868', - remainder: false, - chain: [Array] - }, - transaction: null, - transactionInputs: null -} -``` - -Alternatively you can use `account.outputs()` to get all outputs that are stored in the account, or `account.unspentOutputs()`, to get only unspent outputs. - -### 6. Enable Withdrawals - -You can use the following example to send tokens to an address. - -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/exchange/5-send-amount.js -``` - -The full function signature is `account.sendAmount(outputs[, options])`. - -Default options are fine and successful; however, you can provide additional options, such as `remainderValueStrategy`, which can have the following values: - -- `changeAddress`: Send the remainder value to an internal address. -- `reuseAddress`: Send the remainder value back to its original address. -- `customAddress`: Send the remainder value back to a provided account address. - -```js -TransactionOptions { - remainderValueStrategy?: RemainderValueStrategy; - taggedDataPayload?: ITaggedDataPayload; - customInputs?: string[]; -} -``` - -The `account.sendAmount()` function returns a `transaction` with it's id. The `blockId` can be used later for checking a confirmation status. You can obtain individual transactions related to the given account using the `account.transactions()` function. - -:::note Dust Protection - -When sending tokens, you should consider a [dust protection](https://github.com/muXxer/tips/blob/master/tips/TIP-0019/tip-0019.md) mechanism. - -::: diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/more_examples.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/more_examples.mdx deleted file mode 100644 index 1f005b2fd07..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/more_examples.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: More Examples -description: You can find more usage examples in the official wallet.rs repository. -keywords: - - how to - - more examples - - java - - nodejs - - python - - rust ---- - -You can find more usage examples in the official [wallet.rs repository](https://github.com/iotaledger/wallet.rs/tree/develop/). - -The following links will take to the examples folder for your language of choice: - -- [Rust](https://github.com/iotaledger/wallet.rs/tree/develop/wallet/examples) -- [Node.js](https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples) -- [Python](https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples) diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/01_mint_native_token.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/01_mint_native_token.mdx deleted file mode 100644 index 9bad03382f4..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/01_mint_native_token.mdx +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: Mint Native Tokens -sidebar_label: Mint -description: 'How to mint native tokens using wallet.rs.' -image: /img/logo/iota_mark_light.png -keywords: - - how to - - mint native tokens - - mint - - nodejs - - python - - java - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import NodejsCode from '../../libraries/nodejs/how_to/native_tokens/_01_mint_native_token/_code_sample.mdx'; -import NodejsOutput from '../../libraries/nodejs/how_to/native_tokens/_01_mint_native_token/_expected_output.md'; -import PythonCode from '../../libraries/python/how_to/native_tokens/_01_mint_native_tokens/_code_sample.mdx'; -import PythonOutput from '../../libraries/python/how_to/native_tokens/_01_mint_native_tokens/_expected_output.md'; -import JavaCode from '../../libraries/java/how_to/native_tokens/_01_mint_native_token/_code_sample.mdx'; -import JavaOutput from '../../libraries/java/how_to/native_tokens/_01_mint_native_token/_expected_output.md'; -import RustCode from '../../libraries/rust/how_to/native_tokens/_01_mint_native_tokens/_code_sample.mdx'; -import RustOutput from '../../libraries/rust/how_to/native_tokens/_01_mint_native_tokens/_expected_output.md'; -import TipFaucet from '../../_admonitions/_tip_faucet.md'; - -You can use a node running the stardust update to mint -[native tokens](/introduction/stardust/explanations/what_is_stardust/tokenization#native-tokens). -To do so, you will only need to [add some funds to your account](../accounts_and_addresses/03_request_funds.mdx), define -the native token's options and call the `Account.mint_native_token(native_token_options, options)` function. - - - -## Code Example - -The following example will: - -1. Create an account manager. -2. Get Alice's which was [created in the first guide](../accounts_and_addresses/01_create_a_wallet_account.mdx). -3. Create the `NativeTokenOptions`. -4. Mint the native token by calling the `Account.mint_native_token(native_token_options, options)` function. - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/02_send_native_token.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/02_send_native_token.mdx deleted file mode 100644 index ac14d9d8673..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/02_send_native_token.mdx +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: Send Native Tokens -sidebar_label: Send -description: 'How to send native tokens using wallet.rs.' -image: /img/logo/iota_mark_light.png -keywords: - - how to - - send native token - - send - - native token - - nodejs - - python - - java - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import NodejsCode from '../../libraries/nodejs/how_to/native_tokens/_02_send_native_token/_code_sample.mdx'; -import NodejsOutput from '../../libraries/nodejs/how_to/native_tokens/_02_send_native_token/_expected_output.md'; -import PythonCode from '../../libraries/python/how_to/native_tokens/_02_send_native_tokens/_code_sample.mdx'; -import PythonOutput from '../../libraries/python/how_to/native_tokens/_02_send_native_tokens/_expected_output.md'; -import JavaCode from '../../libraries/java/how_to/native_tokens/_02_send_native_token/_code_sample.mdx'; -import JavaOutput from '../../libraries/java/how_to/native_tokens/_02_send_native_token/_expected_output.md'; -import RustCode from '../../libraries/rust/how_to/native_tokens/_02_send_native_tokens/_code_sample.mdx'; -import RustOutput from '../../libraries/rust/how_to/native_tokens/_02_send_native_tokens/_expected_output.md'; -import ReplaceNativeTokenId from '../../_admonitions/_note_replace_native_token_id.md'; - -After you have [minted](01_mint_native_token.mdx) a -[native tokens](/introduction/stardust/explanations/what_is_stardust/tokenization#native-tokens), -you can easily send it by calling the `Account.send_native_tokens(addresses_native_tokens, options)` function. - -As with any output, you can set a -[storage deposit](/introduction/stardust/explanations/what_is_stardust/storage_deposit) and -[output unlock conditions](/introduction/stardust/explanations/what_is_stardust/unlock_conditions). -Keep in mind that if you set unlock conditions, whoever you send the native tokens to may need to -[claim them](../outputs_and_transactions/04_claim_outputs.mdx). - -## Code Example - - - -The following example will: - -1. Create an account manager. -2. Get Alice's account which was [created in the first guide](../accounts_and_addresses/01_create_a_wallet_account.mdx). -3. Define the type of native token and amount to send. -4. Send the native tokens calling the `Account.send_native_tokens(addresses_native_tokens, options)` function. - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/03_melt_native_token.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/03_melt_native_token.mdx deleted file mode 100644 index d9ec37540c3..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/03_melt_native_token.mdx +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: Melt Native Tokens -sidebar_label: Melt -description: 'How to melt native tokens with wallet.rs' -image: /img/logo/iota_mark_light.png -keywords: - - how to - - melt native token - - foundry - - nodejs - - python - - java - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import NodejsCode from '../../libraries/nodejs/how_to/native_tokens/_03_melt_native_token/_code_sample.mdx'; -import NodejsOutput from '../../libraries/nodejs/how_to/native_tokens/_03_melt_native_token/_expected_output.md'; -import PythonCode from '../../libraries/python/how_to/native_tokens/_03_melt_native_token/_code_sample.mdx'; -import PythonOutput from '../../libraries/python/how_to/native_tokens/_03_melt_native_token/_expected_output.md'; -import JavaCode from '../../libraries/java/how_to/native_tokens/_03_melt_native_token/_code_sample.mdx'; -import JavaOutput from '../../libraries/java/how_to/native_tokens/_03_melt_native_token/_expected_output.md'; -import RustCode from '../../libraries/rust/how_to/native_tokens/_03_melt_native_token/_code_sample.mdx'; -import RustOutput from '../../libraries/rust/how_to/native_tokens/_03_melt_native_token/_expected_output.md'; -import ReplaceNativeTokenId from '../../_admonitions/_note_replace_native_token_id.md'; - -You may want to melt some of your circulating native tokens. To do so, you will need to call the -`Account.melt_native_token(native_token, options)` function. - -If you melt your native tokens, you can still destroy the foundry that created them. - -## Code Example - - - -The following example will: - -1. Create an account manager. -2. Get Alice's account which was [created in the first guide](../accounts_and_addresses/01_create_a_wallet_account.mdx). -3. Get the account's balance. -4. Melt 10 native tokens of the supplied ID. - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/04_burn_native_token.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/04_burn_native_token.mdx deleted file mode 100644 index e33557df592..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/04_burn_native_token.mdx +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: Burn Native Tokens -sidebar_label: Burn -description: 'How to burn native tokens' -image: /img/logo/iota_mark_light.png -keywords: - - how to - - burn - - burn native token - - foundry - - nodejs - - python - - java - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import NodejsCode from '../../libraries/nodejs/how_to/native_tokens/_04_burn_native_token/_code_sample.mdx'; -import NodejsOutput from '../../libraries/nodejs/how_to/native_tokens/_04_burn_native_token/_expected_output.md'; -import PythonCode from '../../libraries/python/how_to/native_tokens/_04_burn_native_token/_code_sample.mdx'; -import PythonOutput from '../../libraries/python/how_to/native_tokens/_04_burn_native_token/_expected_output.md'; -import JavaCode from '../../libraries/java/how_to/native_tokens/_04_burn_native_token/_code_sample.mdx'; -import JavaOutput from '../../libraries/java/how_to/native_tokens/_04_burn_native_token/_expected_output.md'; -import RustCode from '../../libraries/rust/how_to/native_tokens/_04_burn_native_token/_code_sample.mdx'; -import RustOutput from '../../libraries/rust/how_to/native_tokens/_04_burn_native_token/_expected_output.md'; -import ReplaceNativeTokenId from '../../_admonitions/_note_replace_native_token_id.md'; - -You may want to burn some of your circulating native tokens. To do so, you will need to call the -`Account.burn_native_token(native_token, options)` function. - -:::warning - -If you burn your native tokens, you will not be able to destroy the foundry that created them. If you want to destroy -the foundry in the future, you should consider [melting your native tokens](03_melt_native_token.mdx) - -::: - -## Code Example - - - -The following example will: - -1. Create an account manager. -2. Get Alice's account which was [created in the first guide](../accounts_and_addresses/01_create_a_wallet_account.mdx). -3. [Get the account's balance](../accounts_and_addresses/04_check_balance.mdx). -4. Burn 1 native tokens of the supplied ID. - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/05_destroy_foundry.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/05_destroy_foundry.mdx deleted file mode 100644 index 2cafe751b3c..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/05_destroy_foundry.mdx +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: Destroy a Foundry -sidebar_label: Destroy a Foundry -description: 'How to destroy a foundry using wallet.rs.' -image: /img/logo/iota_mark_light.png -keywords: - - how to - - destroy - - destroy foundry - - foundry - - nodejs - - python - - java - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import NodejsCode from '../../libraries/nodejs/how_to/native_tokens/_05_destroy_foundry/_code_sample.mdx'; -import NodejsOutput from '../../libraries/nodejs/how_to/native_tokens/_05_destroy_foundry/_expected_output.md'; -import PythonCode from '../../libraries/python/how_to/native_tokens/_05_destroy_foundry/_code_sample.mdx'; -import PythonOutput from '../../libraries/python/how_to/native_tokens/_05_destroy_foundry/_code_sample.mdx'; -import JavaCode from '../../libraries/java/how_to/native_tokens/_05_destroy_foundry/_code_sample.mdx'; -import JavaOutput from '../../libraries/java/how_to/native_tokens/_05_destroy_foundry/_expected_output.md'; -import RustCode from '../../libraries/rust/how_to/native_tokens/_05_destroy_foundry/_code_sample.mdx'; -import RustOutput from '../../libraries/rust/how_to/native_tokens/_05_destroy_foundry/_expected_output.md'; - -You can destroy a foundry by calling the `Account.destroy_foundry(foundry_id, options)` function. The function will -destroy a foundry output as long as its circulating -[native token](/introduction/stardust/explanations/ledger/foundry) supply is zero. Any native tokens -which were minted by other foundries will be sent to the controlling -[alias](/introduction/stardust/explanations/ledger/alias). - -## Code Example - -Before you run the example you should update the `foundry_id` to one available in your account that has no available -[native tokens](/introduction/stardust/explanations/ledger/foundry). If you have no available -foundries, you can create one by [minting a native token](./01_mint_native_token.mdx). If you've already minted your -tokens but need to empty the foundry, you can decrease your native token supply by [melting them](./03_melt_native_token.mdx). - -The following example will: - -1. Create an account manager. -2. Get Alice's account which was [created in the first guide](../accounts_and_addresses/01_create_a_wallet_account.mdx). -3. [Get the account's balance](./../accounts_and_addresses/04_check_balance.mdx). -4. Destroy a [foundry](/introduction/stardust/explanations/ledger/foundry) output by id. -5. Get the account's balance again to show the difference after step 4. - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/06_destroy_alias_output.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/06_destroy_alias_output.mdx deleted file mode 100644 index 2de66d57f18..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/native_tokens/06_destroy_alias_output.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: Destroy an Alias Output -description: 'How to destroy an alias output using wallet.rs' -image: /img/logo/iota_mark_light.png -keywords: - - how to - - outputs - - destroy - - destroy alias output - - nodejs - - python - - java - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import NodejsCode from '../../_admonitions/_guide_coming_soon.md'; -import NodejsOutput from '../../_admonitions/_guide_coming_soon.md'; -import PythonCode from '../../_admonitions/_guide_coming_soon.md'; -import PythonOutput from '../../_admonitions/_guide_coming_soon.md'; -import JavaCode from '../../libraries/java/how_to/outputs_and_transactions/_06_destroy_alias_output/_code_sample.mdx'; -import JavaOutput from '../../libraries/java/how_to/outputs_and_transactions/_06_destroy_alias_output/_expected_output.md'; -import RustCode from '../../libraries/rust/how_to/outputs_and_transactions/_16_destroy_alias_output/_code_sample.mdx'; -import RustOutput from '../../libraries/rust/how_to/outputs_and_transactions/_16_destroy_alias_output/_expected_output.md'; - -You can destroy an alias output by ID using the `Account.destroy_alias(alias_id, options)` function. If the alias still owns any outputs when you try to destroy it, you will get an error. - -## Code Example - -The following example will: - -1. Create an account manager. -2. Get Alice's account which was [created in the first guide](../accounts_and_addresses/01_create_a_wallet_account.mdx). -3. [Get the account's balance](./../accounts_and_addresses/04_check_balance.mdx). -4. Destroy an [alias output](/introduction/stardust/explanations/ledger/alias) by id. -5. Get the account's balance again to show the difference after step 4. - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/01_send_transaction.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/01_send_transaction.mdx deleted file mode 100644 index b0c4d86cf19..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/01_send_transaction.mdx +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: Send a Transaction -description: 'How to send a value transaction using wallet.rs' -image: /img/logo/iota_mark_light.png -keywords: - - how to - - java - - nodejs - - python - - rust - - java ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import NodejsCode from '../../libraries/nodejs/how_to/outputs_and_transactions/_05_send_transaction/_code_sample.mdx'; -import NodejsOutput from '../../libraries/nodejs/how_to/outputs_and_transactions/_05_send_transaction/_expected_output.md'; -import PythonCode from '../../libraries/python/how_to/outputs_and_transactions/_01_send_transaction/_code_sample.mdx'; -import PythonOutput from '../../libraries/python/how_to/outputs_and_transactions/_01_send_transaction/_expected_output.md'; -import RustCode from '../../libraries/rust/how_to/outputs_and_transactions/_05_send_transaction/_code_sample.mdx'; -import RustOutput from '../../libraries/rust/how_to/outputs_and_transactions/_05_send_transaction/_expected_output.md'; -import JavaCode from '../../libraries/java/how_to/outputs_and_transactions/_01_send_transaction/_code_sample.mdx'; -import JavaOutput from '../../libraries/java/how_to/outputs_and_transactions/_01_send_transaction/_expected_output.md'; -import TipFaucet from '../../_admonitions/_tip_faucet.md'; -import IOTAJsExample from '../../_admonitions/_info_iotajs.mdx'; - -Once you have [created your account](../accounts_and_addresses/01_create_a_wallet_account.mdx) and -[requested funds from the faucet](../accounts_and_addresses/03_request_funds.mdx) you are ready to send your first -transaction. - - - - - -## Code Example - -The following example will: - -1. Create an account manager. -2. Get Alice's account which was [created in the first guide](../accounts_and_addresses/01_create_a_wallet_account.mdx). -3. Send 1 SMR to an address using the `Account.send_amount(addresses_with_amount, options)` function. Make sure to update the code sample to send to the address of your choice. - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/02_send_micro_transaction.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/02_send_micro_transaction.mdx deleted file mode 100644 index 5e344f27958..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/02_send_micro_transaction.mdx +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: Send a Micro Transaction -description: 'How to send a microtransaction using wallet.rs' -image: /img/logo/iota_mark_light.png -keywords: - - how to - - micro-transaction - - send micro-transaction - - microtransaction - - send microtransaction - - nodejs - - python - - java - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import NodejsCode from '../../libraries/nodejs/how_to/outputs_and_transactions/_06_send_micro_transaction/_code_sample.mdx'; -import NodejsOutput from '../../libraries/nodejs/how_to/outputs_and_transactions/_06_send_micro_transaction/_expected_output.md'; -import PythonCode from '../../libraries/python/how_to/outputs_and_transactions/_02_send_micro_transaction/_code_sample.mdx'; -import PythonOutput from '../../libraries/python/how_to/outputs_and_transactions/_02_send_micro_transaction/_expected_output.md'; -import JavaCode from '../../libraries/java/how_to/outputs_and_transactions/_02_send_micro_transaction/_code_sample.mdx'; -import JavaOutput from '../../libraries/java/how_to/outputs_and_transactions/_02_send_micro_transaction/_expected_output.md'; -import RustCode from '../../libraries/rust/how_to/outputs_and_transactions/_06_send_micro_transaction/_code_sample.mdx'; -import RustOutput from '../../libraries/rust/how_to/outputs_and_transactions/_06_send_micro_transaction/_expected_output.md'; -import TipFaucet from '../../_admonitions/_tip_faucet.md'; - -If you need to send an amount below the minimum storage deposit, you should use a microtransaction. - - - -## Code Example - -The following example will: - -1. Create an account manager. -2. Get Alice's account which was [created in the first guide](../accounts_and_addresses/01_create_a_wallet_account.mdx). -3. Create the outputs for a microtransaction. -4. Send the micro-microtransaction using the `Account.send_micro_transaction(addresses_with_micro_amount, options)` function. - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/03_list_outputs.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/03_list_outputs.mdx deleted file mode 100644 index 6db91c51a75..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/03_list_outputs.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: List Outputs -description: 'How to list all the outputs related to an account using wallet.rs.' -image: /img/logo/iota_mark_light.png -keywords: - - how to - - get outputs - - list outputs - - listOutputs - - nodejs - - python - - java - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import WarningUnlockConditions from '../../_admonitions/_warning_unlock_conditions.md'; -import NodejsCode from '../../libraries/nodejs/how_to/outputs_and_transactions/_12a_list_outputs/_code_sample.mdx'; -import NodejsOutput from '../../libraries/nodejs/how_to/outputs_and_transactions/_12a_list_outputs/_expected_output.md'; -import PythonCode from '../../libraries/python/how_to/outputs_and_transactions/_03_list_outputs/_code_sample.mdx'; -import PythonOutput from '../../libraries/python/how_to/outputs_and_transactions/_03_list_outputs/_expected_output.md'; -import JavaCode from '../../libraries/java/how_to/outputs_and_transactions/_03_list_outputs/_code_sample.mdx'; -import JavaOutput from '../../libraries/java/how_to/outputs_and_transactions/_03_list_outputs/_expected_output.md'; -import RustCode from '../../_admonitions/_guide_coming_soon.md'; -import RustOutput from '../../_admonitions/_guide_coming_soon.md'; - -You can list all the outputs related to an account by calling the `Account.outputs()` function. - -## Code Example - -The following example will: - -1. Create an account manager. -2. Get Alice's account which was [created in the first guide](../accounts_and_addresses/01_create_a_wallet_account.mdx). -3. List all the outputs related to Alice's account. - - - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/04_claim_outputs.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/04_claim_outputs.mdx deleted file mode 100644 index e66022f82dc..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/04_claim_outputs.mdx +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: Claim Outputs -description: 'How to send and claim funds with a time-lock using wallet.rs.' -image: /img/logo/iota_mark_light.png -keywords: - - how to - - time-lock - - unlock conditions - - claim output - - send output - - nodejs - - python - - java - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import NodejsCode from '../../libraries/nodejs/how_to/outputs_and_transactions/_21_claim_outputs/_code_sample.mdx'; -import NodejsOutput from '../../libraries/nodejs/how_to/outputs_and_transactions/_21_claim_outputs/_expected_output.md'; -import PythonCode from '../../libraries/python/how_to/outputs_and_transactions/_04_claim_outputs/_code_sample.mdx'; -import PythonOutput from '../../libraries/python/how_to/outputs_and_transactions/_04_claim_outputs/_expected_output.md'; -import JavaCode from '../../libraries/java/how_to/outputs_and_transactions/_04_claim_outputs/_code_sample.mdx'; -import JavaOutput from '../../libraries/java/how_to/outputs_and_transactions/_04_claim_outputs/_expected_output.md'; -import RustCode from '../../_admonitions/_guide_coming_soon.md'; -import RustOutput from '../../_admonitions/_guide_coming_soon.md'; - -You can use wallet.rs to send -[funds with an expiration](/introduction/stardust/explanations/ledger/simple_transfers#transfer-of-funds-with-expiration). -If you don't claim these funds within the expiration period, they will be returned to the sender. - -## Code Example - -The following example will: - -1. Create an account manager. -2. Get Alice's and Bob's account which were [created in the first guide](../accounts_and_addresses/01_create_a_wallet_account.mdx). -3. Prepare and send an output with an _expiration unlock_. -4. Sync Bob's account to get the output event. -5. Claim the output by calling the `account.claimOutputs([outputId])` function from Bob's account. - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/05_list_transactions.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/05_list_transactions.mdx deleted file mode 100644 index a62747b6b4f..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/05_list_transactions.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: List Transactions -description: 'How to list all the transactions related to a wallet.rs account.' -image: /img/logo/iota_mark_light.png -keywords: - - how to - - account - - list transactions - - nodejs - - python - - java - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import NodejsCode from '../../libraries/nodejs/how_to/outputs_and_transactions/_12c_list_transactions/_code_sample.mdx'; -import NodejsOutput from '../../libraries/nodejs/how_to/outputs_and_transactions/_12c_list_transactions/_expected_output.md'; -import PythonCode from '../../libraries/python/how_to/outputs_and_transactions/_05_list_transactions/_code_sample.mdx'; -import PythonOutput from '../../libraries/python/how_to/outputs_and_transactions/_05_list_transactions/_expected_output.md'; -import JavaCode from '../../libraries/java/how_to/outputs_and_transactions/_05_list_transactions/_code_sample.mdx'; -import JavaOutput from '../../libraries/java/how_to/outputs_and_transactions/_05_list_transactions/_expected_output.md'; -import RustCode from '../../_admonitions/_guide_coming_soon.md'; -import RustOutput from '../../_admonitions/_guide_coming_soon.md'; - -You can list all the transactions related to an account by calling the `Account.transactions()` function after you -have instantiated the account. Bear in mind that you will need to call the `Account.sync()` function to get the latest -information from the node. - -## Code Example - -The following example will: - -1. Create an account manager. -2. Get Alice's account which was [created in the first guide](../accounts_and_addresses/01_create_a_wallet_account.mdx). -3. Sync the account to get the latest transactions from the node. -4. List the transactions using the `Account.transactions()` function. - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/06_check_unlock_conditions.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/06_check_unlock_conditions.mdx deleted file mode 100644 index 3c65c63de02..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/outputs_and_transactions/06_check_unlock_conditions.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: Check Unlock Conditions -description: 'How to check unlock conditions of an output.' -image: /img/logo/iota_mark_light.png -keywords: - - how to - - check unlock conditions - - output - - nodejs - - python - - java - - rust ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import NodejsCode from '../../libraries/nodejs/how_to/outputs_and_transactions/_06_check_unlock_conditions/_code_sample.mdx'; -import NodejsOutput from '../../libraries/nodejs/how_to/outputs_and_transactions/_06_check_unlock_conditions/_expected_output.md'; -import PythonCode from '../../libraries/python/how_to/outputs_and_transactions/_06_check_unlock_conditions/_code_sample.mdx'; -import PythonOutput from '../../libraries/python/how_to/outputs_and_transactions/_06_check_unlock_conditions/_expected_output.md'; -import JavaCode from '../../libraries/java/how_to/outputs_and_transactions/_06_check_unlock_conditions/_code_sample.mdx'; -import JavaOutput from '../../libraries/java/how_to/outputs_and_transactions/_06_check_unlock_conditions/_expected_output.md'; -import RustCode from '../../libraries/rust/how_to/outputs_and_transactions/_06_check_unlock_conditions/_code_sample.mdx'; -import RustOutput from '../../libraries/rust/how_to/outputs_and_transactions/_06_check_unlock_conditions/_expected_output.md'; - -Outputs may have multiple [UnlockConditions](/tips/tips/TIP-0018#unlock-conditions), which may require [returning some or all of the transferred amount](/tips/tips/TIP-0018#storage-deposit-return-unlock-condition). The outputs could also [expire if not claimed in time](/tips/tips/TIP-0018#expiration-unlock-condition), or may not be [unlockable for a predefined period](/tips/tips/TIP-0018#timelock-unlock-condition). - -## Code Example - -The following example will: - -1. Create an account manager. -2. Get Alice's account which was [created in the first guide](../accounts_and_addresses/01_create_a_wallet_account.mdx). -3. Check if an output has only an address unlock condition and that the address is from the account. - - - - - - - - - - - - - - - - -## Expected Output - - - - - - - - - - - - - - - diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/run_how_tos.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/run_how_tos.mdx deleted file mode 100644 index 04fead616ce..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/run_how_tos.mdx +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: Run Code Examples -description: 'The wallet.rs has multiple how-to guides to get you up and running in no time. However, these require a -specific set up depending on your language of choice.' -image: /img/logo/iota_mark_light.png -keywords: -- how to -- examples -- npm -- cargo -- yarn -- rust -- nodejs -- python -- java ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import NodejsGetCode from '../libraries/nodejs/how_to/_run_how_tos.mdx'; -import PythonGetCode from '../libraries/python/how_to/_run_how_tos.md'; -import RustGetCode from '../libraries/rust/how_to/_run_how_tos.mdx'; -import JavaGetCode from '../libraries/java/how_to/_run_how_tos.mdx'; -import WarningPasswordStorage from '../_admonitions/_password_storage.md'; - -# Run Code Examples - -You can use the following how-to guides to get acquainted with wallet.rs from creating an account to minting NFTs and -native tokens. - -You can start anywhere, but since the guides may build on previous examples, if you are new to wallet.rs -you should probably start by [creating a wallet account](./accounts_and_addresses/01_create_a_wallet_account.mdx) and then -carry on to the next guide. - -## Requirements - -### Hornet Node - -Most of the examples require a [Hornet Node](/hornet/welcome) running the -[Stardust](/introduction/stardust/welcome) upgrade. You can connect to the -[Shimmer Testnet](#shimmer-testnet), a node you trust, -[run your own node](/hornet/how_tos/using_docker). - -#### Shimmer Testnet - -You can use the following public, load-balanced endpoint to run code examples: - -#### Node URL - -```plaintext -https://api.testnet.shimmer.network -``` - -#### Faucet URL - -```plaintext -https://faucet.testnet.shimmer.network/api/enqueue -``` - -## Language Specific Instructions - -Each language has different set up instructions you need to follow to get the code examples up and running. - - - - - - - - - - - - - - - - - diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/use-python-with-IOTA.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/use-python-with-IOTA.mdx deleted file mode 100644 index 912fff520ca..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/how_tos/use-python-with-IOTA.mdx +++ /dev/null @@ -1,156 +0,0 @@ ---- -title: Use Shimmer Python library together with IOTA Library -description: How to use the Python Shimmer Library together with the IOTA library -keywords: - - Python - - IOTA - - Shimmer ---- - -:::info - -As Python doesn't support using multiple versions of the same library, if you want to use both the Shimmer and IOTA version, you need to build one of them yourself and rename it. - -::: - -In this guide we will show you an Example on how you can install both the IOTA and Shimmer wallet library for usage in the same application. -For that we will build the IOTA wallet library ourselfes and rename it. - -### Install Shimmer Version - -First install the Shimmer version following the [installation guide](/getting_started/python.mdx#install-the-library). - -### Install IOTA Version - -To install the IOTA version you need to follow the [Install from source](/wallet.rs/getting_started/python#install-from-source) guide. -Before you continue with the steps after having cloned the repo, we need to apply some changes to the repo first. - -:::info - -In this guide we will rename the `iota-wallet` to `iota-wallet-production`, but you can use whatever you want. - -::: - -In `wallet/bindings/python/native/Cargo.toml` change both names: - -```diff -[package] -- name = "iota-wallet-python" -+ name = "iota-wallet-production" - version = "0.2.0" - authors = ["IOTA Stiftung"] - edition = "2021" - description = "Python bindings for the IOTA wallet library" - documentation = "/wallet.rs/welcome" - homepage = "https://www.iota.org/" - repository = "https://github.com/iotaledger/wallet.rs" - license = "Apache-2.0" - keywords = ["iota", "wallet", "transaction", "python"] - categories = ["cryptography::cryptocurrencies"] - -[lib] -- name = "iota_wallet" -+ name = "iota_wallet_production" - crate-type = ["cdylib"] - -[dependencies] - . - . - . -``` - -In `wallet/bindings/python/native/setup.py`: - -```diff -setup( -- name="iota_wallet", -+ name="iota_wallet_production", - version="0.2.0", - . - . - . -``` - -And in `wallet/bindings/python/native/src/lib.rs`: - -```diff -/// IOTA Wallet implemented in Rust and binded by Python. -#[pymodule] -- fn iota_wallet(_py: Python, m: &PyModule) -> PyResult<()> { -+ fn iota_wallet_production(_py: Python, m: &PyModule) -> PyResult<()> { - m.add_class::()?; - m.add_class::()?; - m.add_class::()?; - . - . - . -``` - -Now you can continue the installation from [here](/wallet.rs/getting_started/python#change-to-the-python-binding-directory). - -### Usage - -With both libraries installed you can now use them for example like this: - -```python -import json -from dotenv import load_dotenv - -from iota_wallet import IotaWallet as ShimmerWallet, StrongholdSecretManager -import iota_wallet_production as iota_wallet - -# Load the env variables -load_dotenv() - -# Get the stronghold password -STRONGHOLD_PASSWORD = os.getenv('STRONGHOLD_PASSWORD') - -shimmer_client_options = { - 'nodes': ['https://api.testnet.shimmer.network'], -} - -# Shimmer coin type -coin_type = 4219 - -shimmer_secret_manager = StrongholdSecretManager("shimmer-wallet.stronghold", STRONGHOLD_PASSWORD) - -shimmer_wallet = ShimmerWallet('./shimmer-database', shimmer_client_options, coin_type, shimmer_secret_manager) - -# Store the mnemonic in the Stronghold snapshot, this only needs to be done once -shimmer_account = shimmer_wallet.store_mnemonic("flame fever pig forward exact dash body idea link scrub tennis minute " + - "surge unaware prosper over waste kitten ceiling human knife arch situate civil") - -shimmer_account = shimmer_wallet.create_account('Shimmer') -print(f'{shimmer_account["alias"]} account created.') - -iota_account_manager = iota_wallet.AccountManager( - storage_path='./iota-database' -) # note: `storage` and `storage_path` have to be declared together - -iota_account_manager.set_stronghold_password(STRONGHOLD_PASSWORD) - -# mnemonic (seed) should be set only for new storage -# once the storage has been initialized earlier then you should omit this step -iota_account_manager.store_mnemonic("Stronghold") - -# general Tangle specific options -iota_client_options = { - "nodes": [ - { - "url": "https://api.lb-0.h.chrysalis-devnet.iota.cafe/", - "auth": None, - "disabled": False - } - ], - "local_pow": True -} - -# an account is generated with the given alias via `iota_account_initialiser` -iota_account_initialiser = iota_account_manager.create_account(iota_client_options) -iota_account_initialiser.alias('IOTA') - -# initialise account based via `iota_account_initialiser` -# store it to db and sync with Tangle -iota_account = iota_account_initialiser.initialise() -print(f'{iota_account.alias()} account created.') -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_01_mint_nft/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_01_mint_nft/_code_sample.mdx deleted file mode 100644 index c241c8a5a6e..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_01_mint_nft/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src/MintNft.java -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_01_mint_nft/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_01_mint_nft/_expected_output.md deleted file mode 100644 index 1a756122199..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_01_mint_nft/_expected_output.md +++ /dev/null @@ -1,88 +0,0 @@ -```json -{ - "payload": { - "type": 6, - "essence": { - "type": 1, - "networkId": "1856588631910923207", - "inputs": [ - { - "type": 0, - "transactionId": "0xa022ebf66347c966f9b74660b7e65ecf561497a002339d057d91e7390e73fcd6", - "transactionOutputIndex": 2 - } - ], - "inputsCommitment": "0xce87842bfde0a55f96b968f28888c1bf1259b9039498e1060fd8e12015f630a6", - "outputs": [ - { - "type": 6, - "amount": "52000", - "nftId": "0x0000000000000000000000000000000000000000000000000000000000000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - } - ], - "features": [ - { - "type": 2, - "data": "0x5368696d6d65722e20546f6b656e697a652045766572797468696e672e2048656c6c6f2066726f6d20746865204a6176612062696e64696e672e" - } - ] - }, - { - "type": 3, - "amount": "2096582500", - "nativeTokens": [ - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0100000000", - "amount": "0x3233" - }, - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0200000000", - "amount": "0x3233" - }, - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0300000000", - "amount": "0x17" - }, - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0400000000", - "amount": "0x17" - } - ], - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - } - ] - } - ] - }, - "unlocks": [ - { - "type": 0, - "signature": { - "type": 0, - "publicKey": "0xde3152ce9d67415b9c5a042ea01caccc3f73ff1c0c77036874cb8badf9798d56", - "signature": "0x836935b75006582e64d985e346d14ed081aaaa76f6a517cb7528824f87853c1c993fdeb53405c62196539c2cf195c3568571d97b3f57a42f3922b07b98ae3506" - } - } - ] - }, - "blockId": "0xc7d0dedd9e491fabd826365dfb51d5a675b5db61d6891fa024d27f59ba0ba4c2", - "inclusionState": "Pending", - "timestamp": "1664306373802", - "transactionId": "0x87f0eeca7a4fd8706a4f57c5b440c2a1d190254a967e1e678d3e132c9dd44e14", - "networkId": "1856588631910923207", - "incoming": false -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_02_send_nft/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_02_send_nft/_code_sample.mdx deleted file mode 100644 index f9fbdfa1ffb..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_02_send_nft/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src/SendNft.java -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_02_send_nft/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_02_send_nft/_expected_output.md deleted file mode 100644 index 8769eab1f71..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_02_send_nft/_expected_output.md +++ /dev/null @@ -1,57 +0,0 @@ -```json -{ - "payload": { - "type": 6, - "essence": { - "type": 1, - "networkId": "1856588631910923207", - "inputs": [ - { - "type": 0, - "transactionId": "0xd96c9cdf8c6b095f7ab44105f8298c766a7433664db651bfbd7832566d59f103", - "transactionOutputIndex": 0 - } - ], - "inputsCommitment": "0xd64acb6fec68315c200484458fb0a2c1e9b7d06106aecdcb9c86403d955ad69a", - "outputs": [ - { - "type": 6, - "amount": "52000", - "nftId": "0xdbed22679570aecc16da90648836607981e87c1ed3e3a24daf0942aa29a66003", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - } - ], - "features": [ - { - "type": 2, - "data": "0x5368696d6d65722e20546f6b656e697a652045766572797468696e672e2048656c6c6f2066726f6d20746865204a6176612062696e64696e672e" - } - ] - } - ] - }, - "unlocks": [ - { - "type": 0, - "signature": { - "type": 0, - "publicKey": "0xde3152ce9d67415b9c5a042ea01caccc3f73ff1c0c77036874cb8badf9798d56", - "signature": "0xc42fd26b652581e6b2f58ef316b9817830093ae959d716f06c97284fadad72e39838031205d89afa3f0177ae2b1780435945be6a29274a1c66ad47d622cf630b" - } - } - ] - }, - "blockId": "0xa2dc2b45e42ef4c5f847f329faa27ee7b3e50ede0d6b46aeed996f4d74e87b95", - "inclusionState": "Pending", - "timestamp": "1664876443672", - "transactionId": "0xb423ef2155828a4b301795a77357c70bdac76c47f6ee1a20af6a298540fd9b86", - "networkId": "1856588631910923207", - "incoming": false -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_03_burn_nft/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_03_burn_nft/_code_sample.mdx deleted file mode 100644 index 613efe4bba4..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_03_burn_nft/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src/BurnNft.java -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_03_burn_nft/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_03_burn_nft/_expected_output.md deleted file mode 100644 index 7e00d8cf2a7..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/NFT/_03_burn_nft/_expected_output.md +++ /dev/null @@ -1,50 +0,0 @@ -```json -{ - "payload": { - "type": 6, - "essence": { - "type": 1, - "networkId": "1856588631910923207", - "inputs": [ - { - "type": 0, - "transactionId": "0xf5e022f199d90f2020ab941de947368e9d02a4f05139fcb44f66feade216f150", - "transactionOutputIndex": 0 - } - ], - "inputsCommitment": "0xd64acb6fec68315c200484458fb0a2c1e9b7d06106aecdcb9c86403d955ad69a", - "outputs": [ - { - "type": 3, - "amount": "52000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - } - ] - } - ] - }, - "unlocks": [ - { - "type": 0, - "signature": { - "type": 0, - "publicKey": "0xde3152ce9d67415b9c5a042ea01caccc3f73ff1c0c77036874cb8badf9798d56", - "signature": "0xd602074065070b6dada7ce8f5a3c0181a2662443e6e71d7599dcf1464ac04938bdb9b2a39e1f36152cd3226840ab8d63c77d4035a30407ab029b607a7ff4d108" - } - } - ] - }, - "blockId": "0x6bc73ef16d51924154fecf4cc2da1b14297b1aa75ff5261800ab88411185d7c2", - "inclusionState": "Pending", - "timestamp": "1664876190299", - "transactionId": "0x9c26110d611ea78fc0542dca45834abb35497c5ec6045448713f5a588e7f4292", - "networkId": "1856588631910923207", - "incoming": false -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/_more_examples.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/_more_examples.md deleted file mode 100644 index e174e87a6b4..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/_more_examples.md +++ /dev/null @@ -1 +0,0 @@ -More advanced examples can be found in the [examples](https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src) folder. diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/_run_how_tos.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/_run_how_tos.mdx deleted file mode 100644 index a42b6428081..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/_run_how_tos.mdx +++ /dev/null @@ -1,30 +0,0 @@ -## Prerequisites - -Before you can run the examples, please refer to the [Java Getting Started guide](./../../../getting_started/java.mdx) to install -the library - -### Set Up Your .env file - -The code examples use a `.env` file to store variables. You can download -the [example file](https://github.com/iotaledger/wallet.rs/blob/develop/wallet/.env.example) or create a new one with -the following variables: - -```dotenv reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/.env.example -``` - -The `.env.example` uses public [Shimmer Beta](/build/networks-endpoints#public-testnet) -URLS. If you want to use another node, you should update the `NODE_URL` and `FAUCET_URL` values to match the -[Hornet node](#hornet-node) you want to use. - -## Run Code Examples - -The IOTA Wallet Java library has numerous [examples](https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src) -you can run to get acquainted with the library. You can run any example with the following -command from the `examples` directory: - -```bash -.././gradlew run -Pexample=CreateAccount -``` - -To run another example of your choice, replace `CreateAccount` with the name of any other example from the [Java examples directory](https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src). diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_01_create_a_wallet_account/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_01_create_a_wallet_account/_code_sample.mdx deleted file mode 100644 index ffa7cedf35b..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_01_create_a_wallet_account/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src/CreateAccount.java -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_01_create_a_wallet_account/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_01_create_a_wallet_account/_expected_output.md deleted file mode 100644 index db7011c7f41..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_01_create_a_wallet_account/_expected_output.md +++ /dev/null @@ -1,23 +0,0 @@ -```json -{ - "index": 0, - "coinType": 4219, - "alias": "Hans", - "publicAddresses": [ - { - "address": "rms1qpx0mcrqq7t6up73n4na0zgsuuy4p0767ut0qq67ngctj7pg4tm2ynsuynp", - "keyIndex": 0, - "isInternal": false, - "used": false - } - ], - "internalAddresses": [], - "addressesWithUnspentOutputs": [], - "outputs": {}, - "lockedOutputs": [], - "unspentOutputs": {}, - "transactions": {}, - "pendingTransactions": [], - "incomingTransactions": {} -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_02_generate_address/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_02_generate_address/_code_sample.mdx deleted file mode 100644 index fdd0aaf5cc1..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_02_generate_address/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src/GenerateAddress.java -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_02_generate_address/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_02_generate_address/_expected_output.md deleted file mode 100644 index 59b3d74c376..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_02_generate_address/_expected_output.md +++ /dev/null @@ -1,5 +0,0 @@ -``` -rms1qpx0mcrqq7t6up73n4na0zgsuuy4p0767ut0qq67ngctj7pg4tm2ynsuynp -rms1qz8jdgvrerzv35s43pkdkawdr9x4t6xfnhcrt5tlgsyltgpwyx9ks4c5kct -rms1qzjq2jwzp8ddh0gawgdskvtd6awlv82c8y0a9s6g7kgszn6ts95u6r4kx2n -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_03_request_funds/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_03_request_funds/_code_sample.mdx deleted file mode 100644 index d94ecc02e38..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_03_request_funds/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src/RequestFundsFromFaucet.java -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_03_request_funds/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_03_request_funds/_expected_output.md deleted file mode 100644 index 9033a00f755..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_03_request_funds/_expected_output.md +++ /dev/null @@ -1,4 +0,0 @@ -``` -available account balance before faucet request: 0 -available account balance after faucet request: 1000000000 -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_04_check_balance/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_04_check_balance/_code_sample.mdx deleted file mode 100644 index 32dacdc2817..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_04_check_balance/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src/CheckBalance.java -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_04_check_balance/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_04_check_balance/_expected_output.md deleted file mode 100644 index d091ac6fce7..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_04_check_balance/_expected_output.md +++ /dev/null @@ -1,38 +0,0 @@ -```json -{ - "baseCoin": { - "total": "2096947200", - "available": "2096947200" - }, - "requiredStorageDeposit": "323500", - "nativeTokens": [ - { - "tokenId": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0100000000", - "total": "0x3233", - "available": "0x3233" - }, - { - "tokenId": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0200000000", - "total": "0x3233", - "available": "0x3233" - }, - { - "tokenId": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0300000000", - "total": "0x17", - "available": "0x17" - } - ], - "nfts": [ - "0x60b3a254d7704773c298882b7b93f70d12e1cc4a0b91d0b1037f6ea64d76b249", - "0xf95f4d5344217a2ba19a6c19a47f97d267edf8c4d76a7b8c08072ad35acbebbe" - ], - "aliases": [ - "0x429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef" - ], - "foundries": [ - "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0300000000", - "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0100000000" - ], - "potentiallyLockedOutputs": {} -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_05_backup/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_05_backup/_code_sample.mdx deleted file mode 100644 index 000e96c89f4..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_05_backup/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src/Backup.java -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_05_backup/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_05_backup/_expected_output.md deleted file mode 100644 index 06f42f6d0bd..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/accounts_and_addresses/_05_backup/_expected_output.md +++ /dev/null @@ -1,3 +0,0 @@ -```plaintext - -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_01_mint_native_token/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_01_mint_native_token/_code_sample.mdx deleted file mode 100644 index 4d7fd94152f..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_01_mint_native_token/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src/MintNativeToken.java -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_01_mint_native_token/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_01_mint_native_token/_expected_output.md deleted file mode 100644 index 20a526f9b76..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_01_mint_native_token/_expected_output.md +++ /dev/null @@ -1,132 +0,0 @@ -```json -{ - "tokenId": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0800000000", - "transaction": { - "payload": { - "type": 6, - "essence": { - "type": 1, - "networkId": "1856588631910923207", - "inputs": [ - { - "type": 0, - "transactionId": "0x5cf6c0b12f8799cda57e0579a18fcba76722db9bb9b5d10e459489d391b1937a", - "transactionOutputIndex": 0 - }, - { - "type": 0, - "transactionId": "0x5cf6c0b12f8799cda57e0579a18fcba76722db9bb9b5d10e459489d391b1937a", - "transactionOutputIndex": 2 - } - ], - "inputsCommitment": "0xd4f7b69a209e311e525e488c41a6b77ecc895f90ffdd1832ba31556f453fdd18", - "outputs": [ - { - "type": 4, - "amount": "50300", - "aliasId": "0x429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef", - "stateIndex": 13, - "stateMetadata": "0x", - "foundriesCounter": 0, - "unlockConditions": [ - { - "type": 4, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - }, - { - "type": 5, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - } - ] - }, - { - "type": 5, - "amount": "52800", - "serialNumber": 8, - "tokenScheme": { - "type": 0, - "mintedTokens": "0x20", - "meltedTokens": "0x0", - "maximumSupply": "0x45" - }, - "unlockConditions": [ - { - "type": 6, - "address": { - "type": 8, - "aliasId": "0x429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef" - } - } - ] - }, - { - "type": 3, - "amount": "2096320100", - "nativeTokens": [ - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0100000000", - "amount": "0x3233" - }, - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0200000000", - "amount": "0x3233" - }, - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0400000000", - "amount": "0x17" - }, - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0600000000", - "amount": "0x20" - }, - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0700000000", - "amount": "0x20" - }, - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0800000000", - "amount": "0x20" - } - ], - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - } - ] - } - ] - }, - "unlocks": [ - { - "type": 0, - "signature": { - "type": 0, - "publicKey": "0xde3152ce9d67415b9c5a042ea01caccc3f73ff1c0c77036874cb8badf9798d56", - "signature": "0x3c86bda5fd4e4f871a14920f7e630ec0cb8cbe7ccec03637441916b443a44c01ddc927459b6d20613025bd2a9e7f5afafd9cf1b2dbc979b128c6459de26da905" - } - }, - { - "type": 1, - "reference": 0 - } - ] - }, - "blockId": "0xccde79f09a527c755f8cc78132543e58e1a100b19efc2a2ab5acc6525cd660f2", - "inclusionState": "Pending", - "timestamp": "1664896472744", - "transactionId": "0xf323167737a556fcfcfa9da0248fc39aa344c275484a6f224769d2379ca49352", - "networkId": "1856588631910923207", - "incoming": false - } -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_02_send_native_token/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_02_send_native_token/_code_sample.mdx deleted file mode 100644 index daaa5957cfd..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_02_send_native_token/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src/SendNativeToken.java -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_02_send_native_token/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_02_send_native_token/_expected_output.md deleted file mode 100644 index 2c88b238126..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_02_send_native_token/_expected_output.md +++ /dev/null @@ -1,99 +0,0 @@ -```json -{ - "payload": { - "type": 6, - "essence": { - "type": 1, - "networkId": "1856588631910923207", - "inputs": [ - { - "type": 0, - "transactionId": "0x8f83b8c88e396be189d8456a462f67c9806d3acb773fb027bce9027485f6b74d", - "transactionOutputIndex": 1 - } - ], - "inputsCommitment": "0x45643c2e9481d7d8645881f976280e414239691fe562ad56823867c4dd25d5d6", - "outputs": [ - { - "type": 3, - "amount": "57600", - "nativeTokens": [ - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0300000000", - "amount": "0x17" - } - ], - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - }, - { - "type": 1, - "returnAddress": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - }, - "amount": "57600" - }, - { - "type": 3, - "returnAddress": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - }, - "unixTime": 1664884308 - } - ] - }, - { - "type": 3, - "amount": "2096368900", - "nativeTokens": [ - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0100000000", - "amount": "0x3233" - }, - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0200000000", - "amount": "0x3233" - }, - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0400000000", - "amount": "0x17" - } - ], - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - } - ] - } - ] - }, - "unlocks": [ - { - "type": 0, - "signature": { - "type": 0, - "publicKey": "0xde3152ce9d67415b9c5a042ea01caccc3f73ff1c0c77036874cb8badf9798d56", - "signature": "0x136ebfea089a7cfd3b5fdae595a53acb54b19a2483eb3dcf76b852169a2d4e16d4331e1c95f6654488150beacbd7bef033be605207139b33c385822fd09a2a03" - } - } - ] - }, - "blockId": "0x5227e054723e38dcc86df357cfd1b4715fd622fb7a2a3702931295a4b432bc46", - "inclusionState": "Pending", - "timestamp": "1664884309679", - "transactionId": "0x68454a9dbf31790aa072910a1caa0d3b32cc9ab89c476219a7d184a6dffbcc5c", - "networkId": "1856588631910923207", - "incoming": false -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_03_melt_native_token/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_03_melt_native_token/_code_sample.mdx deleted file mode 100644 index 9d583c531b0..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_03_melt_native_token/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src/MeltNativeToken.java -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_03_melt_native_token/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_03_melt_native_token/_expected_output.md deleted file mode 100644 index 0bf63cc9987..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_03_melt_native_token/_expected_output.md +++ /dev/null @@ -1,118 +0,0 @@ -```json -{ - "payload": { - "type": 6, - "essence": { - "type": 1, - "networkId": "1856588631910923207", - "inputs": [ - { - "type": 0, - "transactionId": "0xbd9dc768e5676e9d141ab96622143127328c10361f319f919365c480972dbe83", - "transactionOutputIndex": 0 - }, - { - "type": 0, - "transactionId": "0xbd9dc768e5676e9d141ab96622143127328c10361f319f919365c480972dbe83", - "transactionOutputIndex": 1 - }, - { - "type": 0, - "transactionId": "0xbd9dc768e5676e9d141ab96622143127328c10361f319f919365c480972dbe83", - "transactionOutputIndex": 2 - } - ], - "inputsCommitment": "0xaea8c0e6b4af1afb241b9d4b850b54438dff3e5dfe36a54f1bbaccdc81d1b245", - "outputs": [ - { - "type": 4, - "amount": "50300", - "aliasId": "0x429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef", - "stateIndex": 6, - "stateMetadata": "0x", - "foundriesCounter": 0, - "unlockConditions": [ - { - "type": 4, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - }, - { - "type": 5, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - } - ] - }, - { - "type": 5, - "amount": "52800", - "serialNumber": 3, - "tokenScheme": { - "type": 0, - "mintedTokens": "0x17", - "meltedTokens": "0x2", - "maximumSupply": "0x64" - }, - "unlockConditions": [ - { - "type": 6, - "address": { - "type": 8, - "aliasId": "0x429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef" - } - } - ] - }, - { - "type": 3, - "amount": "57600", - "nativeTokens": [ - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0300000000", - "amount": "0x15" - } - ], - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - } - ] - } - ] - }, - "unlocks": [ - { - "type": 0, - "signature": { - "type": 0, - "publicKey": "0xde3152ce9d67415b9c5a042ea01caccc3f73ff1c0c77036874cb8badf9798d56", - "signature": "0xc9c5369388d5fce9297c816612af93eea35b34d1fd4575de9b5ba5f477186e84f2affe6a2ba230beb1d47e3e5ee31f20d484a857e9c3d18fe0fe5e334d6f1202" - } - }, - { - "type": 2, - "reference": 0 - }, - { - "type": 1, - "reference": 0 - } - ] - }, - "blockId": "0x063c35701e459cb6515cd0be7d0ed691fd622f5a2dc3bb126213a4f06910ab54", - "inclusionState": "Pending", - "timestamp": "1664885556280", - "transactionId": "0xcbcfbbd9b36bd9a3d6830311ed428036d13fc37050bcd1cf82fb4e4b695570fd", - "networkId": "1856588631910923207", - "incoming": false -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_04_burn_native_token/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_04_burn_native_token/_code_sample.mdx deleted file mode 100644 index c46ab9ede9e..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_04_burn_native_token/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src/BurnNativeToken.java -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_04_burn_native_token/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_04_burn_native_token/_expected_output.md deleted file mode 100644 index b11cd764dca..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_04_burn_native_token/_expected_output.md +++ /dev/null @@ -1,56 +0,0 @@ -```json -{ - "payload": { - "type": 6, - "essence": { - "type": 1, - "networkId": "1856588631910923207", - "inputs": [ - { - "type": 0, - "transactionId": "0xcbcfbbd9b36bd9a3d6830311ed428036d13fc37050bcd1cf82fb4e4b695570fd", - "transactionOutputIndex": 2 - } - ], - "inputsCommitment": "0x3f44d0e0f31bd57f028d80d8c9b07b0e12406e6cd5b2e8b6ed0abd178a1e1b1b", - "outputs": [ - { - "type": 3, - "amount": "57600", - "nativeTokens": [ - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0300000000", - "amount": "0x10" - } - ], - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - } - ] - } - ] - }, - "unlocks": [ - { - "type": 0, - "signature": { - "type": 0, - "publicKey": "0xde3152ce9d67415b9c5a042ea01caccc3f73ff1c0c77036874cb8badf9798d56", - "signature": "0xfd9964cdcfa6bda25419968c3d74d29e35611bbc2a9ddad2be0eadc816da270fcf739c2e7ecc4be4e46f33b32aa37370534e0ee322c23755ecb608de9618ae0a" - } - } - ] - }, - "blockId": "0xb53140f385372ca247d7d66ee14755a2e18d8ca750fd85122a6b5b6b0c1abf7c", - "inclusionState": "Pending", - "timestamp": "1664885731096", - "transactionId": "0xbb7f884e81ed32dbfe4f9c880b0f6577c9c90744b7ab33d84950706d2924c18c", - "networkId": "1856588631910923207", - "incoming": false -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_05_destroy_foundry/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_05_destroy_foundry/_code_sample.mdx deleted file mode 100644 index e323fdf7300..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_05_destroy_foundry/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src/DestroyFoundry.java -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_05_destroy_foundry/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_05_destroy_foundry/_expected_output.md deleted file mode 100644 index e2727972817..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/native_tokens/_05_destroy_foundry/_expected_output.md +++ /dev/null @@ -1,70 +0,0 @@ -```json -{ - "payload": { - "type": 6, - "essence": { - "type": 1, - "networkId": "1856588631910923207", - "inputs": [ - { - "type": 0, - "transactionId": "0x27df04eac1408b4ec758f6aa222d616b21d9b237789e601d9d0b81aa6466fa97", - "transactionOutputIndex": 0 - }, - { - "type": 0, - "transactionId": "0x27df04eac1408b4ec758f6aa222d616b21d9b237789e601d9d0b81aa6466fa97", - "transactionOutputIndex": 1 - } - ], - "inputsCommitment": "0x06e8bdc8ddf5dac739e620f815aade7f73d06a33a911e1e6956d1f8d087ad6e3", - "outputs": [ - { - "type": 4, - "amount": "103100", - "aliasId": "0x429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef", - "stateIndex": 9, - "stateMetadata": "0x", - "foundriesCounter": 0, - "unlockConditions": [ - { - "type": 4, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - }, - { - "type": 5, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - } - ] - } - ] - }, - "unlocks": [ - { - "type": 0, - "signature": { - "type": 0, - "publicKey": "0xde3152ce9d67415b9c5a042ea01caccc3f73ff1c0c77036874cb8badf9798d56", - "signature": "0xb0a0473eb7dc09231707b11a04ad3a2fee9d67dd83f00e27ddbdc11f4473080ff8ac9a78d5dfb83da8bf1e8e77dc5c6cd867a28dc7520dc0f01dd49ce7815a02" - } - }, - { - "type": 2, - "reference": 0 - } - ] - }, - "blockId": "0xf76fc85a74e1ac5381ff25777fef8a1c9ffb98bdad83157151bc8804bf496861", - "inclusionState": "Pending", - "timestamp": "1664886716685", - "transactionId": "0xce5504e02bf0796e48143d5daa1753500e798dbab673e14bb671512750f7d03a", - "networkId": "1856588631910923207", - "incoming": false -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_01_send_transaction/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_01_send_transaction/_code_sample.mdx deleted file mode 100644 index e9c42f2f6e3..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_01_send_transaction/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src/SendAmount.java -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_01_send_transaction/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_01_send_transaction/_expected_output.md deleted file mode 100644 index ab309cc0fb5..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_01_send_transaction/_expected_output.md +++ /dev/null @@ -1,77 +0,0 @@ -```json -{ - "payload": { - "type": 6, - "essence": { - "type": 1, - "networkId": "1856588631910923207", - "inputs": [ - { - "type": 0, - "transactionId": "0xd27ce4f6e398e9681d6e707ad2b7bc8c99183ede6a448741a1ece7036beadfbe", - "transactionOutputIndex": 0 - } - ], - "inputsCommitment": "0x8fb5d5215f674fb0f9633b8854efb5ecccb4293489571dc611fc7cf03d95f43e", - "outputs": [ - { - "type": 3, - "amount": "1000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x60200bad8137a704216e84f8f9acfe65b972d9f4155becb4815282b03cef99fe" - } - } - ] - }, - { - "type": 3, - "amount": "2096687300", - "nativeTokens": [ - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0100000000", - "amount": "0x3233" - }, - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0200000000", - "amount": "0x3233" - }, - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0300000000", - "amount": "0x17" - } - ], - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - } - ] - } - ] - }, - "unlocks": [ - { - "type": 0, - "signature": { - "type": 0, - "publicKey": "0xde3152ce9d67415b9c5a042ea01caccc3f73ff1c0c77036874cb8badf9798d56", - "signature": "0x7b6f589fd0110e50130962c1674cf0bc23e73dd256618daa414249ad0d20c5a7e2ebc7d2e87e5a3049dab0a3657f0b4439e8b051f97cb8dbfe69f173106a1b07" - } - } - ] - }, - "blockId": "0x67bb313da84f73c52e4c6e558249a6c334ec672bb64a9192b5e6c8b6e9d09b97", - "inclusionState": "Pending", - "timestamp": "1664304732407", - "transactionId": "0x57aba1c7060c577f4404692e673910fa05dadf30e09a1cbc6aad2439628011e1", - "networkId": "1856588631910923207", - "incoming": false -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_02_send_micro_transaction/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_02_send_micro_transaction/_code_sample.mdx deleted file mode 100644 index bb40f04d3c5..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_02_send_micro_transaction/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src/SendMicroTransaction.java -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_02_send_micro_transaction/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_02_send_micro_transaction/_expected_output.md deleted file mode 100644 index 13e87346861..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_02_send_micro_transaction/_expected_output.md +++ /dev/null @@ -1,126 +0,0 @@ -```json -{ - "payload": { - "type": 6, - "essence": { - "type": 1, - "networkId": "1856588631910923207", - "inputs": [ - { - "type": 0, - "transactionId": "0xce5504e02bf0796e48143d5daa1753500e798dbab673e14bb671512750f7d03a", - "transactionOutputIndex": 0 - }, - { - "type": 0, - "transactionId": "0x27df04eac1408b4ec758f6aa222d616b21d9b237789e601d9d0b81aa6466fa97", - "transactionOutputIndex": 2 - } - ], - "inputsCommitment": "0x01a6a0ee6942ce4fd0196c1d54db56eb44cd6b983505bede16b6b5b9d0b4f835", - "outputs": [ - { - "type": 3, - "amount": "50601", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - }, - { - "type": 1, - "returnAddress": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - }, - "amount": "50600" - }, - { - "type": 3, - "returnAddress": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - }, - "unixTime": 1664887368 - } - ] - }, - { - "type": 4, - "amount": "50300", - "aliasId": "0x429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef", - "stateIndex": 10, - "stateMetadata": "0x", - "foundriesCounter": 0, - "unlockConditions": [ - { - "type": 4, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - }, - { - "type": 5, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - } - ] - }, - { - "type": 3, - "amount": "2096427899", - "nativeTokens": [ - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0100000000", - "amount": "0x3233" - }, - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0200000000", - "amount": "0x3233" - }, - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0400000000", - "amount": "0x17" - } - ], - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - } - ] - } - ] - }, - "unlocks": [ - { - "type": 0, - "signature": { - "type": 0, - "publicKey": "0xde3152ce9d67415b9c5a042ea01caccc3f73ff1c0c77036874cb8badf9798d56", - "signature": "0x114f1c0ad726278b2d5167cb1b112529aa63cc0e3cf01c7936151f968050ff20a3d1385f708c36bd3761c38ddcba8ce735258ab5bd9cc1afa42510ddf6102e03" - } - }, - { - "type": 1, - "reference": 0 - } - ] - }, - "blockId": "0x8f9f12a968c32cc3d51e978f4de34252bc769ee7188e33a21f9351a7c1f122f3", - "inclusionState": "Pending", - "timestamp": "1664887369004", - "transactionId": "0xaccae1f4e78ee169d0fc1d99843e6cd417290da91aa62c696fa507d21fd245cc", - "networkId": "1856588631910923207", - "incoming": false -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_03_list_outputs/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_03_list_outputs/_code_sample.mdx deleted file mode 100644 index e5a370e3b6f..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_03_list_outputs/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src/ListOutputs.java -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_03_list_outputs/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_03_list_outputs/_expected_output.md deleted file mode 100644 index 8d4a3fb4c72..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_03_list_outputs/_expected_output.md +++ /dev/null @@ -1,285 +0,0 @@ -```json -{ - "outputId":"0xb23dc6681903672b76aae4f74c405fcd684c6fcf5d21fc367addcbafd0c3770c1a00", - "metadata":{ - "blockId":"0xcfb891e37d261bf48381ec5fd7a6957396ce9296dab35d8111cc8bb4369dc2cd", - "transactionId":"0xb23dc6681903672b76aae4f74c405fcd684c6fcf5d21fc367addcbafd0c3770c", - "outputIndex":26, - "isSpent":false, - "milestoneIndexBooked":831306, - "milestoneTimestampBooked":1662290619, - "ledgerIndex":1351681 - }, - "output":{ - "type":3, - "amount":"50600", - "unlockConditions":[ - { - "type":0, - "address":{ - "type":0, - "pubKeyHash":"0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - }, - { - "type":1, - "returnAddress":{ - "type":0, - "pubKeyHash":"0x8297ac4149c80cca8225e5f2da36df89a93cd2998d7f6d488c97250a881e65af" - }, - "amount":"50600" - }, - { - "type":3, - "returnAddress":{ - "type":0, - "pubKeyHash":"0x8297ac4149c80cca8225e5f2da36df89a93cd2998d7f6d488c97250a881e65af" - }, - "unixTime":1662895377 - } - ] - }, - "isSpent":false, - "address":{ - "type":0, - "pubKeyHash":"0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - }, - "networkId":"1856588631910923207", - "remainder":false, - "chain":[ - { - "hardened":true, - "bs":[ - 128, - 0, - 0, - 44 - ] - }, - { - "hardened":true, - "bs":[ - 128, - 0, - 16, - 123 - ] - }, - { - "hardened":true, - "bs":[ - 128, - 0, - 0, - 0 - ] - }, - { - "hardened":true, - "bs":[ - 128, - 0, - 0, - 0 - ] - }, - { - "hardened":true, - "bs":[ - 128, - 0, - 0, - 0 - ] - } - ] -} -{ - "outputId":"0x94f6bdabbfc0b3f39961ffe7a19c3a26fde2908cce6b879beb4c20ed27cdad420000", - "metadata":{ - "blockId":"0x6079cabb638789187cb372d521c033afdf15f52093cc1b922330fe81bb3574d3", - "transactionId":"0x94f6bdabbfc0b3f39961ffe7a19c3a26fde2908cce6b879beb4c20ed27cdad42", - "outputIndex":0, - "isSpent":false, - "milestoneIndexBooked":1350472, - "milestoneTimestampBooked":1664887705, - "ledgerIndex":1351681 - }, - "output":{ - "type":3, - "amount":"50601", - "unlockConditions":[ - { - "type":0, - "address":{ - "type":0, - "pubKeyHash":"0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - }, - { - "type":1, - "returnAddress":{ - "type":0, - "pubKeyHash":"0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - }, - "amount":"50600" - }, - { - "type":3, - "returnAddress":{ - "type":0, - "pubKeyHash":"0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - }, - "unixTime":1664887701 - } - ] - }, - "isSpent":false, - "address":{ - "type":0, - "pubKeyHash":"0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - }, - "networkId":"1856588631910923207", - "remainder":false, - "chain":[ - { - "hardened":true, - "bs":[ - 128, - 0, - 0, - 44 - ] - }, - { - "hardened":true, - "bs":[ - 128, - 0, - 16, - 123 - ] - }, - { - "hardened":true, - "bs":[ - 128, - 0, - 0, - 0 - ] - }, - { - "hardened":true, - "bs":[ - 128, - 0, - 0, - 0 - ] - }, - { - "hardened":true, - "bs":[ - 128, - 0, - 0, - 0 - ] - } - ] -} -{ - "outputId":"0xaccae1f4e78ee169d0fc1d99843e6cd417290da91aa62c696fa507d21fd245cc0200", - "metadata":{ - "blockId":"0x8f9f12a968c32cc3d51e978f4de34252bc769ee7188e33a21f9351a7c1f122f3", - "transactionId":"0xaccae1f4e78ee169d0fc1d99843e6cd417290da91aa62c696fa507d21fd245cc", - "outputIndex":2, - "isSpent":false, - "milestoneIndexBooked":1350405, - "milestoneTimestampBooked":1664887370, - "ledgerIndex":1351681 - }, - "output":{ - "type":3, - "amount":"2096427899", - "nativeTokens":[ - { - "id":"0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0100000000", - "amount":"0x3233" - }, - { - "id":"0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0200000000", - "amount":"0x3233" - }, - { - "id":"0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0400000000", - "amount":"0x17" - } - ], - "unlockConditions":[ - { - "type":0, - "address":{ - "type":0, - "pubKeyHash":"0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - } - ] - }, - "isSpent":false, - "address":{ - "type":0, - "pubKeyHash":"0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - }, - "networkId":"1856588631910923207", - "remainder":false, - "chain":[ - { - "hardened":true, - "bs":[ - 128, - 0, - 0, - 44 - ] - }, - { - "hardened":true, - "bs":[ - 128, - 0, - 16, - 123 - ] - }, - { - "hardened":true, - "bs":[ - 128, - 0, - 0, - 0 - ] - }, - { - "hardened":true, - "bs":[ - 128, - 0, - 0, - 0 - ] - }, - { - "hardened":true, - "bs":[ - 128, - 0, - 0, - 0 - ] - } - ] -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_04_claim_outputs/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_04_claim_outputs/_code_sample.mdx deleted file mode 100644 index f763f3bb334..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_04_claim_outputs/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src/ClaimOutputs.java -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_04_claim_outputs/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_04_claim_outputs/_expected_output.md deleted file mode 100644 index 98602a0c116..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_04_claim_outputs/_expected_output.md +++ /dev/null @@ -1,50 +0,0 @@ -```json -{ - "payload": { - "type": 6, - "essence": { - "type": 1, - "networkId": "1856588631910923207", - "inputs": [ - { - "type": 0, - "transactionId": "0xeb572c09b9cdf4e29c65ecbe10c06d484c04d33da3bea6d9bb1653aa6617e845", - "transactionOutputIndex": 0 - } - ], - "inputsCommitment": "0x4ef5a27871871d370f7bcf41b783f6b1c44221b228624e74c760923dac9efe99", - "outputs": [ - { - "type": 3, - "amount": "1000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - } - ] - } - ] - }, - "unlocks": [ - { - "type": 0, - "signature": { - "type": 0, - "publicKey": "0xde3152ce9d67415b9c5a042ea01caccc3f73ff1c0c77036874cb8badf9798d56", - "signature": "0xa0ec431d1272d27147809b6178b0e69760de49e7d8f78122cc255362e48f1500345968c0500e07f7b01d35b836c22613c56667e59510b02480c5b257ff74ef04" - } - } - ] - }, - "blockId": "0x4090b35d0a819b291201e09308eba4a39ffc3cffe2127dae4a29e1e78af64aec", - "inclusionState": "Pending", - "timestamp": "1664900613290", - "transactionId": "0x4893b9813145001e67fe89394c2e9464c9a2d07dea1536d36beb83258e5aa1c0", - "networkId": "1856588631910923207", - "incoming": false -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_05_list_transactions/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_05_list_transactions/_code_sample.mdx deleted file mode 100644 index 297745b487a..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_05_list_transactions/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src/ListTransactions.java -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_05_list_transactions/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_05_list_transactions/_expected_output.md deleted file mode 100644 index a55ac5d1d0f..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_05_list_transactions/_expected_output.md +++ /dev/null @@ -1,63 +0,0 @@ -```json -{ - "outputId": "0xd96c9cdf8c6b095f7ab44105f8298c766a7433664db651bfbd7832566d59f1030000", - "metadata": { - "blockId": "0xf56489d9df639ab25e9a72070c4bb5409a8818ccdb5718125538e792f2f27e99", - "transactionId": "0xd96c9cdf8c6b095f7ab44105f8298c766a7433664db651bfbd7832566d59f103", - "outputIndex": 0, - "isSpent": false, - "milestoneIndexBooked": 1235250, - "milestoneTimestampBooked": 1664311584, - "ledgerIndex": 1244051 - }, - "output": { - "type": 6, - "amount": "52000", - "nftId": "0x0000000000000000000000000000000000000000000000000000000000000000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - } - ], - "features": [ - { - "type": 2, - "data": "0x5368696d6d65722e20546f6b656e697a652045766572797468696e672e2048656c6c6f2066726f6d20746865204a6176612062696e64696e672e" - } - ] - }, - "isSpent": false, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - }, - "networkId": "1856588631910923207", - "remainder": false, - "chain": [ - { - "hardened": true, - "bs": [128, 0, 0, 44] - }, - { - "hardened": true, - "bs": [128, 0, 16, 123] - }, - { - "hardened": true, - "bs": [128, 0, 0, 0] - }, - { - "hardened": true, - "bs": [128, 0, 0, 0] - }, - { - "hardened": true, - "bs": [128, 0, 0, 0] - } - ] -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_06_check_unlock_conditions/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_06_check_unlock_conditions/_code_sample.mdx deleted file mode 100644 index f71a4daa0eb..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_06_check_unlock_conditions/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```java reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src/CheckUnlockConditions.java -``` - -You can run the example by running the following command from the `wallet/bindings/java/` folder: - -```bash -./gradlew run -Pexample=CheckUnlockConditions -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_06_check_unlock_conditions/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_06_check_unlock_conditions/_expected_output.md deleted file mode 100644 index f5ac0d3257b..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_06_check_unlock_conditions/_expected_output.md +++ /dev/null @@ -1,3 +0,0 @@ -``` -The output has only an address unlock condition and the address is from the account: true -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_06_destroy_alias_output/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_06_destroy_alias_output/_code_sample.mdx deleted file mode 100644 index 085c198bed1..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_06_destroy_alias_output/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```java reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/java/examples/src/DestroyAliasOutput.java -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_06_destroy_alias_output/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_06_destroy_alias_output/_expected_output.md deleted file mode 100644 index a32bba5d5fc..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/java/how_to/outputs_and_transactions/_06_destroy_alias_output/_expected_output.md +++ /dev/null @@ -1,50 +0,0 @@ -```json -{ - "payload": { - "type": 6, - "essence": { - "type": 1, - "networkId": "1856588631910923207", - "inputs": [ - { - "type": 0, - "transactionId": "0xef3c9f8e8179e133f8207f3933039eaaf601f1f260b6116d7ca7c6711baa91a8", - "transactionOutputIndex": 0 - } - ], - "inputsCommitment": "0xebda3754c942e47e7dd0e9177ad24c2985b4db98009a58ee2417e69695c8afc5", - "outputs": [ - { - "type": 3, - "amount": "103100", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0xcb89e7952f758942e4e623708ebd1512e11bd5b39abc53f082ef8a9c20ac760a" - } - } - ] - } - ] - }, - "unlocks": [ - { - "type": 0, - "signature": { - "type": 0, - "publicKey": "0x8deb59df30fdd61349c20987179b5e0268e34338f37841b816f62e66820dae6c", - "signature": "0x0740d0b4435c25c0b57d579c90d2dd1a197b18b95a9784a1fc04ce51e63b2f93f680ec3568751a8cae09eaf3f5ee4fad2543f3a6ada14501af091d94d103a70f" - } - } - ] - }, - "blockId": "0x3f86a22d6170b64a420562a8e31adcd515a6d2b15d0201f60e20fc037b9ec455", - "inclusionState": "Pending", - "timestamp": "1664966791558", - "transactionId": "0xf4f21680774c74ae44d3244aca8cc3fd0248930561de673032afb21b18b04e8e", - "networkId": "1856588631910923207", - "incoming": false -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_01_mint_nft/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_01_mint_nft/_code_sample.mdx deleted file mode 100644 index 04f3f365acd..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_01_mint_nft/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/25-mint-nft.js -``` - -You can run the example by running the following command from the `wallet/bindings/nodejs/examples/` folder: - -```bash -node 25-mint-nft.js -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_01_mint_nft/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_01_mint_nft/_expected_output.md deleted file mode 100644 index 4d12e90a73b..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_01_mint_nft/_expected_output.md +++ /dev/null @@ -1,24 +0,0 @@ -```js -{ - payload: { - type: 6, - essence: { - type: 1, - networkId: '1856588631910923207', - inputs: [Array], - inputsCommitment: '0x086739a754bd6e9bd74f6242aaa354a46ee3615ad74a33caab84f0b0621e4885', - outputs: [Array] - }, - unlocks: [ [Object] ] - }, - blockId: '0xabe9f275b86ce75dbe64a6868b13eb27d362f27a968f361b888ac9f2423eb7ca', - inclusionState: 'Pending', - timestamp: '1663000060038', - transactionId: '0x2db9d3348abc98b59e8a8f68c3f6243300facc47fd2e005fd28878f295316fe9', - networkId: '1856588631910923207', - incoming: false, - note: null -} -Check your block on http://localhost:14265/api/core/v2/blocks/0xabe9f275b86ce75dbe64a6868b13eb27d362f27a968f361b888ac9f2423eb7ca - -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_02_send_nft/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_02_send_nft/_code_sample.mdx deleted file mode 100644 index ce6b827cbed..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_02_send_nft/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/26-send-nft.js -``` - -You can run the example by running the following command from the `wallet/bindings/nodejs/examples/` folder: - -```bash -node 26-send-nft.js -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_02_send_nft/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_02_send_nft/_expected_output.md deleted file mode 100644 index b9ca0f7acbc..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_02_send_nft/_expected_output.md +++ /dev/null @@ -1,23 +0,0 @@ -```js -{ - payload: { - type: 6, - essence: { - type: 1, - networkId: '1856588631910923207', - inputs: [Array], - inputsCommitment: '0xd549b56a017e51a4ff053171b55aba62aac59e38a167067769991ccfb663ce1b', - outputs: [Array] - }, - unlocks: [ [Object] ] - }, - blockId: '0x40c74e3e9bc8913e3d5c75723d8e018695f3be8a78bd05479500eff4a7a10915', - inclusionState: 'Pending', - timestamp: '1663000240615', - transactionId: '0x03d4fe1335d0880db4163e7cb19735e016c803b015c9e65123e07de579ed41d2', - networkId: '1856588631910923207', - incoming: false, - note: null -} -Check your block on http://localhost:14265/api/core/v2/blocks/0x40c74e3e9bc8913e3d5c75723d8e018695f3be8a78bd05479500eff4a7a10915 -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_03_burn_nft/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_03_burn_nft/_code_sample.mdx deleted file mode 100644 index 8e2e8aec62f..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_03_burn_nft/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/27-burn-nft.js -``` - -You can run the example by running the following command from the `wallet/bindings/nodejs/examples/` folder: - -```bash -node 27-burn-nft.js -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_03_burn_nft/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_03_burn_nft/_expected_output.md deleted file mode 100644 index 3cde58cb92b..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/NFT/_03_burn_nft/_expected_output.md +++ /dev/null @@ -1,24 +0,0 @@ -```js -{ - payload: { - type: 6, - essence: { - type: 1, - networkId: '1856588631910923207', - inputs: [Array], - inputsCommitment: '0x8ed6de2d3570269b4cfe2eb7ad29ee324c1b6ff78ad1f608db2b4e40c03db366', - outputs: [Array] - }, - unlocks: [ [Object] ] - }, - blockId: '0x2ea37ddeeaad7e6546e22cb92821ada3a213760b6a799c49b68d57a287d68a3b', - inclusionState: 'Pending', - timestamp: '1663000414059', - transactionId: '0x8e178dddc6c65be31ebe9fc980add3a62573d972a15deee03ac2434fc91812c5', - networkId: '1856588631910923207', - incoming: false, - note: null -} -Check your block on http://localhost:14265/api/core/v2/blocks/0x2ea37ddeeaad7e6546e22cb92821ada3a213760b6a799c49b68d57a287d68a3b - -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/_more_examples.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/_more_examples.md deleted file mode 100644 index 097545bd688..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/_more_examples.md +++ /dev/null @@ -1 +0,0 @@ -More advanced examples can be found in the [examples](https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples) folder. diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/_run_how_tos.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/_run_how_tos.mdx deleted file mode 100644 index 25bcf27ec62..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/_run_how_tos.mdx +++ /dev/null @@ -1,59 +0,0 @@ -## Prerequisites - -Before you can run the examples, please refer to the [Node.js Getting Started guide](./../../../getting_started/nodejs.mdx) to install -the library. - -### Set Up Your .env file - -The code examples use a `.env` file to store variables. You can download -the [example file](https://github.com/iotaledger/wallet.rs/blob/develop/wallet/bindings/nodejs/examples/.env.example) or create a new one with -the following variables: - -```dotenv reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/.env.example -``` - -The `.env.example` uses public [Shimmer Beta](/build/networks-endpoints#public-testnet) -URLS. If you want to use another node, you should update the `NODE_URL` and `FAUCET_URL` values to match the -[Hornet node](#hornet-node) you want to use. - -### Install Dependencies - -Before you can try out the examples, you must install the necessary dependencies using npm. You can do this by running -the following command from the `binding/nodejs` directory: - -```bash -npm i -``` - -### Build the Library - -Once you have [set up your `.env` file](#setup-your-env-file) and [installed the necessary dependencies](#install-dependencies) -, you can build the library by running the following command: - -```bash -npm run build -``` - -## Run the Examples - -The wallet.rs library has numerous examples you can run to get acquainted with the library. -Once you followed the instructions to [build the library](#build-the-library) and installed the dependencies, you will need to select one of the -[Node.js examples](https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/). Run the selected example with -your local Node.js interpreter. - -### Install Dependencies - -Before you can run any example, you should install their dependencies by running the following command from the -`/bindings/nodejs/examples` directory: - -```bash -npm i -``` - -To run examples, you will need to change to the `wallet/bindings/nodejs/examples` directory, and run any example. -The following command will run the `10-node-info.js` example: - -```bash -node 10-node-info.js -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_01_create_a_wallet_account/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_01_create_a_wallet_account/_code_sample.mdx deleted file mode 100644 index d6862aec4dd..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_01_create_a_wallet_account/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/1-create-account.js -``` - -You can run the example by running the following command from the `wallet/bindings/nodejs/examples/` folder: - -```bash -node 1-create-account.js -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_01_create_a_wallet_account/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_01_create_a_wallet_account/_expected_output.md deleted file mode 100644 index 15c7c820284..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_01_create_a_wallet_account/_expected_output.md +++ /dev/null @@ -1,37 +0,0 @@ -```js -Account created: Account { - meta: { - index: 0, - coinType: 4219, - alias: 'Alice', - publicAddresses: [ [Object] ], - internalAddresses: [], - addressesWithUnspentOutputs: [], - outputs: {}, - lockedOutputs: [], - unspentOutputs: {}, - transactions: {}, - pendingTransactions: [], - incomingTransactions: {} - }, - messageHandler: MessageHandler { messageHandler: [External: 7f29dde5bf80] } -} -Account created: Account { - meta: { - index: 1, - coinType: 4219, - alias: 'Bob', - publicAddresses: [ [Object] ], - internalAddresses: [], - addressesWithUnspentOutputs: [], - outputs: {}, - lockedOutputs: [], - unspentOutputs: {}, - transactions: {}, - pendingTransactions: [], - incomingTransactions: {} - }, - messageHandler: MessageHandler { messageHandler: [External: 7f29dde5bf80] } -} - -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_02_generate_address/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_02_generate_address/_code_sample.mdx deleted file mode 100644 index 3adfc92abfb..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_02_generate_address/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/2-generate-address.js -``` - -You can run the example by running the following command from the `wallet/bindings/nodejs/examples/` folder: - -```bash -node 2-generate-address.js -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_02_generate_address/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_02_generate_address/_expected_output.md deleted file mode 100644 index 794ac9be272..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_02_generate_address/_expected_output.md +++ /dev/null @@ -1,27 +0,0 @@ -```js -Account: Account { - meta: { - index: 0, - coinType: 4219, - alias: 'Alice', - publicAddresses: [ [Object] ], - internalAddresses: [], - addressesWithUnspentOutputs: [], - outputs: {}, - lockedOutputs: [], - unspentOutputs: {}, - transactions: {}, - pendingTransactions: [], - incomingTransactions: {} - }, - messageHandler: MessageHandler { messageHandler: [External: 7fa6ffff18d0] } -} -New address: { - address: 'rms1qqqp07ychhkc3u68ueug0zqq9g0wtfgeatynr6ksm9jwud30rvlkyqnhpl5', - keyIndex: 1, - internal: false, - used: false -} -Fill your address with the Faucet: https://faucet.testnet.shimmer.network - -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_03_request_funds/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_03_request_funds/_code_sample.mdx deleted file mode 100644 index 9542fd27be4..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_03_request_funds/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/33-request-funds.js -``` - -You can run the example by running the following command from the `wallet/bindings/nodejs/examples/` folder: - -```bash -node 33-request-funds.js -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_03_request_funds/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_03_request_funds/_expected_output.md deleted file mode 100644 index 3f13adc5a73..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_03_request_funds/_expected_output.md +++ /dev/null @@ -1,3 +0,0 @@ -```js -{"address":"rms1qzrux5tuhpfrc84gwau7ldg0xjvnkuheg3pnmjx94jrpah8rqqmuz3crlzm","waitingRequests":1} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_04_check_balance/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_04_check_balance/_code_sample.mdx deleted file mode 100644 index bb82ca81c9f..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_04_check_balance/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/3-check-balance.js -``` - -You can run the example by running the following command from the `wallet/bindings/nodejs/examples/` folder: - -```bash -node 3-check-balance.js -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_04_check_balance/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_04_check_balance/_expected_output.md deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_05_backup/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_05_backup/_code_sample.mdx deleted file mode 100644 index 502735b0ded..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_05_backup/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/5-backup.js -``` - -You can run the example by running the following command from the `wallet/bindings/nodejs/examples/` folder: - -```bash -node 5-backup.js -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_05_backup/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_05_backup/_expected_output.md deleted file mode 100644 index a8358155a71..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/accounts_and_addresses/_05_backup/_expected_output.md +++ /dev/null @@ -1,4 +0,0 @@ -```plaintext -Backup created at: ./backup -Successfully created backup -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_01_mint_native_token/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_01_mint_native_token/_code_sample.mdx deleted file mode 100644 index 736a4b74455..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_01_mint_native_token/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/22-mint-native-tokens.js -``` - -You can run the example by running the following command from the `wallet/bindings/nodejs/examples/` folder: - -```bash -node 22-mint-native-tokens.js -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_01_mint_native_token/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_01_mint_native_token/_expected_output.md deleted file mode 100644 index 943eab8001e..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_01_mint_native_token/_expected_output.md +++ /dev/null @@ -1,3 +0,0 @@ -```js -Transaction ID: 0x4cd9cca67165b3ae5160e5b3bad5a677d93140e3692c378ed5c661160e37ce09 -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_02_send_native_token/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_02_send_native_token/_code_sample.mdx deleted file mode 100644 index 6e234ccfb38..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_02_send_native_token/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/24-send-native-tokens.js -``` - -You can run the example by running the following command from the `wallet/bindings/nodejs/examples/` folder: - -```bash -node 24-send-native-tokens.js -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_02_send_native_token/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_02_send_native_token/_expected_output.md deleted file mode 100644 index 27d7d715d38..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_02_send_native_token/_expected_output.md +++ /dev/null @@ -1,23 +0,0 @@ -```js -{ - payload: { - type: 6, - essence: { - type: 1, - networkId: '1856588631910923207', - inputs: [Array], - inputsCommitment: '0xaf866f45f6418098b2bb3b8359f39ca55ecb57c666c65c40c4f982af365f37d6', - outputs: [Array] - }, - unlocks: [ [Object] ] - }, - blockId: '0x1630e8423fe5eb11f7c6ad9afcb2198ac731fb2b10efa7e903f30fd79ddd5c14', - inclusionState: 'Pending', - timestamp: '1662659637387', - transactionId: '0xd4a81db105132dfa0c51a29eaecff1d796bf66d4be91be15a9864c88ee8f2c67', - networkId: '1856588631910923207', - incoming: false, - note: null -} -Check your block on http://localhost:14265/api/core/v2/blocks/0x1630e8423fe5eb11f7c6ad9afcb2198ac731fb2b10efa7e903f30fd79ddd5c14 -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_03_melt_native_token/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_03_melt_native_token/_code_sample.mdx deleted file mode 100644 index f78b8b965ac..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_03_melt_native_token/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/30-decrease-native-token-supply.js -``` - -You can run the example by running the following command from the `wallet/bindings/nodejs/examples/` folder: - -```bash -node 30-decrease-native-token-supply.js -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_03_melt_native_token/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_03_melt_native_token/_expected_output.md deleted file mode 100644 index 31b632015a9..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_03_melt_native_token/_expected_output.md +++ /dev/null @@ -1,23 +0,0 @@ -```js -{ - payload: { - type: 6, - essence: { - type: 1, - networkId: '1856588631910923207', - inputs: [Array], - inputsCommitment: '0x2d6b40731bd6222d0f7670ea5a1b143e499703cf71fd51a821d32d91a77a5041', - outputs: [Array] - }, - unlocks: [ [Object], [Object], [Object] ] - }, - blockId: '0x350a89dad8a6d96dc5cd5e7abcafa334c287e14ee4187c0260d7b24209b4ff19', - inclusionState: 'Pending', - timestamp: '1671182041013', - transactionId: '0xd7b94f8487a817bc70febb80d83f0df93f1d7035851affaf7114cd7348cb610d', - networkId: '1856588631910923207', - incoming: false, - note: null -} -Check your block on http://localhost:14265/api/core/v2/blocks/0x350a89dad8a6d96dc5cd5e7abcafa334c287e14ee4187c0260d7b24209b4ff19 -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_04_burn_native_token/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_04_burn_native_token/_code_sample.mdx deleted file mode 100644 index d31a8745ee7..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_04_burn_native_token/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/31-burn-native-token.js -``` - -You can run the example by running the following command from the `wallet/bindings/nodejs/examples/` folder: - -```bash -node 31-burn-native-token.js -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_04_burn_native_token/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_04_burn_native_token/_expected_output.md deleted file mode 100644 index f0c7f79043e..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_04_burn_native_token/_expected_output.md +++ /dev/null @@ -1,23 +0,0 @@ -```js -{ - payload: { - type: 6, - essence: { - type: 1, - networkId: '1856588631910923207', - inputs: [Array], - inputsCommitment: '0xbbeedfa08b1136421e6c0ad599ada29ccadd326535262de9edadbfe9475b29cf', - outputs: [Array] - }, - unlocks: [ [Object] ] - }, - blockId: '0xf6bba8d67f6f35bc63658f12df5649f71cbc28512e4f3aa65fda727fa2ae4e5b', - inclusionState: 'Pending', - timestamp: '1671182074342', - transactionId: '0x13df212d5f8ae281226543d7888491f866fbe669b160a9d2893674ff1a00a81a', - networkId: '1856588631910923207', - incoming: false, - note: null -} -Check your block on http://localhost:14265/api/core/v2/blocks/0xf6bba8d67f6f35bc63658f12df5649f71cbc28512e4f3aa65fda727fa2ae4e5b -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_05_destroy_foundry/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_05_destroy_foundry/_code_sample.mdx deleted file mode 100644 index 063a0a98114..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_05_destroy_foundry/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/32-destroy-foundry.js -``` - -You can run the example by running the following command from the `wallet/bindings/nodejs/examples/` folder: - -```bash -node 32-destroy-foundry.js -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_05_destroy_foundry/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_05_destroy_foundry/_expected_output.md deleted file mode 100644 index 20d11c836c5..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/native_tokens/_05_destroy_foundry/_expected_output.md +++ /dev/null @@ -1,23 +0,0 @@ -```js -{ - payload: { - type: 6, - essence: { - type: 1, - networkId: '1856588631910923207', - inputs: [Array], - inputsCommitment: '0x3179afe33825e2c9557079291324968a159b6f8b89d0c7478ae3ec38b3b00548', - outputs: [Array] - }, - unlocks: [ [Object], [Object] ] - }, - blockId: '0xeff7d964dea61e303d92e1a4930d42268e8e7d0a19f53f7a929518cb9e57a50f', - inclusionState: 'Pending', - timestamp: '1671182397354', - transactionId: '0x6de7c4366f0419a6cbc2a39f8d67f0b6e5737b8caa8c029f59cee486b36ab8e9', - networkId: '1856588631910923207', - incoming: false, - note: null -} -Check your block on http://localhost:14265/api/core/v2/blocks/0xeff7d964dea61e303d92e1a4930d42268e8e7d0a19f53f7a929518cb9e57a50f -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_05_send_transaction/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_05_send_transaction/_code_sample.mdx deleted file mode 100644 index 2411156304c..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_05_send_transaction/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/4a-send-amount.js -``` - -You can run the example by running the following command from the `wallet/bindings/nodejs/examples/` folder: - -```bash -node 4a-send-amount.js -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_05_send_transaction/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_05_send_transaction/_expected_output.md deleted file mode 100644 index 68ced7dfcb3..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_05_send_transaction/_expected_output.md +++ /dev/null @@ -1,69 +0,0 @@ -```js -Account: Account { - meta: { - index: 0, - coinType: 4219, - alias: 'Alice', - publicAddresses: [ [Object], [Object] ], - internalAddresses: [], - addressesWithUnspentOutputs: [ [Object], [Object] ], - outputs: { - '0xcb1be0ba2ce57ea3828133e23f1a278d1b37975d75ead9f3383fd640a4ba53c30000': [Object], - '0x8a9ecb96b14a57eddea704f4aa07cfe9edfa5a97080901632276b128ae7d8adb7300': [Object], - '0x607d5dfac8dd4fe05bfe62782954447334ef37b0968c690591dc8f261c3b881a4900': [Object], - '0xb2435d5b02df29da6ddf236f42683546857b7413cabf71bd20a8fd097c7e9f8e0000': [Object], - '0x52b65cf6c5e53e17ab8cc6be6832e354f4f021908e002e1fbb624e80d9eeb5fb0000': [Object], - '0xfa2cf42a07a51d4e7d2a2bcd63202400264b108938945ee53237de91d255c95c0100': [Object], - '0x7116076c27a926d5ebed504ec0a94c580920b3e9a8374197cc08e759953bc01a0000': [Object], - '0x3800d06480923efd65bfc0d5c9b17e4924cca375d1342908b39b3ca70a1cff8f0100': [Object], - '0x54bebd37b99bcf264b8ae1ebbe3dc5b0c54848f2ae24b4ded939416b6cf36b1d0000': [Object], - '0xcbe05ec9b535318f3210b3116c482c8b2d3e6f01f83d9250c61d87495355ecd70000': [Object] - }, - lockedOutputs: [ - '0x3800d06480923efd65bfc0d5c9b17e4924cca375d1342908b39b3ca70a1cff8f0100' - ], - unspentOutputs: { - '0x54bebd37b99bcf264b8ae1ebbe3dc5b0c54848f2ae24b4ded939416b6cf36b1d0000': [Object], - '0xfa2cf42a07a51d4e7d2a2bcd63202400264b108938945ee53237de91d255c95c0100': [Object], - '0xb2435d5b02df29da6ddf236f42683546857b7413cabf71bd20a8fd097c7e9f8e0000': [Object], - '0xcbe05ec9b535318f3210b3116c482c8b2d3e6f01f83d9250c61d87495355ecd70000': [Object], - '0x8a9ecb96b14a57eddea704f4aa07cfe9edfa5a97080901632276b128ae7d8adb7300': [Object], - '0x607d5dfac8dd4fe05bfe62782954447334ef37b0968c690591dc8f261c3b881a4900': [Object], - '0xcb1be0ba2ce57ea3828133e23f1a278d1b37975d75ead9f3383fd640a4ba53c30000': [Object], - '0x52b65cf6c5e53e17ab8cc6be6832e354f4f021908e002e1fbb624e80d9eeb5fb0000': [Object], - '0x3800d06480923efd65bfc0d5c9b17e4924cca375d1342908b39b3ca70a1cff8f0100': [Object], - '0x7116076c27a926d5ebed504ec0a94c580920b3e9a8374197cc08e759953bc01a0000': [Object] - }, - transactions: { - '0x91a469ff1008ed3dc21d02aa6c20d8c2c048c5f096d7c9af797d3215f824e369': [Object] - }, - pendingTransactions: [ - '0x91a469ff1008ed3dc21d02aa6c20d8c2c048c5f096d7c9af797d3215f824e369' - ], - incomingTransactions: {} - }, - messageHandler: MessageHandler { messageHandler: [External: 7f40e2e18a40] } -} -{ - payload: { - type: 6, - essence: { - type: 1, - networkId: '1856588631910923207', - inputs: [Array], - inputsCommitment: '0x4a56ceb8ee05b747b73e97bdb093be9f885b6ba27562c91a1d8745d9ccfd57e1', - outputs: [Array] - }, - unlocks: [ [Object] ] - }, - blockId: '0x1650f471475bb0a64d3783f62b391d59b00b0eadb64ec717ac986b6725c7cfcb', - inclusionState: 'Pending', - timestamp: '1662654717453', - transactionId: '0x17670e2cda90f199c3e07188068c38ad856274e98d4913b80da8e3830db7afc4', - networkId: '1856588631910923207', - incoming: false, - note: null -} -Check your block on http://localhost:14265/api/core/v2/blocks/0x1650f471475bb0a64d3783f62b391d59b00b0eadb64ec717ac986b6725c7cfcb - -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_check_unlock_conditions/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_check_unlock_conditions/_code_sample.mdx deleted file mode 100644 index 2e196565424..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_check_unlock_conditions/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/36-check-unlock-conditions.js -``` - -You can run the example by running the following command from the `wallet/bindings/nodejs/examples/` folder: - -```bash -node 36-check-unlock-conditions.js -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_check_unlock_conditions/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_check_unlock_conditions/_expected_output.md deleted file mode 100644 index 9188ebd5919..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_check_unlock_conditions/_expected_output.md +++ /dev/null @@ -1,3 +0,0 @@ -```plaintext -The output has only an address unlock condition and the address is from the account: true -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_restore/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_restore/_code_sample.mdx deleted file mode 100644 index 23ddf45b203..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_restore/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/6-restore.js -``` - -You can run the example by running the following command from the `wallet/bindings/nodejs/examples/` folder: - -```bash -node 6-restore.js -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_restore/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_restore/_expected_output.md deleted file mode 100644 index 95424f6b08e..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_restore/_expected_output.md +++ /dev/null @@ -1,3 +0,0 @@ -```plaintext -Account: Alice -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_send_micro_transaction/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_send_micro_transaction/_code_sample.mdx deleted file mode 100644 index 3dfab39d17d..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_send_micro_transaction/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/4c-send-micro-transaction.js -``` - -You can run the example by running the following command from the `wallet/bindings/nodejs/examples/` folder: - -```bash -node 4c-send-micro-transaction.js -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_send_micro_transaction/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_send_micro_transaction/_expected_output.md deleted file mode 100644 index 49a47341cd9..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_06_send_micro_transaction/_expected_output.md +++ /dev/null @@ -1,24 +0,0 @@ -```js -{ - payload: { - type: 6, - essence: { - type: 1, - networkId: '1856588631910923207', - inputs: [Array], - inputsCommitment: '0xad0e11ab7795212f3ff497e06c22218a18b297280e26e1d6392d217244879348', - outputs: [Array] - }, - unlocks: [ [Object] ] - }, - blockId: '0x20cc5acd8af1a9d27b181632ef32818a721622ab0c9d887977b2f1501dd0ae42', - inclusionState: 'Pending', - timestamp: '1662654628971', - transactionId: '0x91a469ff1008ed3dc21d02aa6c20d8c2c048c5f096d7c9af797d3215f824e369', - networkId: '1856588631910923207', - incoming: false, - note: null -} -Check your block on http://localhost:14265/api/core/v2/blocks/0x20cc5acd8af1a9d27b181632ef32818a721622ab0c9d887977b2f1501dd0ae42 - -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_12a_list_outputs/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_12a_list_outputs/_code_sample.mdx deleted file mode 100644 index 2f9dc2ef94e..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_12a_list_outputs/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/12a-list-outputs.js -``` - -You can run the example by running the following command from the `wallet/bindings/nodejs/examples/` folder: - -```bash -node 12a-list-outputs.js -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_12a_list_outputs/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_12a_list_outputs/_expected_output.md deleted file mode 100644 index 95088a3960a..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_12a_list_outputs/_expected_output.md +++ /dev/null @@ -1,34 +0,0 @@ -```js -Listing Outputs: [ - { - outputId: '0x72240e6d6dc463e4dd962a2e34f2233a41b56a259c84faf895fbbb96820773050100', - metadata: { - blockId: '0x1106c1e0da5b2e10762fcf0ed3bc2a4790ffd2a81895afbc58df6b447c70ad3a', - transactionId: '0x72240e6d6dc463e4dd962a2e34f2233a41b56a259c84faf895fbbb9682077305', - outputIndex: 1, - isSpent: false, - milestoneIndexBooked: 972425, - milestoneTimestampBooked: 1662996908, - ledgerIndex: 974093 - }, - output: { - type: 5, - amount: '53600', - serialNumber: 4, - tokenScheme: [Object], - unlockConditions: [Array], - immutableFeatures: [Array] - }, - isSpent: false, - address: { - type: 0, - pubKeyHash: '0xeed1e4e3e9e7555e2f1592594bf916523e7fef3a9a8c0d630a4934440b822647' - }, - networkId: '1856588631910923207', - remainder: false, - chain: [ [Object], [Object], [Object], [Object], [Object] ] - }, - [...] -] - -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_12c_list_transactions/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_12c_list_transactions/_code_sample.mdx deleted file mode 100644 index 66b8d1b9797..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_12c_list_transactions/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/12c-list-transactions.js -``` - -You can run the example by running the following command from the `wallet/bindings/nodejs/examples/` folder: - -```bash -node 12c-list-transactions.js -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_12c_list_transactions/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_12c_list_transactions/_expected_output.md deleted file mode 100644 index 5c9dbd26b5a..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_12c_list_transactions/_expected_output.md +++ /dev/null @@ -1,15 +0,0 @@ -```js -Listing Transactions: [ - { - payload: { type: 6, essence: [Object], unlocks: [Array] }, - blockId: '0x7bebed05d7687206a24e0461305af41900fe57f4480bff08ac79d0f193f99a63', - inclusionState: 'Confirmed', - timestamp: '1663005355019', - transactionId: '0xc4cd87bb0f33f2be15fab5454628ca21dc7f516120e7ddae8f87f4308b123412', - networkId: '1856588631910923207', - incoming: false, - note: null - } - [...] -] -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_21_claim_outputs/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_21_claim_outputs/_code_sample.mdx deleted file mode 100644 index a085d923228..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_21_claim_outputs/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```js reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/nodejs/examples/21-claim-outputs.js -``` - -You can run the example by running the following command from the `wallet/bindings/nodejs/examples/` folder: - -```bash -node 21-claim-outputs.js -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_21_claim_outputs/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_21_claim_outputs/_expected_output.md deleted file mode 100644 index a28c857903f..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/how_to/outputs_and_transactions/_21_claim_outputs/_expected_output.md +++ /dev/null @@ -1,37 +0,0 @@ -```js -Transaction is sent { - payload: { - type: 6, - essence: { - type: 1, - networkId: '1856588631910923207', - inputs: [Array], - inputsCommitment: '0xe564a6ec7749b3c09e06b05c76c95b37a34d0fd026dfb4082b8e4ff900f9dc81', - outputs: [Array] - }, - unlocks: [ [Object] ] - }, - blockId: '0x8ce286630d376d3f6f2c74c1f758e38a0b88d776887aa6e4c7af0c125b533c7f', - inclusionState: 'Pending', - timestamp: '1663005430349', - transactionId: '0xad3f8e00af9d56d22eff5ec730e01918e52d80c87e94859e00907099091aa95a', - networkId: '1856588631910923207', - incoming: false, - note: null -} -Output received: {"accountIndex":0,"event":{"NewOutput":{"output":{"outputId":"0xad3f8e00af9d56d22eff5ec730e01918e52d80c87e94859e00907099091aa95a0100","metadata":{"blockId":"0x8ce286630d376d3f6f2c74c1f758e38a0b88d776887aa6e4c7af0c125b533c7f","transactionId":"0xad3f8e00af9d56d22eff5ec730e01918e52d80c87e94859e00907099091aa95a","outputIndex":1,"isSpent":false,"milestoneIndexBooked":974130,"milestoneTimestampBooked":1663005433,"ledgerIndex":974130},"output":{"type":3,"amount":"998837200","unlockConditions":[{"type":0,"address":{"type":0,"pubKeyHash":"0xeed1e4e3e9e7555e2f1592594bf916523e7fef3a9a8c0d630a4934440b822647"}}]},"isSpent":false,"address":{"type":0,"pubKeyHash":"0xeed1e4e3e9e7555e2f1592594bf916523e7fef3a9a8c0d630a4934440b822647"},"networkId":"1856588631910923207","remainder":true,"chain":[{"hardened":true,"bs":[128,0,0,44]},{"hardened":true,"bs":[128,0,16,123]},{"hardened":true,"bs":[128,0,0,0]},{"hardened":true,"bs":[128,0,0,0]},{"hardened":true,"bs":[128,0,0,0]}]},"transaction":null,"transactionInputs":null}}} -Output received: {"accountIndex":1,"event":{"NewOutput":{"output":{"outputId":"0xad3f8e00af9d56d22eff5ec730e01918e52d80c87e94859e00907099091aa95a0000","metadata":{"blockId":"0x8ce286630d376d3f6f2c74c1f758e38a0b88d776887aa6e4c7af0c125b533c7f","transactionId":"0xad3f8e00af9d56d22eff5ec730e01918e52d80c87e94859e00907099091aa95a","outputIndex":0,"isSpent":false,"milestoneIndexBooked":974130,"milestoneTimestampBooked":1663005433,"ledgerIndex":974131},"output":{"type":3,"amount":"1000000","unlockConditions":[{"type":0,"address":{"type":0,"pubKeyHash":"0x085748b21812b9fd706d58983a7b16dabe8a068bd8473ee1cd322fc9e02d8703"}}]},"isSpent":false,"address":{"type":0,"pubKeyHash":"0x085748b21812b9fd706d58983a7b16dabe8a068bd8473ee1cd322fc9e02d8703"},"networkId":"1856588631910923207","remainder":false,"chain":[{"hardened":true,"bs":[128,0,0,44]},{"hardened":true,"bs":[128,0,16,123]},{"hardened":true,"bs":[128,0,0,1]},{"hardened":true,"bs":[128,0,0,0]},{"hardened":true,"bs":[128,0,0,0]}]},"transaction":null,"transactionInputs":null}}} -Output has been claimed in the following transaction: [ - { - payload: { type: 6, essence: [Object], unlocks: [Array] }, - blockId: '0x3881d8a790b70d6cd3d5b7e4ade65f20cc2a1a9c88af76d612b3646fdd471d7a', - inclusionState: 'Pending', - timestamp: '1663005447689', - transactionId: '0x046a1112ba53beeee146dd4b0a28c59565fda3f62628b53655b5719b326e25d0', - networkId: '1856588631910923207', - incoming: false, - note: null - } -] - -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/references/interfaces/AccountMetadata.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/references/interfaces/AccountMetadata.md deleted file mode 100644 index 5eff3d284e8..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/references/interfaces/AccountMetadata.md +++ /dev/null @@ -1,35 +0,0 @@ -# Interface: AccountMetadata - -The account metadata - -## Table of contents - -### Properties - -- [alias](AccountMetadata.md#alias) -- [coinType](AccountMetadata.md#cointype) -- [index](AccountMetadata.md#index) - -## Properties - -### alias - -• **alias**: `string` - -The account alias - ---- - -### coinType - -• **coinType**: `CoinType` - -The used coin type - ---- - -### index - -• **index**: `number` - -The account index which will be used in the BIP32 path diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/references/interfaces/AliasOutputOptions.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/references/interfaces/AliasOutputOptions.md deleted file mode 100644 index 1f062a0c518..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/references/interfaces/AliasOutputOptions.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: AliasOutputOptions - -Options for the alias output creation - -## Table of contents - -### Properties - -- [address](AliasOutputOptions.md#address) -- [immutableMetadata](AliasOutputOptions.md#immutablemetadata) -- [metadata](AliasOutputOptions.md#metadata) -- [stateMetadata](AliasOutputOptions.md#statemetadata) - -## Properties - -### address - -• `Optional` **address**: `string` - -Bech32 encoded address to which the Nft will be minted. Default will use the -first address of the account - ---- - -### immutableMetadata - -• `Optional` **immutableMetadata**: `string` - -Hex encoded bytes - ---- - -### metadata - -• `Optional` **metadata**: `string` - -Hex encoded bytes - ---- - -### stateMetadata - -• `Optional` **stateMetadata**: `string` - -Hex encoded bytes diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/references/interfaces/MnemonicSecretManager.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/references/interfaces/MnemonicSecretManager.md deleted file mode 100644 index a0a5e97e5c7..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/nodejs/references/interfaces/MnemonicSecretManager.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: MnemonicSecretManager - -Secret manager that uses a mnemonic. diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_01_mint_nft/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_01_mint_nft/_code_sample.mdx deleted file mode 100644 index 1427799b218..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_01_mint_nft/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples/8-mint-nft.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 8-mint-nft.py -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_01_mint_nft/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_01_mint_nft/_expected_output.md deleted file mode 100644 index cb506a842d3..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_01_mint_nft/_expected_output.md +++ /dev/null @@ -1,120 +0,0 @@ -``` -Synced:{ - 'baseCoin':{ - 'total':'3302125202', - 'available':'3302125202' - }, - 'requiredStorageDeposit':'910154600', - 'nativeTokens':[ - { - 'tokenId':'0x08b83d49922e341d2cb45159707cfafdc9dc8fdb9d119543480dbaa5773eed8c4a0100000000', - 'total':'0x64', - 'available':'0x64' - }, - { - 'tokenId':'0x08a5526c4a15558b709340822edf00cb348d8606a27e2e59b00432a0afe8afb74d0100000000', - 'total':'0x3de', - 'available':'0x3de' - } - ], - 'nfts':[ - '0xceae643ff7c112a3adce8f55f7953ba0707ade21256a7a09068c0b47f7c62c5b', - '0x1b670afba8d59a445cbaf167f1fda05879362e3ea034f5c4a0979fbeb5a3964b', - '0x1e808b7c6e603aaeb5f718881a74fedae72981ac7d5f0294eb561cad0e653566', - '0x3f0e11e9d9f48a57d0fba43d7d1158ee673cb8055f80a5ce45ad174c962c0d8a', - '0xdc8be91d779aac048aa9001ab99ecf12cf62a4701185a95f6206a1a201bfbe7c', - '0x77133189021f50d8d66e0678e553af9f46a832a24239653d3555edb8dc859e1f' - ], - 'aliases':[ - '0xf9c702ffe50c35d331b2df02295c2cc6d92f883530ff231bd76d1f6a72cb1d95', - '0xa5526c4a15558b709340822edf00cb348d8606a27e2e59b00432a0afe8afb74d', - '0x96717e6d19c13b1c5b120d60b23217f541b5b779e51212e01d72e7fa1f7090cf', - '0x97eb7a447cd62e1c373ff8188ba422f5c1b0687707d38e10e8366a1c20d33fea' - ], - 'foundries':[ - '0x08a5526c4a15558b709340822edf00cb348d8606a27e2e59b00432a0afe8afb74d0100000000' - ], - 'potentiallyLockedOutputs':{ - '0x850c1e43dff1a28a42d71edc6d4ad0b9f251c03993f9b0684a34f645514ffe270000':False, - '0x9a5869b61b29f17326e04b6161d9cd169687e79476c556bd0c3cbbc3648d4ff60000':False - } -} -Sent transaction:{ - 'payload':{ - 'type':6, - 'essence':{ - 'type':1, - 'networkId':'1856588631910923207', - 'inputs':[ - { - 'type':0, - 'transactionId':'0x0220b5247654d05529f40b3d8cdb7ca6f89627038f47a68aa578b9e675ddc937', - 'transactionOutputIndex':33 - }, - { - 'type':0, - 'transactionId':'0x0220b5247654d05529f40b3d8cdb7ca6f89627038f47a68aa578b9e675ddc937', - 'transactionOutputIndex':34 - } - ], - 'inputsCommitment':'0x0bfe4956fc30fae1ebba021e99506bf38df9ba8297d569185bb3779219ad7bb9', - 'outputs':[ - { - 'type':6, - 'amount':'48900', - 'nftId':'0x0000000000000000000000000000000000000000000000000000000000000000', - 'unlockConditions':[ - { - 'type':0, - 'address':{ - 'type':0, - 'pubKeyHash':'0x8297ac4149c80cca8225e5f2da36df89a93cd2998d7f6d488c97250a881e65af' - } - } - ], - 'immutableFeatures':[ - { - 'type':2, - 'data':'0x736f6d6520696d6d757461626c65206e6674206d65746164617461' - } - ] - }, - { - 'type':3, - 'amount':'52300', - 'unlockConditions':[ - { - 'type':0, - 'address':{ - 'type':0, - 'pubKeyHash':'0x8297ac4149c80cca8225e5f2da36df89a93cd2998d7f6d488c97250a881e65af' - } - } - ] - } - ] - }, - 'unlocks':[ - { - 'type':0, - 'signature':{ - 'type':0, - 'publicKey':'0xe62838fda7e8b77bf80e49967f0f089ae2a7230547d5231649732952f6336fae', - 'signature':'0x6abc61aafa97c377ed739043c724d7336d2f6aef37962b14b21a3173b2ca48e683aee0c86326d4ae3542465237fbf4d90917fbbed0704362e176dbbc6eb3560f' - } - }, - { - 'type':1, - 'reference':0 - } - ] - }, - 'blockId':'0x3209a72083c0b3cd5e19106cda5155f7387b54667aa81b225ab4a467b9ccd175', - 'inclusionState':'Pending', - 'timestamp':'1665918633606', - 'transactionId':'0x25ddb61de4422f1df52286647517e5e1db8b1a7925ce3323bbf4533bbd3a7487', - 'networkId':'1856588631910923207', - 'incoming':False, - 'note':None -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_02_send_nft/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_02_send_nft/_code_sample.mdx deleted file mode 100644 index 9c369b35976..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_02_send_nft/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples/6-send-nft.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 6-send-nft.py -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_02_send_nft/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_02_send_nft/_expected_output.md deleted file mode 100644 index 1a72e83d28f..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_02_send_nft/_expected_output.md +++ /dev/null @@ -1,105 +0,0 @@ -``` -Synced:{ - 'baseCoin':{ - 'total':'3302172702', - 'available':'3302172702' - }, - 'requiredStorageDeposit':'910202100', - 'nativeTokens':[ - { - 'tokenId':'0x08a5526c4a15558b709340822edf00cb348d8606a27e2e59b00432a0afe8afb74d0100000000', - 'total':'0x3de', - 'available':'0x3de' - }, - { - 'tokenId':'0x08b83d49922e341d2cb45159707cfafdc9dc8fdb9d119543480dbaa5773eed8c4a0100000000', - 'total':'0x64', - 'available':'0x64' - } - ], - 'nfts':[ - '0x77133189021f50d8d66e0678e553af9f46a832a24239653d3555edb8dc859e1f', - '0x1e808b7c6e603aaeb5f718881a74fedae72981ac7d5f0294eb561cad0e653566', - '0x1b670afba8d59a445cbaf167f1fda05879362e3ea034f5c4a0979fbeb5a3964b', - '0x3f0e11e9d9f48a57d0fba43d7d1158ee673cb8055f80a5ce45ad174c962c0d8a', - '0xdc8be91d779aac048aa9001ab99ecf12cf62a4701185a95f6206a1a201bfbe7c', - '0xceae643ff7c112a3adce8f55f7953ba0707ade21256a7a09068c0b47f7c62c5b', - '0x17f97185f80fa56eab974de6b7bbb80fa812d4e8e37090d166a0a41da129cebc' - ], - 'aliases':[ - '0x96717e6d19c13b1c5b120d60b23217f541b5b779e51212e01d72e7fa1f7090cf', - '0xa5526c4a15558b709340822edf00cb348d8606a27e2e59b00432a0afe8afb74d', - '0x97eb7a447cd62e1c373ff8188ba422f5c1b0687707d38e10e8366a1c20d33fea', - '0xf9c702ffe50c35d331b2df02295c2cc6d92f883530ff231bd76d1f6a72cb1d95' - ], - 'foundries':[ - '0x08a5526c4a15558b709340822edf00cb348d8606a27e2e59b00432a0afe8afb74d0100000000' - ], - 'potentiallyLockedOutputs':{ - '0x9a5869b61b29f17326e04b6161d9cd169687e79476c556bd0c3cbbc3648d4ff60000':False, - '0x850c1e43dff1a28a42d71edc6d4ad0b9f251c03993f9b0684a34f645514ffe270000':False - } -} -Sent transaction:{ - 'payload':{ - 'type':6, - 'essence':{ - 'type':1, - 'networkId':'1856588631910923207', - 'inputs':[ - { - 'type':0, - 'transactionId':'0x84debb878f8e124f2bd893e04c6672a8ad31788c47a520f77c11bdb03727ef1c', - 'transactionOutputIndex':3 - } - ], - 'inputsCommitment':'0xb70cc0104197c9b9b1bc7199b9093e47d710b0e7e14b7bc09a79ebc7e42e16a1', - 'outputs':[ - { - 'type':6, - 'amount':'47500', - 'nftId':'0x17f97185f80fa56eab974de6b7bbb80fa812d4e8e37090d166a0a41da129cebc', - 'unlockConditions':[ - { - 'type':0, - 'address':{ - 'type':0, - 'pubKeyHash':'0x60200bad8137a704216e84f8f9acfe65b972d9f4155becb4815282b03cef99fe' - } - } - ], - 'features':[ - { - 'type':2, - 'data':'0x68656c6c6f' - } - ], - 'immutableFeatures':[ - { - 'type':2, - 'data':'0x68656c6c6f' - } - ] - } - ] - }, - 'unlocks':[ - { - 'type':0, - 'signature':{ - 'type':0, - 'publicKey':'0xe62838fda7e8b77bf80e49967f0f089ae2a7230547d5231649732952f6336fae', - 'signature':'0x079dfe7ab4830be937757d3362ef5dab8d0d70297ab4dce8a3ab79f2a8b28610ff8d84fe037e642afa28c07a3f87ed2072930f57e9b7f8390e9e117e26966809' - } - } - ] - }, - 'blockId':'0x5c49a0c8b9ee920ca575d895842c43ace5bfd2feb2ccc611eb37ec4cde7acabc', - 'inclusionState':'Pending', - 'timestamp':'1665918220888', - 'transactionId':'0x3158626d7f404bded6af815f104e4001009a3f82fab7f9eb267cc691d039eed5', - 'networkId':'1856588631910923207', - 'incoming':False, - 'note':None -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_03_burn_nft/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_03_burn_nft/_code_sample.mdx deleted file mode 100644 index da94a63d7b0..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_03_burn_nft/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples/burn_nft.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 burn-nft.py -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_03_burn_nft/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_03_burn_nft/_expected_output.md deleted file mode 100644 index 7e00d8cf2a7..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/NFT/_03_burn_nft/_expected_output.md +++ /dev/null @@ -1,50 +0,0 @@ -```json -{ - "payload": { - "type": 6, - "essence": { - "type": 1, - "networkId": "1856588631910923207", - "inputs": [ - { - "type": 0, - "transactionId": "0xf5e022f199d90f2020ab941de947368e9d02a4f05139fcb44f66feade216f150", - "transactionOutputIndex": 0 - } - ], - "inputsCommitment": "0xd64acb6fec68315c200484458fb0a2c1e9b7d06106aecdcb9c86403d955ad69a", - "outputs": [ - { - "type": 3, - "amount": "52000", - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - } - ] - } - ] - }, - "unlocks": [ - { - "type": 0, - "signature": { - "type": 0, - "publicKey": "0xde3152ce9d67415b9c5a042ea01caccc3f73ff1c0c77036874cb8badf9798d56", - "signature": "0xd602074065070b6dada7ce8f5a3c0181a2662443e6e71d7599dcf1464ac04938bdb9b2a39e1f36152cd3226840ab8d63c77d4035a30407ab029b607a7ff4d108" - } - } - ] - }, - "blockId": "0x6bc73ef16d51924154fecf4cc2da1b14297b1aa75ff5261800ab88411185d7c2", - "inclusionState": "Pending", - "timestamp": "1664876190299", - "transactionId": "0x9c26110d611ea78fc0542dca45834abb35497c5ec6045448713f5a588e7f4292", - "networkId": "1856588631910923207", - "incoming": false -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/_more_examples.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/_more_examples.md deleted file mode 100644 index 6f4868fc556..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/_more_examples.md +++ /dev/null @@ -1 +0,0 @@ -More advanced examples can be found in the [examples](https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples) folder. diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/_run_how_tos.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/_run_how_tos.md deleted file mode 100644 index cbc36253eb3..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/_run_how_tos.md +++ /dev/null @@ -1,26 +0,0 @@ -## Prerequisites - -Before you can run the examples, please refer to the [Python Getting Started guide](./../../../getting_started/python.mdx) to install -the library. - -## Run Code Examples - -The wallet.rs library has numerous [examples](https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples) -you can run to get acquainted with the library. After you have followed the instructions to -[install the library](./../../../getting_started/python.mdx#install-the-library), you can run any example with the following -command from the `wallet/bindings/python` directory: - -```bash -python3 example/[example file name] -``` - -Where [example file name] is one of the -[examples](https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples). - -For instance, to run -[`00_get_info.py`](https://github.com/iotaledger/wallet.rs/blob/develop/bindings/python/examples/00_get_info.py), -you should run: - -```bash -python3 examples/00_get_info.py -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_01_create_a_wallet_account/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_01_create_a_wallet_account/_code_sample.mdx deleted file mode 100644 index a42bc076e4f..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_01_create_a_wallet_account/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples/0-create-account.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 0-create-account.py -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_01_create_a_wallet_account/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_01_create_a_wallet_account/_expected_output.md deleted file mode 100644 index 7a23c7eebe1..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_01_create_a_wallet_account/_expected_output.md +++ /dev/null @@ -1,23 +0,0 @@ -```js -{ - 'index': 0, - 'coinType': 4219, - 'alias': 'Alice', - 'publicAddresses': [ - { - 'address': 'rms1qzpf0tzpf8yqej5zyhjl9k3km7y6j0xjnxxh7m2g3jtj2z5grej67sl6l46', - 'keyIndex': 0, - 'internal': False, - 'used': False - } - ], - 'internalAddresses': [], - 'addressesWithUnspentOutputs': [], - 'outputs': {}, - 'lockedOutputs': [], - 'unspentOutputs': {}, - 'transactions': {}, - 'pendingTransactions': [], - 'incomingTransactions': {} -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_02_generate_address/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_02_generate_address/_code_sample.mdx deleted file mode 100644 index 63eddade8cb..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_02_generate_address/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples/1-generate-address.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 1-generate-address.py -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_02_generate_address/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_02_generate_address/_expected_output.md deleted file mode 100644 index d6b6f3f7be8..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_02_generate_address/_expected_output.md +++ /dev/null @@ -1,10 +0,0 @@ -```js -Address: [ - { - address: 'rms1qplwj3pwn0kgamynajff2xqemu7h9rw0as7ayxt8hq0pl5wxfyxwsfdprdu', - keyIndex: 1, - internal: False, - used: False, - }, -]; -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_03_request_funds/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_03_request_funds/_code_sample.mdx deleted file mode 100644 index d964bce9d4d..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_03_request_funds/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```python reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples/request_funds.py -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_03_request_funds/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_03_request_funds/_expected_output.md deleted file mode 100644 index 0d84d06fadd..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_03_request_funds/_expected_output.md +++ /dev/null @@ -1,4 +0,0 @@ -``` -balance before faucet request: 0 -available account balance after faucet request: 1000000000 -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_04_check_balance/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_04_check_balance/_code_sample.mdx deleted file mode 100644 index 4fcb6d361ef..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_04_check_balance/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples/2-check-balance.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 2-check-balance.py -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_04_check_balance/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_04_check_balance/_expected_output.md deleted file mode 100644 index 01905eec570..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_04_check_balance/_expected_output.md +++ /dev/null @@ -1,70 +0,0 @@ -``` -Synced: { - 'baseCoin': { - 'total': '3490057203', - 'available': '3490057203' - }, - 'requiredStorageDeposit': '98250300', - 'nativeTokens': [ - { - 'tokenId': '0x08b83d49922e341d2cb45159707cfafdc9dc8fdb9d119543480dbaa5773eed8c4a0100000000', - 'total': '0x64', - 'available': '0x64' - } - ], - 'nfts': [ - '0xceae643ff7c112a3adce8f55f7953ba0707ade21256a7a09068c0b47f7c62c5b', - '0x1e808b7c6e603aaeb5f718881a74fedae72981ac7d5f0294eb561cad0e653566', - '0x77133189021f50d8d66e0678e553af9f46a832a24239653d3555edb8dc859e1f', - '0x17f97185f80fa56eab974de6b7bbb80fa812d4e8e37090d166a0a41da129cebc', - '0x1b670afba8d59a445cbaf167f1fda05879362e3ea034f5c4a0979fbeb5a3964b', - '0x3f0e11e9d9f48a57d0fba43d7d1158ee673cb8055f80a5ce45ad174c962c0d8a', - '0xdc8be91d779aac048aa9001ab99ecf12cf62a4701185a95f6206a1a201bfbe7c' - ], - 'aliases': [ - - ], - 'foundries': [ - - ], - 'potentiallyLockedOutputs': { - '0x8dd4f722a18f3b5822216e856a98ea480fbfaa205f10c08d36dc5ab21efcc8355600': False - }[ - ... - ] -] - -Balance: { - 'baseCoin': { - 'total': '3490057203', - 'available': '3490057203' - }, - 'requiredStorageDeposit': '98250300', - 'nativeTokens': [ - { - 'tokenId': '0x08b83d49922e341d2cb45159707cfafdc9dc8fdb9d119543480dbaa5773eed8c4a0100000000', - 'total': '0x64', - 'available': '0x64' - } - ], - 'nfts': [ - '0xceae643ff7c112a3adce8f55f7953ba0707ade21256a7a09068c0b47f7c62c5b', - '0x1e808b7c6e603aaeb5f718881a74fedae72981ac7d5f0294eb561cad0e653566', - '0x77133189021f50d8d66e0678e553af9f46a832a24239653d3555edb8dc859e1f', - '0x17f97185f80fa56eab974de6b7bbb80fa812d4e8e37090d166a0a41da129cebc', - '0x1b670afba8d59a445cbaf167f1fda05879362e3ea034f5c4a0979fbeb5a3964b', - '0x3f0e11e9d9f48a57d0fba43d7d1158ee673cb8055f80a5ce45ad174c962c0d8a', - '0xdc8be91d779aac048aa9001ab99ecf12cf62a4701185a95f6206a1a201bfbe7c' - ], - 'aliases': [ - - ], - 'foundries': [ - - ], - 'potentiallyLockedOutputs': { - '0xa10af6cc21fa0b1b67962af7082eb25d8b4aafe50fedda469179f469ab5e33be5300': False, - [...] - } -] -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_05_backup/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_05_backup/_code_sample.mdx deleted file mode 100644 index 86588d36e8b..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_05_backup/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```python reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples/backup.py -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_05_backup/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_05_backup/_expected_output.md deleted file mode 100644 index d39de444d93..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/accounts_and_addresses/_05_backup/_expected_output.md +++ /dev/null @@ -1,3 +0,0 @@ -```plaintext -Created backup -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_01_mint_native_tokens/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_01_mint_native_tokens/_code_sample.mdx deleted file mode 100644 index 90c50771b2e..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_01_mint_native_tokens/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples/7-mint-native-tokens.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 7-mint-native-tokens.py -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_01_mint_native_tokens/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_01_mint_native_tokens/_expected_output.md deleted file mode 100644 index 8b735589138..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_01_mint_native_tokens/_expected_output.md +++ /dev/null @@ -1,171 +0,0 @@ -``` -Synced:{ - 'baseCoin':{ - 'total':'3302230302', - 'available':'3302230302' - }, - 'requiredStorageDeposit':'910310000', - 'nativeTokens':[ - { - 'tokenId':'0x08b83d49922e341d2cb45159707cfafdc9dc8fdb9d119543480dbaa5773eed8c4a0100000000', - 'total':'0x64', - 'available':'0x64' - } - ], - 'nfts':[ - '0x17f97185f80fa56eab974de6b7bbb80fa812d4e8e37090d166a0a41da129cebc', - '0xdc8be91d779aac048aa9001ab99ecf12cf62a4701185a95f6206a1a201bfbe7c', - '0x1e808b7c6e603aaeb5f718881a74fedae72981ac7d5f0294eb561cad0e653566', - '0x3f0e11e9d9f48a57d0fba43d7d1158ee673cb8055f80a5ce45ad174c962c0d8a', - '0x77133189021f50d8d66e0678e553af9f46a832a24239653d3555edb8dc859e1f', - '0xceae643ff7c112a3adce8f55f7953ba0707ade21256a7a09068c0b47f7c62c5b', - '0x1b670afba8d59a445cbaf167f1fda05879362e3ea034f5c4a0979fbeb5a3964b' - ], - 'aliases':[ - '0xa5526c4a15558b709340822edf00cb348d8606a27e2e59b00432a0afe8afb74d', - '0xf9c702ffe50c35d331b2df02295c2cc6d92f883530ff231bd76d1f6a72cb1d95', - '0x97eb7a447cd62e1c373ff8188ba422f5c1b0687707d38e10e8366a1c20d33fea' - ], - 'foundries':[ - - ], - 'potentiallyLockedOutputs':{ - '0x850c1e43dff1a28a42d71edc6d4ad0b9f251c03993f9b0684a34f645514ffe270000':False - } -} -Sent transaction:{ - 'tokenId':'0x08a5526c4a15558b709340822edf00cb348d8606a27e2e59b00432a0afe8afb74d0100000000', - 'transaction':{ - 'payload':{ - 'type':6, - 'essence':{ - 'type':1, - 'networkId':'1856588631910923207', - 'inputs':[ - { - 'type':0, - 'transactionId':'0x8defcb4d5bc2dd45ca616b01d87399eef5bde2bfb4d9f33695a0cab78cb731f0', - 'transactionOutputIndex':0 - }, - { - 'type':0, - 'transactionId':'0x0220b5247654d05529f40b3d8cdb7ca6f89627038f47a68aa578b9e675ddc937', - 'transactionOutputIndex':29 - }, - { - 'type':0, - 'transactionId':'0x0220b5247654d05529f40b3d8cdb7ca6f89627038f47a68aa578b9e675ddc937', - 'transactionOutputIndex':30 - }, - { - 'type':0, - 'transactionId':'0x0220b5247654d05529f40b3d8cdb7ca6f89627038f47a68aa578b9e675ddc937', - 'transactionOutputIndex':31 - } - ], - 'inputsCommitment':'0xeefde614b74d871154856ad4a8a53214492ee8859a3faef4cafa92afe36f12c5', - 'outputs':[ - { - 'type':4, - 'amount':'50300', - 'aliasId':'0xa5526c4a15558b709340822edf00cb348d8606a27e2e59b00432a0afe8afb74d', - 'stateIndex':1, - 'stateMetadata':'0x', - 'foundryCounter':1, - 'unlockConditions':[ - { - 'type':4, - 'address':{ - 'type':0, - 'pubKeyHash':'0x8297ac4149c80cca8225e5f2da36df89a93cd2998d7f6d488c97250a881e65af' - } - }, - { - 'type':5, - 'address':{ - 'type':0, - 'pubKeyHash':'0x8297ac4149c80cca8225e5f2da36df89a93cd2998d7f6d488c97250a881e65af' - } - } - ] - }, - { - 'type':5, - 'amount':'53200', - 'serialNumber':1, - 'tokenScheme':{ - 'type':0, - 'mintedTokens':'0x3e8', - 'meltedTokens':'0x0', - 'maximumSupply':'0x3e8' - }, - 'unlockConditions':[ - { - 'type':6, - 'address':{ - 'type':8, - 'aliasId':'0xa5526c4a15558b709340822edf00cb348d8606a27e2e59b00432a0afe8afb74d' - } - } - ], - 'immutableFeatures':[ - { - 'type':2, - 'data':'0xab' - } - ] - }, - { - 'type':3, - 'amount':'98600', - 'nativeTokens':[ - { - 'id':'0x08a5526c4a15558b709340822edf00cb348d8606a27e2e59b00432a0afe8afb74d0100000000', - 'amount':'0x3e8' - } - ], - 'unlockConditions':[ - { - 'type':0, - 'address':{ - 'type':0, - 'pubKeyHash':'0x8297ac4149c80cca8225e5f2da36df89a93cd2998d7f6d488c97250a881e65af' - } - } - ] - } - ] - }, - 'unlocks':[ - { - 'type':0, - 'signature':{ - 'type':0, - 'publicKey':'0xe62838fda7e8b77bf80e49967f0f089ae2a7230547d5231649732952f6336fae', - 'signature':'0x47578dd3a390483d4de390f5f6ccc7af5838a9b0fb1ba0c519948c0d8638b4c0b86d0676f5fa616d5fdae53fec0fdacef72248a92ac388d8a20134528949380c' - } - }, - { - 'type':1, - 'reference':0 - }, - { - 'type':1, - 'reference':0 - }, - { - 'type':1, - 'reference':0 - } - ] - }, - 'blockId':'0x50e0b55c5e618e3cb214a774c9574522e5b30118bebdef6cbb23c9cffeb2b347', - 'inclusionState':'Pending', - 'timestamp':'1665917714656', - 'transactionId':'0x9d1e61384fc78777c8db475a3d6eaec6465c136dc3ce586ee46a9453aa3dfdc4', - 'networkId':'1856588631910923207', - 'incoming':False, - 'note':None - } -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_02_send_native_tokens/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_02_send_native_tokens/_code_sample.mdx deleted file mode 100644 index 1fff7597422..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_02_send_native_tokens/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples/5-send-native-tokens.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 5-send-native-tokens.py -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_02_send_native_tokens/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_02_send_native_tokens/_expected_output.md deleted file mode 100644 index 1a9854f70f7..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_02_send_native_tokens/_expected_output.md +++ /dev/null @@ -1,141 +0,0 @@ -``` -Synced:{ - 'baseCoin':{ - 'total':'3302230302', - 'available':'3302230302' - }, - 'requiredStorageDeposit':'910252700', - 'nativeTokens':[ - { - 'tokenId':'0x08a5526c4a15558b709340822edf00cb348d8606a27e2e59b00432a0afe8afb74d0100000000', - 'total':'0x3e8', - 'available':'0x3e8' - }, - { - 'tokenId':'0x08b83d49922e341d2cb45159707cfafdc9dc8fdb9d119543480dbaa5773eed8c4a0100000000', - 'total':'0x64', - 'available':'0x64' - } - ], - 'nfts':[ - '0x17f97185f80fa56eab974de6b7bbb80fa812d4e8e37090d166a0a41da129cebc', - '0xdc8be91d779aac048aa9001ab99ecf12cf62a4701185a95f6206a1a201bfbe7c', - '0xceae643ff7c112a3adce8f55f7953ba0707ade21256a7a09068c0b47f7c62c5b', - '0x1b670afba8d59a445cbaf167f1fda05879362e3ea034f5c4a0979fbeb5a3964b', - '0x1e808b7c6e603aaeb5f718881a74fedae72981ac7d5f0294eb561cad0e653566', - '0x3f0e11e9d9f48a57d0fba43d7d1158ee673cb8055f80a5ce45ad174c962c0d8a', - '0x77133189021f50d8d66e0678e553af9f46a832a24239653d3555edb8dc859e1f' - ], - 'aliases':[ - '0x97eb7a447cd62e1c373ff8188ba422f5c1b0687707d38e10e8366a1c20d33fea', - '0xf9c702ffe50c35d331b2df02295c2cc6d92f883530ff231bd76d1f6a72cb1d95', - '0xa5526c4a15558b709340822edf00cb348d8606a27e2e59b00432a0afe8afb74d', - '0x96717e6d19c13b1c5b120d60b23217f541b5b779e51212e01d72e7fa1f7090cf' - ], - 'foundries':[ - '0x08a5526c4a15558b709340822edf00cb348d8606a27e2e59b00432a0afe8afb74d0100000000' - ], - 'potentiallyLockedOutputs':{ - '0x850c1e43dff1a28a42d71edc6d4ad0b9f251c03993f9b0684a34f645514ffe270000':False - } -} -Sent transaction:{ - 'payload':{ - 'type':6, - 'essence':{ - 'type':1, - 'networkId':'1856588631910923207', - 'inputs':[ - { - 'type':0, - 'transactionId':'0x9d1e61384fc78777c8db475a3d6eaec6465c136dc3ce586ee46a9453aa3dfdc4', - 'transactionOutputIndex':2 - }, - { - 'type':0, - 'transactionId':'0x0220b5247654d05529f40b3d8cdb7ca6f89627038f47a68aa578b9e675ddc937', - 'transactionOutputIndex':32 - } - ], - 'inputsCommitment':'0xff484e025ea72e4ae90d556b645c01f8f763235caac2d128359f1a6410a65c86', - 'outputs':[ - { - 'type':3, - 'amount':'57600', - 'nativeTokens':[ - { - 'id':'0x08a5526c4a15558b709340822edf00cb348d8606a27e2e59b00432a0afe8afb74d0100000000', - 'amount':'0xa' - } - ], - 'unlockConditions':[ - { - 'type':0, - 'address':{ - 'type':0, - 'pubKeyHash':'0x60200bad8137a704216e84f8f9acfe65b972d9f4155becb4815282b03cef99fe' - } - }, - { - 'type':1, - 'returnAddress':{ - 'type':0, - 'pubKeyHash':'0x8297ac4149c80cca8225e5f2da36df89a93cd2998d7f6d488c97250a881e65af' - }, - 'amount':'57600' - }, - { - 'type':3, - 'returnAddress':{ - 'type':0, - 'pubKeyHash':'0x8297ac4149c80cca8225e5f2da36df89a93cd2998d7f6d488c97250a881e65af' - }, - 'unixTime':1666004529 - } - ] - }, - { - 'type':3, - 'amount':'91600', - 'nativeTokens':[ - { - 'id':'0x08a5526c4a15558b709340822edf00cb348d8606a27e2e59b00432a0afe8afb74d0100000000', - 'amount':'0x3de' - } - ], - 'unlockConditions':[ - { - 'type':0, - 'address':{ - 'type':0, - 'pubKeyHash':'0x8297ac4149c80cca8225e5f2da36df89a93cd2998d7f6d488c97250a881e65af' - } - } - ] - } - ] - }, - 'unlocks':[ - { - 'type':0, - 'signature':{ - 'type':0, - 'publicKey':'0xe62838fda7e8b77bf80e49967f0f089ae2a7230547d5231649732952f6336fae', - 'signature':'0x1c90f0d05b6b3902ebc1e8ad489432bdc16e0810179671ad091c5d93b920dc4151eb38f13a4a9b3018d2132e8ca3e8a79788478f5d5b6826b262ca0c3658eb09' - } - }, - { - 'type':1, - 'reference':0 - } - ] - }, - 'blockId':'0xabddf4905e86ed11ea2ab2784fdf5a79a1176ef2f353dc0f2db80537d17d59b0', - 'inclusionState':'Pending', - 'timestamp':'1665918129925', - 'transactionId':'0x9a5869b61b29f17326e04b6161d9cd169687e79476c556bd0c3cbbc3648d4ff6', - 'networkId':'1856588631910923207', - 'incoming':False, - 'note':None -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_03_melt_native_token/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_03_melt_native_token/_code_sample.mdx deleted file mode 100644 index 3a61337dd4e..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_03_melt_native_token/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```python reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples/decrease-native-tokens-supply.py -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_03_melt_native_token/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_03_melt_native_token/_expected_output.md deleted file mode 100644 index 0bf63cc9987..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_03_melt_native_token/_expected_output.md +++ /dev/null @@ -1,118 +0,0 @@ -```json -{ - "payload": { - "type": 6, - "essence": { - "type": 1, - "networkId": "1856588631910923207", - "inputs": [ - { - "type": 0, - "transactionId": "0xbd9dc768e5676e9d141ab96622143127328c10361f319f919365c480972dbe83", - "transactionOutputIndex": 0 - }, - { - "type": 0, - "transactionId": "0xbd9dc768e5676e9d141ab96622143127328c10361f319f919365c480972dbe83", - "transactionOutputIndex": 1 - }, - { - "type": 0, - "transactionId": "0xbd9dc768e5676e9d141ab96622143127328c10361f319f919365c480972dbe83", - "transactionOutputIndex": 2 - } - ], - "inputsCommitment": "0xaea8c0e6b4af1afb241b9d4b850b54438dff3e5dfe36a54f1bbaccdc81d1b245", - "outputs": [ - { - "type": 4, - "amount": "50300", - "aliasId": "0x429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef", - "stateIndex": 6, - "stateMetadata": "0x", - "foundriesCounter": 0, - "unlockConditions": [ - { - "type": 4, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - }, - { - "type": 5, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - } - ] - }, - { - "type": 5, - "amount": "52800", - "serialNumber": 3, - "tokenScheme": { - "type": 0, - "mintedTokens": "0x17", - "meltedTokens": "0x2", - "maximumSupply": "0x64" - }, - "unlockConditions": [ - { - "type": 6, - "address": { - "type": 8, - "aliasId": "0x429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef" - } - } - ] - }, - { - "type": 3, - "amount": "57600", - "nativeTokens": [ - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0300000000", - "amount": "0x15" - } - ], - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - } - ] - } - ] - }, - "unlocks": [ - { - "type": 0, - "signature": { - "type": 0, - "publicKey": "0xde3152ce9d67415b9c5a042ea01caccc3f73ff1c0c77036874cb8badf9798d56", - "signature": "0xc9c5369388d5fce9297c816612af93eea35b34d1fd4575de9b5ba5f477186e84f2affe6a2ba230beb1d47e3e5ee31f20d484a857e9c3d18fe0fe5e334d6f1202" - } - }, - { - "type": 2, - "reference": 0 - }, - { - "type": 1, - "reference": 0 - } - ] - }, - "blockId": "0x063c35701e459cb6515cd0be7d0ed691fd622f5a2dc3bb126213a4f06910ab54", - "inclusionState": "Pending", - "timestamp": "1664885556280", - "transactionId": "0xcbcfbbd9b36bd9a3d6830311ed428036d13fc37050bcd1cf82fb4e4b695570fd", - "networkId": "1856588631910923207", - "incoming": false -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_04_burn_native_token/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_04_burn_native_token/_code_sample.mdx deleted file mode 100644 index 56fd59b9ac5..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_04_burn_native_token/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```python reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples/burn_native_tokens.py -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_04_burn_native_token/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_04_burn_native_token/_expected_output.md deleted file mode 100644 index b11cd764dca..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_04_burn_native_token/_expected_output.md +++ /dev/null @@ -1,56 +0,0 @@ -```json -{ - "payload": { - "type": 6, - "essence": { - "type": 1, - "networkId": "1856588631910923207", - "inputs": [ - { - "type": 0, - "transactionId": "0xcbcfbbd9b36bd9a3d6830311ed428036d13fc37050bcd1cf82fb4e4b695570fd", - "transactionOutputIndex": 2 - } - ], - "inputsCommitment": "0x3f44d0e0f31bd57f028d80d8c9b07b0e12406e6cd5b2e8b6ed0abd178a1e1b1b", - "outputs": [ - { - "type": 3, - "amount": "57600", - "nativeTokens": [ - { - "id": "0x08429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef0300000000", - "amount": "0x10" - } - ], - "unlockConditions": [ - { - "type": 0, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - } - ] - } - ] - }, - "unlocks": [ - { - "type": 0, - "signature": { - "type": 0, - "publicKey": "0xde3152ce9d67415b9c5a042ea01caccc3f73ff1c0c77036874cb8badf9798d56", - "signature": "0xfd9964cdcfa6bda25419968c3d74d29e35611bbc2a9ddad2be0eadc816da270fcf739c2e7ecc4be4e46f33b32aa37370534e0ee322c23755ecb608de9618ae0a" - } - } - ] - }, - "blockId": "0xb53140f385372ca247d7d66ee14755a2e18d8ca750fd85122a6b5b6b0c1abf7c", - "inclusionState": "Pending", - "timestamp": "1664885731096", - "transactionId": "0xbb7f884e81ed32dbfe4f9c880b0f6577c9c90744b7ab33d84950706d2924c18c", - "networkId": "1856588631910923207", - "incoming": false -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_05_destroy_foundry/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_05_destroy_foundry/_code_sample.mdx deleted file mode 100644 index 234da7aaedc..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_05_destroy_foundry/_code_sample.mdx +++ /dev/null @@ -1,3 +0,0 @@ -```python reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples/destroy_foundry.py -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_05_destroy_foundry/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_05_destroy_foundry/_expected_output.md deleted file mode 100644 index e2727972817..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/native_tokens/_05_destroy_foundry/_expected_output.md +++ /dev/null @@ -1,70 +0,0 @@ -```json -{ - "payload": { - "type": 6, - "essence": { - "type": 1, - "networkId": "1856588631910923207", - "inputs": [ - { - "type": 0, - "transactionId": "0x27df04eac1408b4ec758f6aa222d616b21d9b237789e601d9d0b81aa6466fa97", - "transactionOutputIndex": 0 - }, - { - "type": 0, - "transactionId": "0x27df04eac1408b4ec758f6aa222d616b21d9b237789e601d9d0b81aa6466fa97", - "transactionOutputIndex": 1 - } - ], - "inputsCommitment": "0x06e8bdc8ddf5dac739e620f815aade7f73d06a33a911e1e6956d1f8d087ad6e3", - "outputs": [ - { - "type": 4, - "amount": "103100", - "aliasId": "0x429fe5864378ce70699fc2d22bb144cb86a3c4833d136e3b95c5dadfd6ba0cef", - "stateIndex": 9, - "stateMetadata": "0x", - "foundriesCounter": 0, - "unlockConditions": [ - { - "type": 4, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - }, - { - "type": 5, - "address": { - "type": 0, - "pubKeyHash": "0x4cfde0600797ae07d19d67d78910e70950bfdaf716f0035e9a30b97828aaf6a2" - } - } - ] - } - ] - }, - "unlocks": [ - { - "type": 0, - "signature": { - "type": 0, - "publicKey": "0xde3152ce9d67415b9c5a042ea01caccc3f73ff1c0c77036874cb8badf9798d56", - "signature": "0xb0a0473eb7dc09231707b11a04ad3a2fee9d67dd83f00e27ddbdc11f4473080ff8ac9a78d5dfb83da8bf1e8e77dc5c6cd867a28dc7520dc0f01dd49ce7815a02" - } - }, - { - "type": 2, - "reference": 0 - } - ] - }, - "blockId": "0xf76fc85a74e1ac5381ff25777fef8a1c9ffb98bdad83157151bc8804bf496861", - "inclusionState": "Pending", - "timestamp": "1664886716685", - "transactionId": "0xce5504e02bf0796e48143d5daa1753500e798dbab673e14bb671512750f7d03a", - "networkId": "1856588631910923207", - "incoming": false -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_01_send_transaction/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_01_send_transaction/_code_sample.mdx deleted file mode 100644 index ed3b78d9f3e..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_01_send_transaction/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples/3-send-transaction.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 3-send-transaction.py -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_01_send_transaction/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_01_send_transaction/_expected_output.md deleted file mode 100644 index 317491e51da..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_01_send_transaction/_expected_output.md +++ /dev/null @@ -1,99 +0,0 @@ -``` -Synced: { - 'baseCoin': { - 'total': '3490057203', - 'available': '3490057203' - }, - 'requiredStorageDeposit': '98250300', - 'nativeTokens': [ - { - 'tokenId': '0x08b83d49922e341d2cb45159707cfafdc9dc8fdb9d119543480dbaa5773eed8c4a0100000000', - 'total': '0x64', - 'available': '0x64' - } - ], - 'nfts': [ - '0xceae643ff7c112a3adce8f55f7953ba0707ade21256a7a09068c0b47f7c62c5b', - '0x1e808b7c6e603aaeb5f718881a74fedae72981ac7d5f0294eb561cad0e653566', - '0x77133189021f50d8d66e0678e553af9f46a832a24239653d3555edb8dc859e1f', - '0x17f97185f80fa56eab974de6b7bbb80fa812d4e8e37090d166a0a41da129cebc', - '0x1b670afba8d59a445cbaf167f1fda05879362e3ea034f5c4a0979fbeb5a3964b', - '0x3f0e11e9d9f48a57d0fba43d7d1158ee673cb8055f80a5ce45ad174c962c0d8a', - '0xdc8be91d779aac048aa9001ab99ecf12cf62a4701185a95f6206a1a201bfbe7c' - ], - 'aliases': [ - - ], - 'foundries': [ - - ], - 'potentiallyLockedOutputs': { - '0x8dd4f722a18f3b5822216e856a98ea480fbfaa205f10c08d36dc5ab21efcc8355600': False - }[ - ... - ] -] - -Senttransaction: { - 'payload': { - 'type': 6, - 'essence': { - 'type': 1, - 'networkId': '1856588631910923207', - 'inputs': [ - { - 'type': 0, - 'transactionId': '0x29ddaad7f39b1bd0e48e922984cc9556ecb895ad3ee49aec959730920af7382f', - 'transactionOutputIndex': 0 - } - ], - 'inputsCommitment': '0x2f70c8557f53f8c2483eceab991c6b7f5dad9895cd0c3785e774f26adbe04394', - 'outputs': [ - { - 'type': 3, - 'amount': '1000000', - 'unlockConditions': [ - { - 'type': 0, - 'address': { - 'type': 0, - 'pubKeyHash': '0x60200bad8137a704216e84f8f9acfe65b972d9f4155becb4815282b03cef99fe' - } - } - ] - }, - { - 'type': 3, - 'amount': '999000000', - 'unlockConditions': [ - { - 'type': 0, - 'address': { - 'type': 0, - 'pubKeyHash': '0x7ee9442e9bec8eec93ec92951819df3d728dcfec3dd21967b81e1fd1c6490ce8' - } - } - ] - } - ] - }, - 'unlocks': [ - { - 'type': 0, - 'signature': { - 'type': 0, - 'publicKey': '0x4a654582703d09ea79c172d7bb475c439b8ad60234ee8adc7636a31d32970ed5', - 'signature': '0xc34a5c29f627a1f664233786d29cdf8dde726970c22c7418370459ef4a8df887c007d2d05caebccda3edc34fd12eb0b1ffad849a43a1ae7057482b0420c4590c' - } - } - ] - }, - 'blockId': '0xe187bd31ef751897a55f08dde47ef8560e3b2f96af1de77dac4f714a1e757517', - 'inclusionState': 'Pending', - 'timestamp': '1662654181658', - 'transactionId': '0xb40d2a02805712bd88c5d3663eee228379a4acdd365fbc301d9cf79c46540c72', - 'networkId': '1856588631910923207', - 'incoming': False, - 'note': None -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_02_send_micro_transaction/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_02_send_micro_transaction/_code_sample.mdx deleted file mode 100644 index b1ef09fcffb..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_02_send_micro_transaction/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples/4-send-micro-transaction.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 4-send-micro-transaction.py -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_02_send_micro_transaction/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_02_send_micro_transaction/_expected_output.md deleted file mode 100644 index 080a5c1b377..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_02_send_micro_transaction/_expected_output.md +++ /dev/null @@ -1,121 +0,0 @@ -``` -Synced:{ - 'baseCoin':{ - 'total':'3302280903', - 'available':'3302280903' - }, - 'requiredStorageDeposit':'910393500', - 'nativeTokens':[ - { - 'tokenId':'0x08b83d49922e341d2cb45159707cfafdc9dc8fdb9d119543480dbaa5773eed8c4a0100000000', - 'total':'0x64', - 'available':'0x64' - } - ], - 'nfts':[ - '0xdc8be91d779aac048aa9001ab99ecf12cf62a4701185a95f6206a1a201bfbe7c', - '0x1b670afba8d59a445cbaf167f1fda05879362e3ea034f5c4a0979fbeb5a3964b', - '0x17f97185f80fa56eab974de6b7bbb80fa812d4e8e37090d166a0a41da129cebc', - '0x1e808b7c6e603aaeb5f718881a74fedae72981ac7d5f0294eb561cad0e653566', - '0xceae643ff7c112a3adce8f55f7953ba0707ade21256a7a09068c0b47f7c62c5b', - '0x77133189021f50d8d66e0678e553af9f46a832a24239653d3555edb8dc859e1f', - '0x3f0e11e9d9f48a57d0fba43d7d1158ee673cb8055f80a5ce45ad174c962c0d8a' - ], - 'aliases':[ - - ], - 'foundries':[ - - ], - 'potentiallyLockedOutputs':{ - - } -} -Sent transaction:{ - 'payload':{ - 'type':6, - 'essence':{ - 'type':1, - 'networkId':'1856588631910923207', - 'inputs':[ - { - 'type':0, - 'transactionId':'0x0220b5247654d05529f40b3d8cdb7ca6f89627038f47a68aa578b9e675ddc937', - 'transactionOutputIndex':19 - }, - { - 'type':0, - 'transactionId':'0x0220b5247654d05529f40b3d8cdb7ca6f89627038f47a68aa578b9e675ddc937', - 'transactionOutputIndex':20 - } - ], - 'inputsCommitment':'0x106eac89e7db625c039af5193be5050a57c431e68d1c331bb323d36f0d4dc812', - 'outputs':[ - { - 'type':3, - 'amount':'50601', - 'unlockConditions':[ - { - 'type':0, - 'address':{ - 'type':0, - 'pubKeyHash':'0x60200bad8137a704216e84f8f9acfe65b972d9f4155becb4815282b03cef99fe' - } - }, - { - 'type':1, - 'returnAddress':{ - 'type':0, - 'pubKeyHash':'0x8297ac4149c80cca8225e5f2da36df89a93cd2998d7f6d488c97250a881e65af' - }, - 'amount':'50600' - }, - { - 'type':3, - 'returnAddress':{ - 'type':0, - 'pubKeyHash':'0x8297ac4149c80cca8225e5f2da36df89a93cd2998d7f6d488c97250a881e65af' - }, - 'unixTime':1666003100 - } - ] - }, - { - 'type':3, - 'amount':'50599', - 'unlockConditions':[ - { - 'type':0, - 'address':{ - 'type':0, - 'pubKeyHash':'0x8297ac4149c80cca8225e5f2da36df89a93cd2998d7f6d488c97250a881e65af' - } - } - ] - } - ] - }, - 'unlocks':[ - { - 'type':0, - 'signature':{ - 'type':0, - 'publicKey':'0xe62838fda7e8b77bf80e49967f0f089ae2a7230547d5231649732952f6336fae', - 'signature':'0xf232856bbbc386277820fa30db7ba0b151ff8eea162732001ab532b8650c800880ac2fc6f28cab74ca752a6cbfdc046e860f0a08e99355d0a71f6c18b1d15906' - } - }, - { - 'type':1, - 'reference':0 - } - ] - }, - 'blockId':'0xfe42f0281946d1b5bdd8ad185c7849163a0f86c49a22300ea5fd4bb53afba258', - 'inclusionState':'Pending', - 'timestamp':'1665916700678', - 'transactionId':'0x850c1e43dff1a28a42d71edc6d4ad0b9f251c03993f9b0684a34f645514ffe27', - 'networkId':'1856588631910923207', - 'incoming':False, - 'note':None -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_03_list_outputs/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_03_list_outputs/_code_sample.mdx deleted file mode 100644 index 9b2348f7a06..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_03_list_outputs/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples/9-list-outputs.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 9-list-outputs.py -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_03_list_outputs/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_03_list_outputs/_expected_output.md deleted file mode 100644 index a5e7a986514..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_03_list_outputs/_expected_output.md +++ /dev/null @@ -1,164 +0,0 @@ -``` -Outputs:[ - { - 'outputId':'0xf4676daae96cf629c04d8d62989dec6d9dbbac221959d72c399729f92047ec140000', - 'metadata':{ - 'blockId':'0x77b1fec7bd1ebb9ecfdf1ed9501dbf17acc4b1aa3889f310be95d5d82a5b5674', - 'transactionId':'0xf4676daae96cf629c04d8d62989dec6d9dbbac221959d72c399729f92047ec14', - 'outputIndex':0, - 'isSpent':False, - 'milestoneIndexBooked':1571314, - 'milestoneTimestampBooked':1665991915, - 'ledgerIndex':1571314 - }, - 'output':{ - 'type':3, - 'amount':'1000000000', - 'unlockConditions':[ - { - 'type':0, - 'address':{ - 'type':0, - 'pubKeyHash':'0xf4d94c9f4e63d553c81e644225fa3bbc412f820c4eafd495aeb0bb05a29922b2' - } - } - ] - }, - 'isSpent':False, - 'address':{ - 'type':0, - 'pubKeyHash':'0xf4d94c9f4e63d553c81e644225fa3bbc412f820c4eafd495aeb0bb05a29922b2' - }, - 'networkId':'1856588631910923207', - 'remainder':False, - 'chain':[ - { - 'hardened':True, - 'bs':[ - 128, - 0, - 0, - 44 - ] - }, - { - 'hardened':True, - 'bs':[ - 128, - 0, - 16, - 123 - ] - }, - { - 'hardened':True, - 'bs':[ - 128, - 0, - 0, - 0 - ] - }, - { - 'hardened':True, - 'bs':[ - 128, - 0, - 0, - 0 - ] - }, - { - 'hardened':True, - 'bs':[ - 128, - 0, - 0, - 0 - ] - } - ] - } -] -Unspent outputs:[ - { - 'outputId':'0xf4676daae96cf629c04d8d62989dec6d9dbbac221959d72c399729f92047ec140000', - 'metadata':{ - 'blockId':'0x77b1fec7bd1ebb9ecfdf1ed9501dbf17acc4b1aa3889f310be95d5d82a5b5674', - 'transactionId':'0xf4676daae96cf629c04d8d62989dec6d9dbbac221959d72c399729f92047ec14', - 'outputIndex':0, - 'isSpent':False, - 'milestoneIndexBooked':1571314, - 'milestoneTimestampBooked':1665991915, - 'ledgerIndex':1571314 - }, - 'output':{ - 'type':3, - 'amount':'1000000000', - 'unlockConditions':[ - { - 'type':0, - 'address':{ - 'type':0, - 'pubKeyHash':'0xf4d94c9f4e63d553c81e644225fa3bbc412f820c4eafd495aeb0bb05a29922b2' - } - } - ] - }, - 'isSpent':False, - 'address':{ - 'type':0, - 'pubKeyHash':'0xf4d94c9f4e63d553c81e644225fa3bbc412f820c4eafd495aeb0bb05a29922b2' - }, - 'networkId':'1856588631910923207', - 'remainder':False, - 'chain':[ - { - 'hardened':True, - 'bs':[ - 128, - 0, - 0, - 44 - ] - }, - { - 'hardened':True, - 'bs':[ - 128, - 0, - 16, - 123 - ] - }, - { - 'hardened':True, - 'bs':[ - 128, - 0, - 0, - 0 - ] - }, - { - 'hardened':True, - 'bs':[ - 128, - 0, - 0, - 0 - ] - }, - { - 'hardened':True, - 'bs':[ - 128, - 0, - 0, - 0 - ] - } - ] - } -] -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_04_claim_outputs/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_04_claim_outputs/_code_sample.mdx deleted file mode 100644 index ca76bc9822c..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_04_claim_outputs/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples/10-claim-outputs.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 10-claim-outputs.py -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_04_claim_outputs/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_04_claim_outputs/_expected_output.md deleted file mode 100644 index 99956eb96b3..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_04_claim_outputs/_expected_output.md +++ /dev/null @@ -1,76 +0,0 @@ -``` -Available outputs to claim:[ - '0x79edb042038431009408d734a337f6fae9dcec97b0d7572665d0c184ea74b82f0000' -] -Sent transaction:{ - 'payload':{ - 'type':6, - 'essence':{ - 'type':1, - 'networkId':'1856588631910923207', - 'inputs':[ - { - 'type':0, - 'transactionId':'0x79edb042038431009408d734a337f6fae9dcec97b0d7572665d0c184ea74b82f', - 'transactionOutputIndex':0 - }, - { - 'type':0, - 'transactionId':'0xf4676daae96cf629c04d8d62989dec6d9dbbac221959d72c399729f92047ec14', - 'transactionOutputIndex':0 - } - ], - 'inputsCommitment':'0x51a6fe8c7670746c2a45f620be0055c1853f84599c68490a7258ee3c41ba2332', - 'outputs':[ - { - 'type':3, - 'amount':'50600', - 'unlockConditions':[ - { - 'type':0, - 'address':{ - 'type':0, - 'pubKeyHash':'0xf8ba764448d689422aa59a5c5dc97108450a29cb8956208f631ab4a82338468a' - } - } - ] - }, - { - 'type':3, - 'amount':'1000000001', - 'unlockConditions':[ - { - 'type':0, - 'address':{ - 'type':0, - 'pubKeyHash':'0xf4d94c9f4e63d553c81e644225fa3bbc412f820c4eafd495aeb0bb05a29922b2' - } - } - ] - } - ] - }, - 'unlocks':[ - { - 'type':0, - 'signature':{ - 'type':0, - 'publicKey':'0xee4164cca9a455db3164ec2a3c3ebc2db57aec8c4cb3231c3dc6cda0c700e1bd', - 'signature':'0xf474de893c5a47d9114d2a95f1bd0e4c83b464e8a17886a07ea8d04046949a17dbb8173183c08d4cadbe530c7f42a65fa3286a5f28644a76cf59f6411a04220f' - } - }, - { - 'type':1, - 'reference':0 - } - ] - }, - 'blockId':'0x99d29eceb87b44664361f7faf9d8f3b072c6e3e890953fdf956f6d148d9b04b2', - 'inclusionState':'Pending', - 'timestamp':'1665992931904', - 'transactionId':'0xeed7357bf0c0bbdca809e5e537af5a10872e488b26a157af78c68e104420ad75', - 'networkId':'1856588631910923207', - 'incoming':False, - 'note':None -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_05_list_transactions/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_05_list_transactions/_code_sample.mdx deleted file mode 100644 index db87107e8b4..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_05_list_transactions/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples/11-list-transactions.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 11-list-transactions.py -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_05_list_transactions/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_05_list_transactions/_expected_output.md deleted file mode 100644 index a43fc84ae9e..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_05_list_transactions/_expected_output.md +++ /dev/null @@ -1,148 +0,0 @@ -``` -Transactions:[ - { - 'payload':{ - 'type':6, - 'essence':{ - 'type':1, - 'networkId':'1856588631910923207', - 'inputs':[ - { - 'type':0, - 'transactionId':'0x79edb042038431009408d734a337f6fae9dcec97b0d7572665d0c184ea74b82f', - 'transactionOutputIndex':0 - }, - { - 'type':0, - 'transactionId':'0xf4676daae96cf629c04d8d62989dec6d9dbbac221959d72c399729f92047ec14', - 'transactionOutputIndex':0 - } - ], - 'inputsCommitment':'0x51a6fe8c7670746c2a45f620be0055c1853f84599c68490a7258ee3c41ba2332', - 'outputs':[ - { - 'type':3, - 'amount':'50600', - 'unlockConditions':[ - { - 'type':0, - 'address':{ - 'type':0, - 'pubKeyHash':'0xf8ba764448d689422aa59a5c5dc97108450a29cb8956208f631ab4a82338468a' - } - } - ] - }, - { - 'type':3, - 'amount':'1000000001', - 'unlockConditions':[ - { - 'type':0, - 'address':{ - 'type':0, - 'pubKeyHash':'0xf4d94c9f4e63d553c81e644225fa3bbc412f820c4eafd495aeb0bb05a29922b2' - } - } - ] - } - ] - }, - 'unlocks':[ - { - 'type':0, - 'signature':{ - 'type':0, - 'publicKey':'0xee4164cca9a455db3164ec2a3c3ebc2db57aec8c4cb3231c3dc6cda0c700e1bd', - 'signature':'0xf474de893c5a47d9114d2a95f1bd0e4c83b464e8a17886a07ea8d04046949a17dbb8173183c08d4cadbe530c7f42a65fa3286a5f28644a76cf59f6411a04220f' - } - }, - { - 'type':1, - 'reference':0 - } - ] - }, - 'blockId':'0x99d29eceb87b44664361f7faf9d8f3b072c6e3e890953fdf956f6d148d9b04b2', - 'inclusionState':'Pending', - 'timestamp':'1665992931904', - 'transactionId':'0xeed7357bf0c0bbdca809e5e537af5a10872e488b26a157af78c68e104420ad75', - 'networkId':'1856588631910923207', - 'incoming':False, - 'note':None - } -] -Pending transactions:[ - { - 'payload':{ - 'type':6, - 'essence':{ - 'type':1, - 'networkId':'1856588631910923207', - 'inputs':[ - { - 'type':0, - 'transactionId':'0x79edb042038431009408d734a337f6fae9dcec97b0d7572665d0c184ea74b82f', - 'transactionOutputIndex':0 - }, - { - 'type':0, - 'transactionId':'0xf4676daae96cf629c04d8d62989dec6d9dbbac221959d72c399729f92047ec14', - 'transactionOutputIndex':0 - } - ], - 'inputsCommitment':'0x51a6fe8c7670746c2a45f620be0055c1853f84599c68490a7258ee3c41ba2332', - 'outputs':[ - { - 'type':3, - 'amount':'50600', - 'unlockConditions':[ - { - 'type':0, - 'address':{ - 'type':0, - 'pubKeyHash':'0xf8ba764448d689422aa59a5c5dc97108450a29cb8956208f631ab4a82338468a' - } - } - ] - }, - { - 'type':3, - 'amount':'1000000001', - 'unlockConditions':[ - { - 'type':0, - 'address':{ - 'type':0, - 'pubKeyHash':'0xf4d94c9f4e63d553c81e644225fa3bbc412f820c4eafd495aeb0bb05a29922b2' - } - } - ] - } - ] - }, - 'unlocks':[ - { - 'type':0, - 'signature':{ - 'type':0, - 'publicKey':'0xee4164cca9a455db3164ec2a3c3ebc2db57aec8c4cb3231c3dc6cda0c700e1bd', - 'signature':'0xf474de893c5a47d9114d2a95f1bd0e4c83b464e8a17886a07ea8d04046949a17dbb8173183c08d4cadbe530c7f42a65fa3286a5f28644a76cf59f6411a04220f' - } - }, - { - 'type':1, - 'reference':0 - } - ] - }, - 'blockId':'0x99d29eceb87b44664361f7faf9d8f3b072c6e3e890953fdf956f6d148d9b04b2', - 'inclusionState':'Pending', - 'timestamp':'1665992931904', - 'transactionId':'0xeed7357bf0c0bbdca809e5e537af5a10872e488b26a157af78c68e104420ad75', - 'networkId':'1856588631910923207', - 'incoming':False, - 'note':None - } -] -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_06_check_unlock_conditions/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_06_check_unlock_conditions/_code_sample.mdx deleted file mode 100644 index 180bd2533e1..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_06_check_unlock_conditions/_code_sample.mdx +++ /dev/null @@ -1,9 +0,0 @@ -```python reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/bindings/python/examples/13-check-unlock-conditions.py -``` - -You can run the example by running the following command from the `binding/python/examples` folder: - -```bash -python3 13-check-unlock-conditions.py -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_06_check_unlock_conditions/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_06_check_unlock_conditions/_expected_output.md deleted file mode 100644 index cc9d4097610..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/python/how_to/outputs_and_transactions/_06_check_unlock_conditions/_expected_output.md +++ /dev/null @@ -1,3 +0,0 @@ -``` -The output has only an address unlock condition and the address is from the account: True -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_01_mint_nft/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_01_mint_nft/_code_sample.mdx deleted file mode 100644 index 714dfda9e23..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_01_mint_nft/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../../_admonitions/_warning_dot_env.md'; - - - -```rust reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/examples/10_mint_nft.rs -``` - -Run the example by running the following command: - -```bash -cargo run --example mint_nft --release -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_01_mint_nft/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_01_mint_nft/_expected_output.md deleted file mode 100644 index 33cec8229c9..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_01_mint_nft/_expected_output.md +++ /dev/null @@ -1,6 +0,0 @@ -```plaintext -Transaction: 0x0ba6e5d164f4c5ba0e16d9ba42852fa9fa19989956632444fe3ef0bf9d12737c -Block sent: http://localhost:14265/api/core/v2/blocks/0x7d9e46cd59119c6b00f2affd88fe497276b5f6f97874e2ca42e4dae9651d1be2 -Transaction: 0xf99a245889f942084b6d9d216c61f2dcb42b6b14fb595bdc92322e87caaa6bbc -Block sent: http://localhost:14265/api/core/v2/blocks/0xce3b0f453f935288356bbfdc43f217b29e3a0ff1f7f08459d08e091c941da4b4 -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_02_send_nft/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_02_send_nft/_code_sample.mdx deleted file mode 100644 index 48b45669c32..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_02_send_nft/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../../_admonitions/_warning_dot_env.md'; - - - -```rust reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/examples/08_send_nft.rs -``` - -Run the example by running the following command: - -```bash -cargo run --example send_nft --release -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_02_send_nft/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_02_send_nft/_expected_output.md deleted file mode 100644 index aaaa5f547af..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_02_send_nft/_expected_output.md +++ /dev/null @@ -1,4 +0,0 @@ -```plaintext -Transaction: 0x4d3e01a0cf6d25e80af5ed774f0f741a476709a5517c21555e2c0351dda81f77 -Block sent: http://localhost:14265/api/core/v2/blocks/0x7ad6ce0789ea5b5340b7045a13947af95737b3728410cdde8362021ac57f3731 -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_03_burn_nft/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_03_burn_nft/_code_sample.mdx deleted file mode 100644 index e9267c07d1a..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_03_burn_nft/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../../_admonitions/_warning_dot_env.md'; - - - -```rust reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/examples/14_burn_nft.rs -``` - -Run the example by running the following command: - -```bash -cargo run --example burn_nft --release -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_03_burn_nft/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_03_burn_nft/_expected_output.md deleted file mode 100644 index f89b9fad4e7..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/NFT/_03_burn_nft/_expected_output.md +++ /dev/null @@ -1,48 +0,0 @@ -```plaintext -Balance before burning: -AccountBalance{ - base_coin: BaseCoinBalance{ - total: 209996955000, - available: 209996955000 - }, - required_storage_deposit: 902500, - native_tokens: [ - - ], - nfts: [ - NftId(0xe314d76664f0ffe8d5fbe670527f108328c14bc8dad89b234dde3ff8deb58ec9) - ], - aliases: [ - - ], - foundries: [ - - ], - potentially_locked_outputs: { - - } -} -Balance after burning: -AccountBalance{ - base_coin: BaseCoinBalance{ - total: 209996955000, - available: 209996955000 - }, - required_storage_deposit: 852000, - native_tokens: [ - - ], - nfts: [ - - ], - aliases: [ - - ], - foundries: [ - - ], - potentially_locked_outputs: { - - } -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/_more_examples.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/_more_examples.md deleted file mode 100644 index 20cdad816ba..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/_more_examples.md +++ /dev/null @@ -1 +0,0 @@ -More advanced examples can be found in the [examples](https://github.com/iotaledger/wallet.rs/tree/develop/wallet/examples) folder. diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/_run_how_tos.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/_run_how_tos.mdx deleted file mode 100644 index 05a9ceaec35..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/_run_how_tos.mdx +++ /dev/null @@ -1,40 +0,0 @@ -## Prerequisites - -Before you can run the examples, please refer to the [Rust Getting Started guide](./../../../getting_started/rust.mdx) to install -the library. - -### Set Up Your .env file - -The code examples use a `.env` file to store variables. You can download -the [example file](https://github.com/iotaledger/wallet.rs/blob/develop/wallet/.env.example) or create a new one with -the following variables: - -```dotenv reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/.env.example -``` - -The `.env.example` uses public [Shimmer Beta](/build/networks-endpoints#public-testnet) -URLS. If you want to use another node, you should update the `NODE_URL` and `FAUCET_URL` values to match the -[Hornet node](#hornet-node) you want to use. - -## Run Code Examples - -The wallet.rs library has numerous [examples](https://github.com/iotaledger/wallet.rs/tree/develop/wallet/examples) -you can run to get acquainted with the library. After you have followed the instructions to -[install the library](./../../../getting_started/rust.mdx#install-the-library), you can run any example with the following -command from the `examples` directory: - -```bash -cargo run --example 0_generate_addresses --release -``` - -## Examples List - -You can replace the `0_generate_addresses` by any other example from -the [Rust examples directory](https://github.com/iotaledger/wallet.rs/tree/develop/wallet/examples). - -You can get a full list of examples by running the following command: - -```bash -cargo run --example -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_01_create_a_wallet_account/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_01_create_a_wallet_account/_code_sample.mdx deleted file mode 100644 index d56bb183a24..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_01_create_a_wallet_account/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../../_admonitions/_warning_dot_env.md'; - - - -```rust reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/examples/01_create_wallet.rs -``` - -Run the example by running the following command: - -```bash -cargo run --example create_wallet --release -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_01_create_a_wallet_account/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_01_create_a_wallet_account/_expected_output.md deleted file mode 100644 index 22653ff799b..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_01_create_a_wallet_account/_expected_output.md +++ /dev/null @@ -1,3 +0,0 @@ -```plaintext -Generated a new account -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_02_generate_address/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_02_generate_address/_code_sample.mdx deleted file mode 100644 index a50a14d755f..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_02_generate_address/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../../_admonitions/_warning_dot_env.md'; - - - -```rust reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/examples/02_generate_address.rs -``` - -Run the example by running the following command: - -```bash -cargo run --example generate_address --release -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_02_generate_address/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_02_generate_address/_expected_output.md deleted file mode 100644 index f64afd5b2bf..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_02_generate_address/_expected_output.md +++ /dev/null @@ -1,3 +0,0 @@ -```plaintext -Generated address: rms1qzzk86qv30l4e85ljtccxa0ruy8y7u8zn2dle3g8dv2tl2m4cu227a7n2wj -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_03_request_funds/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_03_request_funds/_code_sample.mdx deleted file mode 100644 index 1a9da12d234..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_03_request_funds/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../../_admonitions/_warning_dot_env.md'; - - - -```rust reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/examples/03_get_funds.rs -``` - -Run the example by running the following command: - -```bash -cargo run --example get_funds --release -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_03_request_funds/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_03_request_funds/_expected_output.md deleted file mode 100644 index 346a0b0c131..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_03_request_funds/_expected_output.md +++ /dev/null @@ -1,6 +0,0 @@ -```plaintext -{ - "address": "tst1qpllaj0pyveqfkwxmnngz2c488hfdtmfrj3wfkgxtk4gtyrax0jax7rgxyj", - "waitingRequests": 1 -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_04_check_balance/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_04_check_balance/_code_sample.mdx deleted file mode 100644 index 4f0d16d4439..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_04_check_balance/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../../_admonitions/_warning_dot_env.md'; - - - -```rust reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/examples/04_get_balance.rs -``` - -Run the example by running the following command: - -```bash -cargo run --example get_balance --release -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_04_check_balance/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_04_check_balance/_expected_output.md deleted file mode 100644 index 2388f01a326..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/accounts_and_addresses/_04_check_balance/_expected_output.md +++ /dev/null @@ -1,24 +0,0 @@ -```js -AccountBalance{ - base_coin: BaseCoinBalance{ - total: 100000000000, - available: 100000000000 - }, - required_storage_deposit: 213000, - native_tokens: [ - - ], - nfts: [ - - ], - aliases: [ - - ], - foundries: [ - - ], - potentially_locked_outputs: { - - } -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_01_mint_native_tokens/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_01_mint_native_tokens/_code_sample.mdx deleted file mode 100644 index b1dac07cfc5..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_01_mint_native_tokens/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../../_admonitions/_warning_dot_env.md'; - - - -```rust reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/examples/09_mint_native_token.rs -``` - -Run the example by running the following command: - -```bash -cargo run --example mint_native_token --release -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_01_mint_native_tokens/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_01_mint_native_tokens/_expected_output.md deleted file mode 100644 index 444963df68b..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_01_mint_native_tokens/_expected_output.md +++ /dev/null @@ -1,4 +0,0 @@ -```plaintext -Transaction: 0xaa9737fb4007e8b0f4c181d6923b0e3547ae178c23c25233985bb22f61c84de7 -Block sent: http://localhost:14265/api/core/v2/blocks/0x807dbdde107008dcc9acae29a0e32c261590bef13e5f5d8d3bb60949e633abd8 -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_02_send_native_tokens/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_02_send_native_tokens/_code_sample.mdx deleted file mode 100644 index a3991a617a1..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_02_send_native_tokens/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../../_admonitions/_warning_dot_env.md'; - - - -```rust reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/examples/07_send_native_tokens.rs -``` - -Run the example by running the following command: - -```bash -cargo run --example send_native_tokens --release -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_02_send_native_tokens/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_02_send_native_tokens/_expected_output.md deleted file mode 100644 index e7ef9c10d74..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_02_send_native_tokens/_expected_output.md +++ /dev/null @@ -1,4 +0,0 @@ -```plaintext -Transaction: 0x649987dd056ac5ad87adb5dbfa2648262856f2dfcd0ac7039e520fc6ccbc2b1f -Block sent: http://localhost:14265/api/core/v2/blocks/0x1e2126e848f10cf2c77d122f3bd003454267c1f46c20f4a3458b74f5639ce818 -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_03_melt_native_token/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_03_melt_native_token/_code_sample.mdx deleted file mode 100644 index b69783cf20f..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_03_melt_native_token/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../../_admonitions/_warning_dot_env.md'; - - - -```rust reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/examples/11_decrease_native_token_supply.rs -``` - -Run the example by running the following command: - -```bash -cargo run --example melt_native_token --release -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_03_melt_native_token/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_03_melt_native_token/_expected_output.md deleted file mode 100644 index 06f42f6d0bd..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_03_melt_native_token/_expected_output.md +++ /dev/null @@ -1,3 +0,0 @@ -```plaintext - -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_04_burn_native_token/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_04_burn_native_token/_code_sample.mdx deleted file mode 100644 index 9df7d33a6bc..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_04_burn_native_token/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../../_admonitions/_warning_dot_env.md'; - - - -```rust reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/examples/13_burn_native_token.rs -``` - -Run the example by running the following command: - -```bash -cargo run --example burn_native_token --release -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_04_burn_native_token/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_04_burn_native_token/_expected_output.md deleted file mode 100644 index 83b3e21408b..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_04_burn_native_token/_expected_output.md +++ /dev/null @@ -1,71 +0,0 @@ -```plaintext {10-14,45-49} -Balancebeforeburning: - -AccountBalance{ - base_coin: BaseCoinBalance{ - total: 209995515000, - available: 209995515000 - }, - required_storage_deposit: 1787500, - native_tokens: [ - NativeTokensBalance{ - token_id: TokenId(0x08adbd5f0844fdc9bf4eafe2df929ac42cc90336e68da284cce96f22523bd87cde0300000000), - total: 100, - available: 100 - } - ], - nfts: [ - - ], - aliases: [ - AliasId(0xadbd5f0844fdc9bf4eafe2df929ac42cc90336e68da284cce96f22523bd87cde) - ], - foundries: [ - FoundryId(0x08adbd5f0844fdc9bf4eafe2df929ac42cc90336e68da284cce96f22523bd87cde0200000000), - FoundryId(0x08adbd5f0844fdc9bf4eafe2df929ac42cc90336e68da284cce96f22523bd87cde0100000000), - FoundryId(0x08adbd5f0844fdc9bf4eafe2df929ac42cc90336e68da284cce96f22523bd87cde0300000000) - ], - potentially_locked_outputs: { - OutputId(0x452a212cbe8512ea7844759402f1679bc1c1e6a088f1f3faaed6aeaa0ac246ee0000): false, - OutputId(0xb8572c3386616ae4be668a46756fcc46bf9cdf178bd50122cf70c81dbec362200000): false, - OutputId(0x041a90dc4d9b23a3ef91c64b7aa69da27e90d3306f644fc7b1647016925d5ff30000): false, - OutputId(0xcb30fa5cbb34b7bb10c0408b4e2bbe323b73fcb9b30b0a9446c1866210cf82d80000): false, - OutputId(0x2c0a9874a309ac3ffce684a8d5f38be54f12760d40ef8fd72f043a11fd4b76110000): false - } -} - -Balanceafterburning: - -AccountBalance{ - base_coin: BaseCoinBalance{ - total: 209995515000, - available: 209995515000 - }, - required_storage_deposit: 1787500, - native_tokens: [ - NativeTokensBalance{ - token_id: TokenId(0x08adbd5f0844fdc9bf4eafe2df929ac42cc90336e68da284cce96f22523bd87cde0300000000), - total: 99, - available: 99 - } - ], - nfts: [ - - ], - aliases: [ - AliasId(0xadbd5f0844fdc9bf4eafe2df929ac42cc90336e68da284cce96f22523bd87cde) - ], - foundries: [ - FoundryId(0x08adbd5f0844fdc9bf4eafe2df929ac42cc90336e68da284cce96f22523bd87cde0200000000), - FoundryId(0x08adbd5f0844fdc9bf4eafe2df929ac42cc90336e68da284cce96f22523bd87cde0100000000), - FoundryId(0x08adbd5f0844fdc9bf4eafe2df929ac42cc90336e68da284cce96f22523bd87cde0300000000) - ], - potentially_locked_outputs: { - OutputId(0x2c0a9874a309ac3ffce684a8d5f38be54f12760d40ef8fd72f043a11fd4b76110000): false, - OutputId(0x452a212cbe8512ea7844759402f1679bc1c1e6a088f1f3faaed6aeaa0ac246ee0000): false, - OutputId(0x041a90dc4d9b23a3ef91c64b7aa69da27e90d3306f644fc7b1647016925d5ff30000): false, - OutputId(0xb8572c3386616ae4be668a46756fcc46bf9cdf178bd50122cf70c81dbec362200000): false, - OutputId(0xcb30fa5cbb34b7bb10c0408b4e2bbe323b73fcb9b30b0a9446c1866210cf82d80000): false - } -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_05_destroy_foundry/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_05_destroy_foundry/_code_sample.mdx deleted file mode 100644 index 403cf8c6ceb..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_05_destroy_foundry/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../../_admonitions/_warning_dot_env.md'; - - - -```rust reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/examples/15_destroy_foundry.rs -``` - -Run the example by running the following command: - -```bash -cargo run --example destroy_foundry --release -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_05_destroy_foundry/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_05_destroy_foundry/_expected_output.md deleted file mode 100644 index ee096d0baa5..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/native_tokens/_05_destroy_foundry/_expected_output.md +++ /dev/null @@ -1,44 +0,0 @@ -```plaintext {16-18,37-38} -Balancebeforedestroying: AccountBalance{ - base_coin: BaseCoinBalance{ - total: 109999491000, - available: 109999491000 - }, - required_storage_deposit: 3046500, - native_tokens: [ - ... - ], - nfts: [ - ... - ] - aliases: [ - ... - ], - foundries: [ - FoundryId(0x086d7755dc84a6757ea28285990ddac2eb53f558f8345507ac76d0c33caacaf8970100000000), - ], - potentially_locked_outputs: { - ... - } -}Balanceafterdestroying: AccountBalance{ - base_coin: BaseCoinBalance{ - total: 109999491000, - available: 109999491000 - }, - required_storage_deposit: 3046500, - native_tokens: [ - ... - ], - nfts: [ - ... - ] - aliases: [ - ... - ], - foundries: [ - ], - potentially_locked_outputs: { - ... - } -} -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_05_send_transaction/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_05_send_transaction/_code_sample.mdx deleted file mode 100644 index 32e91a11c45..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_05_send_transaction/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../../_admonitions/_warning_dot_env.md'; - - - -```rust reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/examples/05_transaction.rs -``` - -Run the example by running the following command: - -```bash -cargo run --example transaction --release -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_05_send_transaction/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_05_send_transaction/_expected_output.md deleted file mode 100644 index 3c05a58fc9d..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_05_send_transaction/_expected_output.md +++ /dev/null @@ -1,4 +0,0 @@ -```plaintext -Transaction: 0x6b05d2023a690e60464b507653601d990bacb3eada64e04981b7c3a417c07500 -Block sent: http://localhost:14265/api/core/v2/blocks/0x1b6839d2de7a7d856ab2cd66a3325a8fe0618e2d5406d1295348133abd09ee8e -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_06_check_unlock_conditions/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_06_check_unlock_conditions/_code_sample.mdx deleted file mode 100644 index 3a4f95a7f87..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_06_check_unlock_conditions/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../../_admonitions/_warning_dot_env.md'; - - - -```rust reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/examples/17_check_unlock_conditions.rs -``` - -Run the example by running the following command: - -```bash -cargo run --example check_unlock_conditions --release -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_06_check_unlock_conditions/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_06_check_unlock_conditions/_expected_output.md deleted file mode 100644 index 9188ebd5919..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_06_check_unlock_conditions/_expected_output.md +++ /dev/null @@ -1,3 +0,0 @@ -```plaintext -The output has only an address unlock condition and the address is from the account: true -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_06_send_micro_transaction/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_06_send_micro_transaction/_code_sample.mdx deleted file mode 100644 index fdad8b10d8f..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_06_send_micro_transaction/_code_sample.mdx +++ /dev/null @@ -1,13 +0,0 @@ -import DotEnvWarning from '../../../../../_admonitions/_warning_dot_env.md'; - - - -```rust reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/examples/06_send_micro_transaction.rs -``` - -Run the example by running the following command: - -```bash -cargo run --example send_micro_transaction --release -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_06_send_micro_transaction/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_06_send_micro_transaction/_expected_output.md deleted file mode 100644 index f6e598dbe4a..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_06_send_micro_transaction/_expected_output.md +++ /dev/null @@ -1,4 +0,0 @@ -```plaintext -Transaction: 0x78abf6499023396fa9510155237542500015da882e2676bc9e5cd8280e3c15e6 -Block sent: http://localhost:14265/api/core/v2/blocks/0xe601e25316c17c9aaa19de881aacd55ac270bc99697d34c4a9f4e57edf10cbe2 -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_16_destroy_alias_output/_code_sample.mdx b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_16_destroy_alias_output/_code_sample.mdx deleted file mode 100644 index 8de67927490..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_16_destroy_alias_output/_code_sample.mdx +++ /dev/null @@ -1,15 +0,0 @@ -import DotEnvWarning from '../../../../../_admonitions/_warning_dot_env.md'; - - - -```rust reference -https://github.com/iotaledger/wallet.rs/tree/develop/wallet/examples/16_destroy_alias.rs -``` - -Before you run the example you should update the `alias_id` to one available in your account. - -Run the example by running the following command: - -```bash -cargo run --example destroy_alias --release -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_16_destroy_alias_output/_expected_output.md b/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_16_destroy_alias_output/_expected_output.md deleted file mode 100644 index 4a23f94cdf9..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/libraries/rust/how_to/outputs_and_transactions/_16_destroy_alias_output/_expected_output.md +++ /dev/null @@ -1,39 +0,0 @@ -```plaintext {14-16,33-34} -Balancebeforedestroying: AccountBalance{ - base_coin: BaseCoinBalance{ - total: 109999491000, - available: 109999491000 - }, - required_storage_deposit: 3155000, - native_tokens: [ - ... - ], - nfts: [ - NftId(0x346cf240e9e56132295b0d648fde7037ad0b2e43a35c46668313e1be2970c08c), - NftId(0x79862038299b19b704c10da655afedd77c930278ae56f7a4cb9bca4bf6dd7313) - ], - aliases: [ - AliasId(0x0aa4fe362b61da2d4c11909162939c0fe20913e2edf5c12ea15cf92f6b36ef60), - ], - [...] -} - -Balanceafterdestroying: AccountBalance{ - base_coin: BaseCoinBalance{ - total: 109999491000, - available: 109999491000 - }, - required_storage_deposit: 3155000, - native_tokens: [ - ... - ], - nfts: [ - NftId(0x346cf240e9e56132295b0d648fde7037ad0b2e43a35c46668313e1be2970c08c), - NftId(0x79862038299b19b704c10da655afedd77c930278ae56f7a4cb9bca4bf6dd7313) - ], - aliases: [ - ], - [...] -} - -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/java/account.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/java/account.md deleted file mode 100644 index fa24321a43a..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/java/account.md +++ /dev/null @@ -1,309 +0,0 @@ ---- -description: Official IOTA Wallet Library Software Rust API reference. -image: /img/logo/wallet_light.png -keywords: - - api - - rust - - cargo - - crate ---- - -# Account API Reference - -# Documentation - -## `public int getIndex() throws WalletException` - -Returns the index of the account - -- **Returns:** The index of the account. - -## `public int getCoinType() throws WalletException` - -Returns the coin type that is configured with the account - -- **Returns:** The coin type of the account. - -## `public String getAlias() throws WalletException` - -Returns the alias of the account - -- **Returns:** The alias of the account. - -## `public AccountAddress[] getPublicAddresses() throws WalletException` - -Returns an array of all public addresses of the account. - -- **Returns:** An array of AccountAddress objects. - -## `public AccountAddress[] getInternalAddresses() throws WalletException` - -Returns an array of all internal addresses of the account. - -- **Returns:** An array of AccountAddress objects. - -## `public Set getLockedOutputs() throws WalletException` - -Returns all locked outputs of the account. - -- **Returns:** A set of OutputIds - -## `public Map getIncomingTransactions() throws WalletException` - -Returns all incoming transactions for the account. - -- **Returns:** All incoming transactions for the account. - -## `public Account getAccountCopy() throws WalletException` - -Get a snapshot of the current account state. - -- **Returns:** A copy of the account. - -## `public Output buildAliasOutput(BuildAliasOutput options) throws WalletException` - -Builds an alias output. - -- **Parameters:** `options` — The options to call. -- **Returns:** The built output. - -## `public Output buildBasicOutput(BuildBasicOutput options) throws WalletException` - -Builds a basic output. - -- **Parameters:** `options` — The options to call. -- **Returns:** The built output. - -## `public Output buildFoundryOutput(BuildFoundryOutput options) throws WalletException` - -Builds a foundry output. - -- **Parameters:** `options` — The options to call. -- **Returns:** The built output. - -## `public Output buildNftOutput(BuildNftOutput options) throws WalletException` - -Builds a NFT output. - -- **Parameters:** `options` — The options to call. -- **Returns:** The built output. - -## `public Transaction burnNativeToken(BurnNativeToken options) throws WalletException` - -Burns native tokens for the account. - -- **Parameters:** `options` — The options to be called. -- **Returns:** A transaction object. - -## `public Transaction burnNft(BurnNft options) throws WalletException` - -Burns a NFT. - -- **Parameters:** `options` — The options. -- **Returns:** The transaction that destroyed the alias. - -## `public Transaction consolidateOutputs(ConsolidateOutputs options) throws WalletException` - -Destroy an alias. - -- **Parameters:** `options` — The options. -- **Returns:** The transaction that destroyed the alias. - -## `public Transaction destroyAlias(DestroyAlias options) throws WalletException` - -Destroy an alias. - -- **Parameters:** `options` — The options. -- **Returns:** The transaction that destroyed the alias. - -## `public Transaction destroyFoundry(DestroyFoundry options) throws WalletException` - -Destroy a foundry. - -- **Parameters:** `options` — The options. -- **Returns:** The transaction that destroyed the foundry. - -## `public AccountAddress[] generateAddresses(GenerateAddresses options) throws WalletException` - -Generate addresses. - -- **Parameters:** `options` — The options. -- **Returns:** The generated addresses. - -## `public OutputData getOutput(GetOutput options) throws WalletException` - -Get a specific output. - -- **Parameters:** `options` — The options. -- **Returns:** The given output. - -## `public Output getFoundryOutput(GetFoundryOutput options) throws WalletException` - -Get a specific foundry output. - -- **Parameters:** `options` — The options. -- **Returns:** The given output. - -## `public Output[] getOutputsWithAdditionalUnlockConditions(GetOutputsWithAdditionalUnlockConditions options) throws WalletException` - -Get all outputs with additional unlock conditions. - -- **Parameters:** `options` — The options. -- **Returns:** The given transaction. - -## `public Transaction getTransaction(GetTransaction options) throws WalletException` - -Get a specific transaction. - -- **Parameters:** `options` — The options. -- **Returns:** The given transaction. - -## `public JsonElement getIncomingTransactionData(GetIncomingTransactionData options) throws WalletException` - -Get the transaction with inputs of an incoming transaction stored in the account. List might not be complete, if the node pruned the data already. - -- **Parameters:** `options` — The options. -- **Returns:** A JsonElement object. - -## `public AccountAddress[] getAddresses() throws WalletException` - -Returns all the addresses of the account. - -## `public AccountAddress[] getAddressesWithUnspentOutputs() throws WalletException` - -Returns all the unspent outputs of the account. - -## `public OutputData[] getOutputs(Outputs options) throws WalletException` - -Returns all the outputs of the account. - -## `public Transaction[] getPendingTransactions() throws WalletException` - -Returns all the pending transactions created by account. - -## `public Transaction[] getTransactions() throws WalletException` - -Returns all the transactions created by the account. - -## `public OutputData[] getUnspentOutputs(UnspentOutputs options) throws WalletException` - -Returns all unspent outputs. - -- **Parameters:** `options` — The options. - -## `public TaggedDataPayload meltNativeToken(DecreaseNativeTokenSupply options) throws WalletException` - -Melts a Native Token. - -- **Parameters:** `options` — The options. - -## `public String minimumRequiredStorageDeposit(MinimumRequiredStorageDeposit options) throws WalletException` - -Calculates the minimum required storage deposit for an output. - -- **Parameters:** `options` — The options. - -## `public MintTokenTransaction mintNativeToken(MintNativeToken options) throws WalletException` - -Mints Native Tokens. - -- **Parameters:** `options` — The options. - -## `public Transaction mintNfts(MintNfts options) throws WalletException` - -Mints NFTs. - -- **Parameters:** `options` — The options. - -## `public AccountBalance getBalance() throws WalletException` - -Gets the balance of the account. - -## `public Output prepareOutput(PrepareOutput options) throws WalletException` - -Prepares an output. - -- **Parameters:** `options` — The options. - -## `public PreparedTransactionData prepareTransaction(PrepareTransaction options) throws WalletException` - -Prepares a transaction. - -- **Parameters:** `options` — The options. - -## `public PreparedTransactionData prepareSendAmount(PrepareSendAmount options) throws WalletException` - -Prepares a transaction. - -- **Parameters:** `options` — The options. - -## `public AccountBalance syncAccount(SyncAccount options) throws WalletException` - -Sync the account by fetching new information from the nodes. Will also retry pending transactions if necessary. - -- **Parameters:** `options` — The options. - -## `public Transaction sendAmount(SendAmount options) throws WalletException` - -Sends an amount. - -- **Parameters:** `options` — The options. - -## `public Transaction sendMicroTransaction(SendMicroTransaction options) throws WalletException` - -Sends a micro transaction. - -- **Parameters:** `options` — The options. - -## `public Transaction sendNativeTokens(SendNativeTokens options) throws WalletException` - -Sends Native Tokens. - -- **Parameters:** `options` — The options. - -## `public Transaction sendNft(SendNft options) throws WalletException` - -Sends a NFT. - -- **Parameters:** `options` — The options. - -## `public void setAlias(SetAlias options) throws WalletException` - -Set the alias of the account. - -- **Parameters:** `options` — The options. - -## `public Transaction sendOutputs(SendOutputs options) throws WalletException` - -Send outputs in a transaction. - -- **Parameters:** `options` — The options. -- **Returns:** The transaction. - -## `public Transaction signTransactionEssence(SignTransactionEssence options) throws WalletException` - -Signs a transaction essence. - -- **Parameters:** `options` — The options. -- **Returns:** The signed transaction. - -## `public Transaction submitAndStoreTransaction(SubmitAndStoreTransaction options) throws WalletException` - -Submits and stores a transaction. - -- **Parameters:** `options` — The options. -- **Returns:** The submitted and stored transaction. - -## `public Transaction claimOutputs(ClaimOutputs options) throws WalletException` - -This function claims all unclaimed outputs for the account. - -- **Parameters:** `options` — The options. -- **Returns:** A transaction object. - -## `public Transaction createAliasOutput(CreateAliasOutput options) throws WalletException` - -Creates an alias output. - -- **Parameters:** `options` — The options. -- **Returns:** A transaction object. diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/java/wallet.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/java/wallet.md deleted file mode 100644 index 79425cc39ce..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/java/wallet.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -description: Official IOTA Wallet Library Software Rust API reference. -image: /img/logo/wallet_light.png -keywords: - - api - - rust - - cargo - - crate ---- - -# Wallet API Reference - -## `public AccountHandle createAccount(String alias) throws WalletException` - -Create an account with the given alias and return an AccountHandle for it. - -- **Parameters:** `alias` — The name of the account. -- **Returns:** An AccountHandle object. - -## `public AccountHandle getAccount(AccountIdentifier accountIdentifier) throws WalletException` - -Return a given account from the wallet. - -- **Parameters:** `accountIdentifier` — The account identifier. -- **Returns:** An AccountHandle object. - -## `public AccountHandle[] getAccounts() throws WalletException` - -Returns all the accounts from the wallet. - -- **Returns:** An array of AccountHandles. - -## `public void backup(String destination, String password) throws WalletException` - -Backup the wallet to the specified destination, encrypting it with the specified password. - -- **Parameters:** - - `destination` — The path to the file to be created. - - `password` — The password to encrypt the backup with. - -## `public void changeStrongholdPassword(String currentPassword, String newPassword) throws WalletException` - -Change the password of the Stronghold file. - -- **Parameters:** - - `currentPassword` — The current password for the Stronghold - - `newPassword` — The new password you want to use for your Stronghold. - -## `public void clearStrongholdPassword() throws WalletException` - -Clears the Stronghold password from memory. - -## `public boolean isStrongholdPasswordAvailable() throws WalletException` - -Checks if the Stronghold password is available. - -- **Returns:** A boolean value. - -## `public void recoverAccounts(int accountStartIndex, int accountGapLimit, int addressGapLimit, SyncOptions syncOptions) throws WalletException` - -Find accounts with unspent outputs. - -## `public void restoreBackup(String source, String password) throws WalletException` - -Restore a backup from a Stronghold file Replaces client_options, coin_type, secret_manager and accounts. Returns an error if accounts were already created If Stronghold is used as secret_manager, the existing Stronghold file will be overwritten. If a mnemonic was stored, it will be gone. - -- **Parameters:** - - `source` — The path to the backup file. - - `password` — The password you used to encrypt the backup file. - -## `public void removeLatestAccount() throws WalletException` - -Removes the latest account (account with the largest account index). - -## `public String generateMnemonic() throws WalletException` - -Generate a mnemonic phrase - -- **Returns:** A string of words. - -## `public void verifyMnemonic(String mnemonic) throws WalletException` - -Checks if the given mnemonic is valid. - -- **Parameters:** `mnemonic` — The mnemonic to verify. -- **Returns:** The wallet address. - -## `public void setClientOptions(ClientConfig config) throws WalletException` - -Updates the client options for all accounts. - -- **Parameters:** `config` — A ClientConfig object that contains the options to set. - -## `public LedgerNanoStatus getLedgerNanoStatus() throws WalletException` - -Get the status of the Ledger Nano. - -- **Returns:** The status of the Ledger Nano - -## `public JsonObject getNodeInfo(String url, NodeAuth auth) throws WalletException` - -Get node information. - -- **Parameters:** - - `url` — The URL of the node you want information from. - - `auth` — The authentication information for the node. -- **Returns:** A JsonObject - -## `public void setStrongholdPassword(String password) throws WalletException` - -Set the stronghold password clear interval. - -- **Parameters:** `password` — The password to set for the stronghold. - -## `public void setStrongholdPasswordClearInterval(int interval) throws WalletException` - -Set the stronghold password clear interval. - -- **Parameters:** `interval` — The number of seconds to wait before clearing the password. - -## `public void storeMnemonic(String mnemonic) throws WalletException` - -Store a mnemonic into the Stronghold vault. - -- **Parameters:** `mnemonic` — The mnemonic to store. - -## `public void startBackgroundSync(SyncOptions options, int intervalInMilliseconds) throws WalletException` - -Start a background sync with the specified options and interval. - -- **Parameters:** - - `options` — The options for the sync. - - `intervalInMilliseconds` — The interval in milliseconds at which the background sync will be performed. - -## `public void stopBackgroundSync() throws WalletException` - -Stop the background sync process. - -## `public void emitTestEvent(JsonElement event) throws WalletException` - -Emits an event for testing if the event system is working - -- **Parameters:** `event` — The event to emit. - -## `public String bech32ToHex(String bech32) throws WalletException` - -Converts a bech32 address to a hex address. - -- **Parameters:** `bech32` — The bech32 string to convert to hex. -- **Returns:** A hex string. - -## `public String hexToBech32(String hex, String bech32Hrp) throws WalletException` - -Converts a hex address to a bech32 address. - -- **Parameters:** - - `hex` — The hex address to convert. - - `bech32Hrp` — The bech32 human-readable part. -- **Returns:** The bech32 address. diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/api_ref.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/api_ref.md deleted file mode 100644 index 2007fbdfab9..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/api_ref.md +++ /dev/null @@ -1,196 +0,0 @@ -# @iota/wallet - -## Table of contents - -### Classes - -- [Account](classes/Account.md) -- [AccountManager](classes/AccountManager.md) - -### Type Aliases - -- [AccountId](api_ref.md#accountid) -- [EventType](api_ref.md#eventtype) -- [Auth](api_ref.md#auth) -- [Node](api_ref.md#node) -- [SecretManager](api_ref.md#secretmanager) -- [RemainderValueStrategy](api_ref.md#remaindervaluestrategy) -- [ChangeAddress](api_ref.md#changeaddress) -- [ReuseAddress](api_ref.md#reuseaddress) -- [CustomAddress](api_ref.md#customaddress) - -### Interfaces - -- [AccountBalance](interfaces/AccountBalance.md) -- [BaseCoinBalance](interfaces/BaseCoinBalance.md) -- [RequiredStorageDeposit](interfaces/RequiredStorageDeposit.md) -- [NativeTokenBalance](interfaces/NativeTokenBalance.md) -- [SyncOptions](interfaces/SyncOptions.md) -- [AccountSyncOptions](interfaces/AccountSyncOptions.md) -- [AliasSyncOptions](interfaces/AliasSyncOptions.md) -- [NftSyncOptions](interfaces/NftSyncOptions.md) -- [AccountMeta](interfaces/AccountMeta.md) -- [AccountMetadata](interfaces/AccountMetadata.md) -- [CreateAccountPayload](interfaces/CreateAccountPayload.md) -- [FilterOptions](interfaces/FilterOptions.md) -- [AccountManagerOptions](interfaces/AccountManagerOptions.md) -- [Address](interfaces/Address.md) -- [AddressWithAmount](interfaces/AddressWithAmount.md) -- [AddressWithUnspentOutputs](interfaces/AddressWithUnspentOutputs.md) -- [AddressWithMicroAmount](interfaces/AddressWithMicroAmount.md) -- [AddressNativeTokens](interfaces/AddressNativeTokens.md) -- [AddressNftId](interfaces/AddressNftId.md) -- [AddressGenerationOptions](interfaces/AddressGenerationOptions.md) -- [GenerateAddressOptions](interfaces/GenerateAddressOptions.md) -- [BuildAliasOutputData](interfaces/BuildAliasOutputData.md) -- [BuildBasicOutputData](interfaces/BuildBasicOutputData.md) -- [BuildFoundryOutputData](interfaces/BuildFoundryOutputData.md) -- [BuildNftOutputData](interfaces/BuildNftOutputData.md) -- [LoggerConfig](interfaces/LoggerConfig.md) -- [NetworkInfo](interfaces/NetworkInfo.md) -- [ClientOptions](interfaces/ClientOptions.md) -- [NodeInfoWrapper](interfaces/NodeInfoWrapper.md) -- [OutputData](interfaces/OutputData.md) -- [Segment](interfaces/Segment.md) -- [OutputOptions](interfaces/OutputOptions.md) -- [Assets](interfaces/Assets.md) -- [Features](interfaces/Features.md) -- [Unlocks](interfaces/Unlocks.md) -- [StorageDeposit](interfaces/StorageDeposit.md) -- [PreparedTransactionData](interfaces/PreparedTransactionData.md) -- [InputSigningData](interfaces/InputSigningData.md) -- [RemainderData](interfaces/RemainderData.md) -- [LedgerNanoSecretManager](interfaces/LedgerNanoSecretManager.md) -- [MnemonicSecretManager](interfaces/MnemonicSecretManager.md) -- [SeedSecretManager](interfaces/SeedSecretManager.md) -- [StrongholdSecretManager](interfaces/StrongholdSecretManager.md) -- [LedgerNanoStatus](interfaces/LedgerNanoStatus.md) -- [LedgerApp](interfaces/LedgerApp.md) -- [SignedTransactionEssence](interfaces/SignedTransactionEssence.md) -- [Transaction](interfaces/Transaction.md) -- [MintTokenTransaction](interfaces/MintTokenTransaction.md) -- [TransactionOptions](interfaces/TransactionOptions.md) -- [IncreaseNativeTokenSupplyOptions](interfaces/IncreaseNativeTokenSupplyOptions.md) -- [NativeTokenOptions](interfaces/NativeTokenOptions.md) -- [NftOptions](interfaces/NftOptions.md) -- [AliasOutputOptions](interfaces/AliasOutputOptions.md) - -### Enumerations - -- [CoinType](enums/CoinType.md) -- [AddressType](enums/AddressType.md) -- [WalletEvent](enums/WalletEvent.md) -- [Network](enums/Network.md) -- [OutputsToClaim](enums/OutputsToClaim.md) -- [ReturnStrategy](enums/ReturnStrategy.md) -- [LedgerDeviceType](enums/LedgerDeviceType.md) -- [InclusionState](enums/InclusionState.md) - -## Type Aliases - -### AccountId - -Ƭ **AccountId**: `number` \| `string` - -Account identifier -Could be the account index (number) or account alias (string) - ---- - -### EventType - -Ƭ **EventType**: `"*"` \| `"ConsolidationRequired"` \| `"LedgerAddressGeneration"` \| `"NewOutput"` \| `"SpentOutput"` \| `"TransactionInclusion"` \| `"TransactionProgress"` - -Wallet event types - ---- - -### Auth - -Ƭ **Auth**: `Object` - -Basic Auth or JWT - -#### Type declaration - -| Name | Type | -| :------------------ | :------------------- | -| `jwt?` | `string` | -| `basicAuthNamePwd?` | [`string`, `string`] | - ---- - -### Node - -Ƭ **Node**: `Object` - -A node object for the client - -#### Type declaration - -| Name | Type | -| :---------- | :------------------------ | -| `url` | `string` | -| `auth?` | [`Auth`](api_ref.md#auth) | -| `disabled?` | `boolean` | - ---- - -### SecretManager - -Ƭ **SecretManager**: [`LedgerNanoSecretManager`](interfaces/LedgerNanoSecretManager.md) \| [`MnemonicSecretManager`](interfaces/MnemonicSecretManager.md) \| [`StrongholdSecretManager`](interfaces/StrongholdSecretManager.md) - -Supported secret managers - ---- - -### RemainderValueStrategy - -Ƭ **RemainderValueStrategy**: [`ChangeAddress`](api_ref.md#changeaddress) \| [`ReuseAddress`](api_ref.md#reuseaddress) \| [`CustomAddress`](api_ref.md#customaddress) - -The RemainderValueStrategy - ---- - -### ChangeAddress - -Ƭ **ChangeAddress**: `Object` - -ChangeAddress variant of RemainderValueStrategy - -#### Type declaration - -| Name | Type | -| :--------- | :---------------- | -| `strategy` | `"ChangeAddress"` | -| `value` | `null` | - ---- - -### ReuseAddress - -Ƭ **ReuseAddress**: `Object` - -ReuseAddress variant of RemainderValueStrategy - -#### Type declaration - -| Name | Type | -| :--------- | :--------------- | -| `strategy` | `"ReuseAddress"` | -| `value` | `null` | - ---- - -### CustomAddress - -Ƭ **CustomAddress**: `Object` - -CustomAddress variant of RemainderValueStrategy - -#### Type declaration - -| Name | Type | -| :--------- | :---------------- | -| `strategy` | `"CustomAddress"` | -| `value` | `string` | diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/classes/Account.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/classes/Account.md deleted file mode 100644 index 5352b5688ba..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/classes/Account.md +++ /dev/null @@ -1,988 +0,0 @@ -# Class: Account - -The Account class. - -## Table of contents - -### Methods - -- [buildAliasOutput](Account.md#buildaliasoutput) -- [buildBasicOutput](Account.md#buildbasicoutput) -- [buildFoundryOutput](Account.md#buildfoundryoutput) -- [buildNftOutput](Account.md#buildnftoutput) -- [burnNativeToken](Account.md#burnnativetoken) -- [burnNft](Account.md#burnnft) -- [claimOutputs](Account.md#claimoutputs) -- [consolidateOutputs](Account.md#consolidateoutputs) -- [createAliasOutput](Account.md#createaliasoutput) -- [decreaseNativeTokenSupply](Account.md#decreasenativetokensupply) -- [destroyAlias](Account.md#destroyalias) -- [destroyFoundry](Account.md#destroyfoundry) -- [generateAddress](Account.md#generateaddress) -- [generateAddresses](Account.md#generateaddresses) -- [getBalance](Account.md#getbalance) -- [getOutput](Account.md#getoutput) -- [getFoundryOutput](Account.md#getfoundryoutput) -- [getOutputsWithAdditionalUnlockConditions](Account.md#getoutputswithadditionalunlockconditions) -- [getTransaction](Account.md#gettransaction) -- [getIncomingTransactionData](Account.md#getincomingtransactiondata) -- [addresses](Account.md#addresses) -- [addressesWithUnspentOutputs](Account.md#addresseswithunspentoutputs) -- [outputs](Account.md#outputs) -- [pendingTransactions](Account.md#pendingtransactions) -- [incomingTransactions](Account.md#incomingtransactions) -- [transactions](Account.md#transactions) -- [unspentOutputs](Account.md#unspentoutputs) -- [getMetadata](Account.md#getmetadata) -- [minimumRequiredStorageDeposit](Account.md#minimumrequiredstoragedeposit) -- [increaseNativeTokenSupply](Account.md#increasenativetokensupply) -- [mintNativeToken](Account.md#mintnativetoken) -- [mintNfts](Account.md#mintnfts) -- [prepareOutput](Account.md#prepareoutput) -- [prepareSendAmount](Account.md#preparesendamount) -- [prepareTransaction](Account.md#preparetransaction) -- [requestFundsFromFaucet](Account.md#requestfundsfromfaucet) -- [retryTransactionUntilIncluded](Account.md#retrytransactionuntilincluded) -- [sendAmount](Account.md#sendamount) -- [sendMicroTransaction](Account.md#sendmicrotransaction) -- [sendNativeTokens](Account.md#sendnativetokens) -- [sendNft](Account.md#sendnft) -- [sendOutputs](Account.md#sendoutputs) -- [setAlias](Account.md#setalias) -- [signTransactionEssence](Account.md#signtransactionessence) -- [submitAndStoreTransaction](Account.md#submitandstoretransaction) -- [sync](Account.md#sync) -- [getParticipationOverview](Account.md#getparticipationoverview) - -## Methods - -### buildAliasOutput - -▸ **buildAliasOutput**(`data`): `Promise`<`IAliasOutput`\> - -Build an `AliasOutput`. - -#### Parameters - -| Name | Type | Description | -| :----- | :-------------------------------------------------------------- | :------------------------------------- | -| `data` | [`BuildAliasOutputData`](../interfaces/BuildAliasOutputData.md) | Options for building an `AliasOutput`. | - -#### Returns - -`Promise`<`IAliasOutput`\> - -The built `AliasOutput`. - ---- - -### buildBasicOutput - -▸ **buildBasicOutput**(`data`): `Promise`<`IBasicOutput`\> - -Build a `BasicOutput`. - -#### Parameters - -| Name | Type | Description | -| :----- | :-------------------------------------------------------------- | :------------------------------------ | -| `data` | [`BuildBasicOutputData`](../interfaces/BuildBasicOutputData.md) | Options for building a `BasicOutput`. | - -#### Returns - -`Promise`<`IBasicOutput`\> - -The built `BasicOutput`. - ---- - -### buildFoundryOutput - -▸ **buildFoundryOutput**(`data`): `Promise`<`IFoundryOutput`\> - -Build a `FoundryOutput`. - -#### Parameters - -| Name | Type | Description | -| :----- | :------------------------------------------------------------------ | :-------------------------------------- | -| `data` | [`BuildFoundryOutputData`](../interfaces/BuildFoundryOutputData.md) | Options for building a `FoundryOutput`. | - -#### Returns - -`Promise`<`IFoundryOutput`\> - -The built `FoundryOutput`. - ---- - -### buildNftOutput - -▸ **buildNftOutput**(`data`): `Promise`<`INftOutput`\> - -Build an `NftOutput`. - -#### Parameters - -| Name | Type | Description | -| :----- | :---------------------------------------------------------- | :----------------------------------- | -| `data` | [`BuildNftOutputData`](../interfaces/BuildNftOutputData.md) | Options for building an `NftOutput`. | - -#### Returns - -`Promise`<`INftOutput`\> - -The built `NftOutput`. - ---- - -### burnNativeToken - -▸ **burnNativeToken**(`tokenId`, `burnAmount`, `transactionOptions?`): `Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -Burn native tokens. This doesn't require the foundry output which minted them, but will not increase -the foundries `melted_tokens` field, which makes it impossible to destroy the foundry output. Therefore it's -recommended to use melting, if the foundry output is available. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `tokenId` | `string` | The native token id. | -| `burnAmount` | `string` | The to be burned amount. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -The transaction. - ---- - -### burnNft - -▸ **burnNft**(`nftId`, `transactionOptions?`): `Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -Burn an nft output. Outputs controlled by it will be sweeped before if they don't have a storage -deposit return, timelock or _expiration unlock_ condition. This should be preferred over burning, because after -burning, the foundry can never be destroyed anymore. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `nftId` | `string` | The NftId. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -The transaction. - ---- - -### claimOutputs - -▸ **claimOutputs**(`outputIds`): `Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -Claim basic or nft outputs that have additional unlock conditions -to their `AddressUnlockCondition` from the account. - -#### Parameters - -| Name | Type | Description | -| :---------- | :--------- | :-------------------- | -| `outputIds` | `string`[] | The outputs to claim. | - -#### Returns - -`Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -The resulting transaction. - ---- - -### consolidateOutputs - -▸ **consolidateOutputs**(`force`, `outputConsolidationThreshold?`): `Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -Consolidate basic outputs with only an `AddressUnlockCondition` from an account -by sending them to an own address again if the output amount is greater or -equal to the output consolidation threshold. - -#### Parameters - -| Name | Type | Description | -| :------------------------------ | :-------- | :-------------------------------------------------------------- | -| `force` | `boolean` | Force consolidation on addresses where the threshold isn't met. | -| `outputConsolidationThreshold?` | `number` | A default threshold is used if this is omitted. | - -#### Returns - -`Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -The consolidation transaction. - ---- - -### createAliasOutput - -▸ **createAliasOutput**(`aliasOutputOptions?`, `transactionOptions?`): `Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -`createAliasOutput` creates an alias output - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `aliasOutputOptions?` | [`AliasOutputOptions`](../interfaces/AliasOutputOptions.md) | The alias output options. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -A transaction object. - ---- - -### decreaseNativeTokenSupply - -▸ **decreaseNativeTokenSupply**(`tokenId`, `meltAmount`, `transactionOptions?`): `Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -Melt native tokens. This happens with the foundry output which minted them, by increasing its -`melted_tokens` field. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `tokenId` | `string` | The native token id. | -| `meltAmount` | `string` | To be melted amount. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -The transaction. - ---- - -### destroyAlias - -▸ **destroyAlias**(`aliasId`, `transactionOptions?`): `Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -Destroy an alias output. Outputs controlled by it will be sweeped before if they don't have a -storage deposit return, timelock or expiration unlock condition. The amount and possible native tokens will be -sent to the governor address. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `aliasId` | `string` | The AliasId. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -The transaction. - ---- - -### destroyFoundry - -▸ **destroyFoundry**(`foundryId`, `transactionOptions?`): `Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -Function to destroy a foundry output with a circulating supply of 0. -Native tokens in the foundry (minted by other foundries) will be transactioned to the controlling alias. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `foundryId` | `string` | The FoundryId. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -The transaction. - ---- - -### generateAddress - -▸ **generateAddress**(`options?`): `Promise`<[`Address`](../interfaces/Address.md)\> - -Generate a new unused address. - -#### Parameters - -| Name | Type | Description | -| :--------- | :---------------------------------------------------------------------- | :------------------------------ | -| `options?` | [`AddressGenerationOptions`](../interfaces/AddressGenerationOptions.md) | Options for address generation. | - -#### Returns - -`Promise`<[`Address`](../interfaces/Address.md)\> - -The address. - ---- - -### generateAddresses - -▸ **generateAddresses**(`amount`, `options?`): `Promise`<[`Address`](../interfaces/Address.md)[]\> - -Generate new unused addresses. - -#### Parameters - -| Name | Type | Description | -| :--------- | :---------------------------------------------------------------------- | :----------------------------------- | -| `amount` | `number` | The amount of addresses to generate. | -| `options?` | [`AddressGenerationOptions`](../interfaces/AddressGenerationOptions.md) | Options for address generation. | - -#### Returns - -`Promise`<[`Address`](../interfaces/Address.md)[]\> - -The addresses. - ---- - -### getBalance - -▸ **getBalance**(): `Promise`<[`AccountBalance`](../interfaces/AccountBalance.md)\> - -Get the account balance. - -#### Returns - -`Promise`<[`AccountBalance`](../interfaces/AccountBalance.md)\> - -The account balance. - ---- - -### getOutput - -▸ **getOutput**(`outputId`): `Promise`<[`OutputData`](../interfaces/OutputData.md)\> - -Get the data for an output. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :----------------- | -| `outputId` | `string` | The output to get. | - -#### Returns - -`Promise`<[`OutputData`](../interfaces/OutputData.md)\> - -The `OutputData`. - ---- - -### getFoundryOutput - -▸ **getFoundryOutput**(`tokenId`): `Promise`<`IFoundryOutput`\> - -Get a `FoundryOutput` by native token ID. It will try to get the foundry from -the account, if it isn't in the account it will try to get it from the node. - -#### Parameters - -| Name | Type | Description | -| :-------- | :------- | :------------------------------------------ | -| `tokenId` | `string` | The native token ID to get the foundry for. | - -#### Returns - -`Promise`<`IFoundryOutput`\> - -The `FoundryOutput` that minted the token. - ---- - -### getOutputsWithAdditionalUnlockConditions - -▸ **getOutputsWithAdditionalUnlockConditions**(`outputs`): `Promise`<`string`[]\> - -Get outputs with additional unlock conditions. - -#### Parameters - -| Name | Type | Description | -| :-------- | :--------------------------------------------- | :---------------------------- | -| `outputs` | [`OutputsToClaim`](../enums/OutputsToClaim.md) | The type of outputs to claim. | - -#### Returns - -`Promise`<`string`[]\> - -The output IDs of the unlockable outputs. - ---- - -### getTransaction - -▸ **getTransaction**(`transactionId`): `Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -Get a transaction stored in the account. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :------- | :-------------------------------- | -| `transactionId` | `string` | The ID of the transaction to get. | - -#### Returns - -`Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -The transaction. - ---- - -### getIncomingTransactionData - -▸ **getIncomingTransactionData**(`transactionId`): `Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -Get the transaction with inputs of an incoming transaction stored in the account -List might not be complete, if the node pruned the data already - -#### Parameters - -| Name | Type | Description | -| :-------------- | :------- | :-------------------------------- | -| `transactionId` | `string` | The ID of the transaction to get. | - -#### Returns - -`Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -The transaction. - ---- - -### addresses - -▸ **addresses**(): `Promise`<[`Address`](../interfaces/Address.md)[]\> - -List all the addresses of the account. - -#### Returns - -`Promise`<[`Address`](../interfaces/Address.md)[]\> - -The addresses. - ---- - -### addressesWithUnspentOutputs - -▸ **addressesWithUnspentOutputs**(): `Promise`<[`AddressWithUnspentOutputs`](../interfaces/AddressWithUnspentOutputs.md)[]\> - -List the addresses of the account with unspent outputs. - -#### Returns - -`Promise`<[`AddressWithUnspentOutputs`](../interfaces/AddressWithUnspentOutputs.md)[]\> - -The addresses. - ---- - -### outputs - -▸ **outputs**(`filterOptions?`): `Promise`<[`OutputData`](../interfaces/OutputData.md)[]\> - -List all outputs of the account. - -#### Parameters - -| Name | Type | Description | -| :--------------- | :------------------------------------------------ | :-------------------------------------------- | -| `filterOptions?` | [`FilterOptions`](../interfaces/FilterOptions.md) | Options to filter the to be returned outputs. | - -#### Returns - -`Promise`<[`OutputData`](../interfaces/OutputData.md)[]\> - -The outputs with metadata. - ---- - -### pendingTransactions - -▸ **pendingTransactions**(): `Promise`<[`Transaction`](../interfaces/Transaction.md)[]\> - -List all the pending transactions of the account. - -#### Returns - -`Promise`<[`Transaction`](../interfaces/Transaction.md)[]\> - -The transactions. - ---- - -### incomingTransactions - -▸ **incomingTransactions**(): `Promise`<[`string`, [`Transaction`](../interfaces/Transaction.md)][]\> - -List all incoming transactions of the account. - -#### Returns - -`Promise`<[`string`, [`Transaction`](../interfaces/Transaction.md)][]\> - -The incoming transactions with their inputs. - ---- - -### transactions - -▸ **transactions**(): `Promise`<[`Transaction`](../interfaces/Transaction.md)[]\> - -List all the transactions of the account. - -#### Returns - -`Promise`<[`Transaction`](../interfaces/Transaction.md)[]\> - -The transactions. - ---- - -### unspentOutputs - -▸ **unspentOutputs**(`filterOptions?`): `Promise`<[`OutputData`](../interfaces/OutputData.md)[]\> - -List all the unspent outputs of the account. - -#### Parameters - -| Name | Type | Description | -| :--------------- | :------------------------------------------------ | :-------------------------------------------- | -| `filterOptions?` | [`FilterOptions`](../interfaces/FilterOptions.md) | Options to filter the to be returned outputs. | - -#### Returns - -`Promise`<[`OutputData`](../interfaces/OutputData.md)[]\> - -The outputs with metadata. - ---- - -### getMetadata - -▸ **getMetadata**(): [`AccountMetadata`](../interfaces/AccountMetadata.md) - -Get the accounts metadata. - -#### Returns - -[`AccountMetadata`](../interfaces/AccountMetadata.md) - -The accounts metadata. - ---- - -### minimumRequiredStorageDeposit - -▸ **minimumRequiredStorageDeposit**(`output`): `Promise`<`string`\> - -Calculate the minimum required storage deposit for an output. - -#### Parameters - -| Name | Type | Description | -| :------- | :------------ | :------------------------------------------ | -| `output` | `OutputTypes` | output to calculate the deposit amount for. | - -#### Returns - -`Promise`<`string`\> - -The amount. - ---- - -### increaseNativeTokenSupply - -▸ **increaseNativeTokenSupply**(`tokenId`, `mintAmount`, `increaseNativeTokenSupplyOptions?`, `transactionOptions?`): `Promise`<[`MintTokenTransaction`](../interfaces/MintTokenTransaction.md)\> - -Mint more native tokens. - -#### Parameters - -| Name | Type | Description | -| :---------------------------------- | :-------------------------------------------------------------------------------------- | :----------------------------------------------------------------- | -| `tokenId` | `string` | The native token id. | -| `mintAmount` | `string` | To be minted amount. | -| `increaseNativeTokenSupplyOptions?` | [`IncreaseNativeTokenSupplyOptions`](../interfaces/IncreaseNativeTokenSupplyOptions.md) | Options for minting more tokens. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`MintTokenTransaction`](../interfaces/MintTokenTransaction.md)\> - -The minting transaction and the token ID. - ---- - -### mintNativeToken - -▸ **mintNativeToken**(`nativeTokenOptions`, `transactionOptions?`): `Promise`<[`MintTokenTransaction`](../interfaces/MintTokenTransaction.md)\> - -Mint native tokens. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `nativeTokenOptions` | [`NativeTokenOptions`](../interfaces/NativeTokenOptions.md) | The options for minting tokens. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`MintTokenTransaction`](../interfaces/MintTokenTransaction.md)\> - -The minting transaction and the token ID. - ---- - -### mintNfts - -▸ **mintNfts**(`nftsOptions`, `transactionOptions?`): `Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -Mint nfts. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `nftsOptions` | [`NftOptions`](../interfaces/NftOptions.md)[] | The options for minting nfts. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -The minting transaction. - ---- - -### prepareOutput - -▸ **prepareOutput**(`options`, `transactionOptions?`): `Promise`<`OutputTypes`\> - -Prepare an output for sending, useful for offline signing. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `options` | [`OutputOptions`](../interfaces/OutputOptions.md) | The options for preparing an output. If the amount is below the minimum required storage deposit, by default the remaining amount will automatically be added with a `StorageDepositReturn` `UnlockCondition`, when setting the `ReturnStrategy` to `gift`, the full minimum required storage deposit will be sent to the recipient. When the assets contain an nft id, the data from the existing `NftOutput` will be used, just with the address unlock conditions replaced. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<`OutputTypes`\> - -The prepared output. - ---- - -### prepareSendAmount - -▸ **prepareSendAmount**(`addressesWithAmount`, `options?`): `Promise`<[`PreparedTransactionData`](../interfaces/PreparedTransactionData.md)\> - -Prepare a send amount transaction, useful for offline signing. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `addressesWithAmount` | [`AddressWithAmount`](../interfaces/AddressWithAmount.md)[] | Address with amounts to send. | -| `options?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`PreparedTransactionData`](../interfaces/PreparedTransactionData.md)\> - -The prepared transaction data. - ---- - -### prepareTransaction - -▸ **prepareTransaction**(`outputs`, `options?`): `Promise`<[`PreparedTransactionData`](../interfaces/PreparedTransactionData.md)\> - -Prepare a transaction, useful for offline signing. - -#### Parameters - -| Name | Type | Description | -| :--------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `outputs` | `OutputTypes`[] | Outputs to use in the transaction. | -| `options?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`PreparedTransactionData`](../interfaces/PreparedTransactionData.md)\> - -The prepared transaction data. - ---- - -### requestFundsFromFaucet - -▸ **requestFundsFromFaucet**(`url`, `address`): `Promise`<`string`\> - -Request funds from a faucet. - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `url` | `string` | -| `address` | `string` | - -#### Returns - -`Promise`<`string`\> - ---- - -### retryTransactionUntilIncluded - -▸ **retryTransactionUntilIncluded**(`transactionId`, `interval?`, `maxAttempts?`): `Promise`<[`PreparedTransactionData`](../interfaces/PreparedTransactionData.md)\> - -Retries (promotes or reattaches) a transaction sent from the account for a provided transaction id until it's -included (referenced by a milestone). Returns the included block id. - -#### Parameters - -| Name | Type | -| :-------------- | :------- | -| `transactionId` | `string` | -| `interval?` | `number` | -| `maxAttempts?` | `number` | - -#### Returns - -`Promise`<[`PreparedTransactionData`](../interfaces/PreparedTransactionData.md)\> - ---- - -### sendAmount - -▸ **sendAmount**(`addressesWithAmount`, `transactionOptions?`): `Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -Send a transaction with amounts from input addresses. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `addressesWithAmount` | [`AddressWithAmount`](../interfaces/AddressWithAmount.md)[] | Addresses with amounts. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -The sent transaction. - ---- - -### sendMicroTransaction - -▸ **sendMicroTransaction**(`addressesWithMicroAmount`, `transactionOptions?`): `Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -Send a micro transaction with amount below minimum storage deposit. - -#### Parameters - -| Name | Type | Description | -| :------------------------- | :-------------------------------------------------------------------- | :----------------------------------------------------------------- | -| `addressesWithMicroAmount` | [`AddressWithMicroAmount`](../interfaces/AddressWithMicroAmount.md)[] | Addresses with micro amounts. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -The sent transaction. - ---- - -### sendNativeTokens - -▸ **sendNativeTokens**(`addressesNativeTokens`, `transactionOptions?`): `Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -Send native tokens. - -#### Parameters - -| Name | Type | Description | -| :---------------------- | :-------------------------------------------------------------- | :----------------------------------------------------------------- | -| `addressesNativeTokens` | [`AddressNativeTokens`](../interfaces/AddressNativeTokens.md)[] | Addresses amounts and native tokens. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -The sent transaction. - ---- - -### sendNft - -▸ **sendNft**(`addressesAndNftIds`, `transactionOptions?`): `Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -Send nft. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `addressesAndNftIds` | [`AddressNftId`](../interfaces/AddressNftId.md)[] | Addresses and nft ids. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -The sent transaction. - ---- - -### sendOutputs - -▸ **sendOutputs**(`outputs`, `transactionOptions?`): `Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -Send outputs in a transaction. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `outputs` | `OutputTypes`[] | The outputs to send. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -The sent transaction. - ---- - -### setAlias - -▸ **setAlias**(`alias`): `Promise`<`void`\> - -Set the alias for the account - -#### Parameters - -| Name | Type | Description | -| :------ | :------- | :------------------------ | -| `alias` | `string` | The account alias to set. | - -#### Returns - -`Promise`<`void`\> - ---- - -### signTransactionEssence - -▸ **signTransactionEssence**(`preparedTransactionData`): `Promise`<[`SignedTransactionEssence`](../interfaces/SignedTransactionEssence.md)\> - -Sign a prepared transaction, useful for offline signing. - -#### Parameters - -| Name | Type | Description | -| :------------------------ | :-------------------------------------------------------------------- | :------------------------------------- | -| `preparedTransactionData` | [`PreparedTransactionData`](../interfaces/PreparedTransactionData.md) | The prepared transaction data to sign. | - -#### Returns - -`Promise`<[`SignedTransactionEssence`](../interfaces/SignedTransactionEssence.md)\> - -The signed transaction essence. - ---- - -### submitAndStoreTransaction - -▸ **submitAndStoreTransaction**(`signedTransactionData`): `Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -Validate the transaction, submit it to a node and store it in the account. - -#### Parameters - -| Name | Type | Description | -| :---------------------- | :---------------------------------------------------------------------- | :---------------------------------------- | -| `signedTransactionData` | [`SignedTransactionEssence`](../interfaces/SignedTransactionEssence.md) | A signed transaction to submit and store. | - -#### Returns - -`Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -The sent transaction. - ---- - -### sync - -▸ **sync**(`options?`): `Promise`<[`AccountBalance`](../interfaces/AccountBalance.md)\> - -Sync the account by fetching new information from the nodes. -Will also retry pending transactions if necessary. - -#### Parameters - -| Name | Type | Description | -| :--------- | :-------------------------------------------- | :-------------------------------- | -| `options?` | [`SyncOptions`](../interfaces/SyncOptions.md) | Optional synchronization options. | - -#### Returns - -`Promise`<[`AccountBalance`](../interfaces/AccountBalance.md)\> - -The account balance. - ---- - -### getParticipationOverview - -▸ **getParticipationOverview**(`eventIds?`): `Promise`<`ParticipationOverview`\> - -Calculates the voting overview of an account. - -#### Parameters - -| Name | Type | Description | -| :---------- | :--------- | :--------------------------------------------------------- | -| `eventIds?` | `string`[] | Optional, filters participations only for provided events. | - -#### Returns - -`Promise`<`ParticipationOverview`\> - -ParticipationOverview diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/classes/AccountManager.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/classes/AccountManager.md deleted file mode 100644 index 1fefd171d43..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/classes/AccountManager.md +++ /dev/null @@ -1,525 +0,0 @@ -# Class: AccountManager - -The AccountManager class. - -## Table of contents - -### Methods - -- [backup](AccountManager.md#backup) -- [bech32ToHex](AccountManager.md#bech32tohex) -- [changeStrongholdPassword](AccountManager.md#changestrongholdpassword) -- [clearStrongholdPassword](AccountManager.md#clearstrongholdpassword) -- [createAccount](AccountManager.md#createaccount) -- [destroy](AccountManager.md#destroy) -- [emitTestEvent](AccountManager.md#emittestevent) -- [generateMnemonic](AccountManager.md#generatemnemonic) -- [getAccount](AccountManager.md#getaccount) -- [getAccountIndexes](AccountManager.md#getaccountindexes) -- [getAccounts](AccountManager.md#getaccounts) -- [generateAddress](AccountManager.md#generateaddress) -- [getNodeInfo](AccountManager.md#getnodeinfo) -- [getLedgerNanoStatus](AccountManager.md#getledgernanostatus) -- [hexToBech32](AccountManager.md#hextobech32) -- [isStrongholdPasswordAvailable](AccountManager.md#isstrongholdpasswordavailable) -- [listen](AccountManager.md#listen) -- [clearListeners](AccountManager.md#clearlisteners) -- [recoverAccounts](AccountManager.md#recoveraccounts) -- [removeLatestAccount](AccountManager.md#removelatestaccount) -- [restoreBackup](AccountManager.md#restorebackup) -- [setClientOptions](AccountManager.md#setclientoptions) -- [setStrongholdPassword](AccountManager.md#setstrongholdpassword) -- [setStrongholdPasswordClearInterval](AccountManager.md#setstrongholdpasswordclearinterval) -- [startBackgroundSync](AccountManager.md#startbackgroundsync) -- [stopBackgroundSync](AccountManager.md#stopbackgroundsync) -- [storeMnemonic](AccountManager.md#storemnemonic) -- [verifyMnemonic](AccountManager.md#verifymnemonic) -- [updateNodeAuth](AccountManager.md#updatenodeauth) - -## Methods - -### backup - -▸ **backup**(`destination`, `password`): `Promise`<`void`\> - -Backup the data to a Stronghold snapshot. - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `destination` | `string` | -| `password` | `string` | - -#### Returns - -`Promise`<`void`\> - ---- - -### bech32ToHex - -▸ **bech32ToHex**(`bech32Address`): `Promise`<`string`\> - -Transform a bech32 encoded address to a hex encoded address - -#### Parameters - -| Name | Type | -| :-------------- | :------- | -| `bech32Address` | `string` | - -#### Returns - -`Promise`<`string`\> - ---- - -### changeStrongholdPassword - -▸ **changeStrongholdPassword**(`currentPassword`, `newPassword`): `Promise`<`void`\> - -Change the Stronghold password. - -#### Parameters - -| Name | Type | -| :---------------- | :------- | -| `currentPassword` | `string` | -| `newPassword` | `string` | - -#### Returns - -`Promise`<`void`\> - ---- - -### clearStrongholdPassword - -▸ **clearStrongholdPassword**(): `Promise`<`void`\> - -Clear the Stronghold password from memory. - -#### Returns - -`Promise`<`void`\> - ---- - -### createAccount - -▸ **createAccount**(`payload`): `Promise`<[`Account`](Account.md)\> - -Create a new account. - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------- | -| `payload` | [`CreateAccountPayload`](../interfaces/CreateAccountPayload.md) | - -#### Returns - -`Promise`<[`Account`](Account.md)\> - ---- - -### destroy - -▸ **destroy**(): `Promise`<`void`\> - -Destroy the AccountManager and drop its database connection. - -#### Returns - -`Promise`<`void`\> - ---- - -### emitTestEvent - -▸ **emitTestEvent**(`event`): `Promise`<`void`\> - -Emit a provided event for testing of the event system. - -#### Parameters - -| Name | Type | -| :------ | :--------------------------------------- | -| `event` | [`WalletEvent`](../enums/WalletEvent.md) | - -#### Returns - -`Promise`<`void`\> - ---- - -### generateMnemonic - -▸ **generateMnemonic**(): `Promise`<`string`\> - -Generate a random BIP39 mnemonic. - -#### Returns - -`Promise`<`string`\> - ---- - -### getAccount - -▸ **getAccount**(`accountId`): `Promise`<[`Account`](Account.md)\> - -Get an account by its alias or index. - -#### Parameters - -| Name | Type | -| :---------- | :------------------------------------- | -| `accountId` | [`AccountId`](../api_ref.md#accountid) | - -#### Returns - -`Promise`<[`Account`](Account.md)\> - ---- - -### getAccountIndexes - -▸ **getAccountIndexes**(): `Promise`<`number`[]\> - -Get all account indexes. - -#### Returns - -`Promise`<`number`[]\> - ---- - -### getAccounts - -▸ **getAccounts**(): `Promise`<[`Account`](Account.md)[]\> - -Get all accounts. - -#### Returns - -`Promise`<[`Account`](Account.md)[]\> - ---- - -### generateAddress - -▸ **generateAddress**(`accountIndex`, `internal`, `addressIndex`, `options?`, `bech32Hrp?`): `Promise`<`string`\> - -Generate an address without storing it. - -#### Parameters - -| Name | Type | -| :------------- | :------------------------------------------------------------------ | -| `accountIndex` | `number` | -| `internal` | `boolean` | -| `addressIndex` | `number` | -| `options?` | [`GenerateAddressOptions`](../interfaces/GenerateAddressOptions.md) | -| `bech32Hrp?` | `string` | - -#### Returns - -`Promise`<`string`\> - ---- - -### getNodeInfo - -▸ **getNodeInfo**(`url?`, `auth?`): `Promise`<[`NodeInfoWrapper`](../interfaces/NodeInfoWrapper.md)\> - -Get the node info. - -#### Parameters - -| Name | Type | -| :------ | :--------------------------- | -| `url?` | `string` | -| `auth?` | [`Auth`](../api_ref.md#auth) | - -#### Returns - -`Promise`<[`NodeInfoWrapper`](../interfaces/NodeInfoWrapper.md)\> - ---- - -### getLedgerNanoStatus - -▸ **getLedgerNanoStatus**(): `Promise`<[`LedgerNanoStatus`](../interfaces/LedgerNanoStatus.md)\> - -Get the status for a Ledger Nano. - -#### Returns - -`Promise`<[`LedgerNanoStatus`](../interfaces/LedgerNanoStatus.md)\> - ---- - -### hexToBech32 - -▸ **hexToBech32**(`hex`, `bech32Hrp?`): `Promise`<`string`\> - -Transform hex encoded address to bech32 encoded address. If no bech32Hrp -is provided, the AccountManager will attempt to retrieve it from the -NodeInfo. If this does not succeed, it will default to the Shimmer testnet bech32Hrp. - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `hex` | `string` | -| `bech32Hrp?` | `string` | - -#### Returns - -`Promise`<`string`\> - ---- - -### isStrongholdPasswordAvailable - -▸ **isStrongholdPasswordAvailable**(): `Promise`<`boolean`\> - -Check if the Stronghold password has been set. - -#### Returns - -`Promise`<`boolean`\> - ---- - -### listen - -▸ **listen**(`eventTypes`, `callback`): `void` - -Listen to wallet events with a callback. An empty array will listen to all possible events. - -#### Parameters - -| Name | Type | -| :----------- | :----------------------------------------------- | -| `eventTypes` | [`EventType`](../api_ref.md#eventtype)[] | -| `callback` | (`error`: `Error`, `result`: `string`) => `void` | - -#### Returns - -`void` - ---- - -### clearListeners - -▸ **clearListeners**(`eventTypes`): `Promise`<`void`\> - -Clear the callbacks for provided events. An empty array will clear all listeners. - -#### Parameters - -| Name | Type | -| :----------- | :--------------------------------------- | -| `eventTypes` | [`EventType`](../api_ref.md#eventtype)[] | - -#### Returns - -`Promise`<`void`\> - ---- - -### recoverAccounts - -▸ **recoverAccounts**(`accountStartIndex`, `accountGapLimit`, `addressGapLimit`, `syncOptions`): `Promise`<[`Account`](Account.md)[]\> - -Find accounts with unspent outputs. - -#### Parameters - -| Name | Type | -| :------------------ | :---------------------------------------------------------- | -| `accountStartIndex` | `number` | -| `accountGapLimit` | `number` | -| `addressGapLimit` | `number` | -| `syncOptions` | [`AccountSyncOptions`](../interfaces/AccountSyncOptions.md) | - -#### Returns - -`Promise`<[`Account`](Account.md)[]\> - ---- - -### removeLatestAccount - -▸ **removeLatestAccount**(): `Promise`<`void`\> - -Delete the latest account. - -#### Returns - -`Promise`<`void`\> - ---- - -### restoreBackup - -▸ **restoreBackup**(`source`, `password`): `Promise`<`void`\> - -Restore a backup from a Stronghold file -Replaces client_options, coin_type, secret_manager and accounts. Returns an error if accounts were already created -If Stronghold is used as secret_manager, the existing Stronghold file will be overwritten. If a mnemonic was -stored, it will be gone. - -#### Parameters - -| Name | Type | -| :--------- | :------- | -| `source` | `string` | -| `password` | `string` | - -#### Returns - -`Promise`<`void`\> - ---- - -### setClientOptions - -▸ **setClientOptions**(`clientOptions`): `Promise`<`void`\> - -Set ClientOptions. - -#### Parameters - -| Name | Type | -| :-------------- | :------------------------------------------------ | -| `clientOptions` | [`ClientOptions`](../interfaces/ClientOptions.md) | - -#### Returns - -`Promise`<`void`\> - ---- - -### setStrongholdPassword - -▸ **setStrongholdPassword**(`password`): `Promise`<`void`\> - -Set the Stronghold password. - -#### Parameters - -| Name | Type | -| :--------- | :------- | -| `password` | `string` | - -#### Returns - -`Promise`<`void`\> - ---- - -### setStrongholdPasswordClearInterval - -▸ **setStrongholdPasswordClearInterval**(`intervalInMilliseconds?`): `Promise`<`void`\> - -Set the interval after which the Stronghold password gets cleared from memory. - -#### Parameters - -| Name | Type | -| :------------------------ | :------- | -| `intervalInMilliseconds?` | `number` | - -#### Returns - -`Promise`<`void`\> - ---- - -### startBackgroundSync - -▸ **startBackgroundSync**(`options?`, `intervalInMilliseconds?`): `Promise`<`void`\> - -Start the background syncing process for all accounts. - -#### Parameters - -| Name | Type | -| :------------------------ | :---------------------------------------------------------- | -| `options?` | [`AccountSyncOptions`](../interfaces/AccountSyncOptions.md) | -| `intervalInMilliseconds?` | `number` | - -#### Returns - -`Promise`<`void`\> - ---- - -### stopBackgroundSync - -▸ **stopBackgroundSync**(): `Promise`<`void`\> - -Stop the background syncing process for all accounts. - -#### Returns - -`Promise`<`void`\> - ---- - -### storeMnemonic - -▸ **storeMnemonic**(`mnemonic`): `Promise`<`void`\> - -Store a mnemonic in the Stronghold snapshot. - -#### Parameters - -| Name | Type | -| :--------- | :------- | -| `mnemonic` | `string` | - -#### Returns - -`Promise`<`void`\> - ---- - -### verifyMnemonic - -▸ **verifyMnemonic**(`mnemonic`): `Promise`<`void`\> - -Verify if a mnemonic is a valid BIP39 mnemonic. - -#### Parameters - -| Name | Type | -| :--------- | :------- | -| `mnemonic` | `string` | - -#### Returns - -`Promise`<`void`\> - ---- - -### updateNodeAuth - -▸ **updateNodeAuth**(`url`, `auth?`): `Promise`<`void`\> - -Update the authentication for the provided node. - -#### Parameters - -| Name | Type | -| :------ | :--------------------------- | -| `url` | `string` | -| `auth?` | [`Auth`](../api_ref.md#auth) | - -#### Returns - -`Promise`<`void`\> diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/AddressType.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/AddressType.md deleted file mode 100644 index b615b92275d..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/AddressType.md +++ /dev/null @@ -1,29 +0,0 @@ -# Enumeration: AddressType - -Address Types - -## Table of contents - -### Enumeration Members - -- [Ed25519](AddressType.md#ed25519) -- [Alias](AddressType.md#alias) -- [Nft](AddressType.md#nft) - -## Enumeration Members - -### Ed25519 - -• **Ed25519** = `"Ed25519"` - ---- - -### Alias - -• **Alias** = `"Alias"` - ---- - -### Nft - -• **Nft** = `"Nft"` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/CoinType.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/CoinType.md deleted file mode 100644 index 3ad45cbcf9f..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/CoinType.md +++ /dev/null @@ -1,22 +0,0 @@ -# Enumeration: CoinType - -IOTA and Shimmer coin types - -## Table of contents - -### Enumeration Members - -- [IOTA](CoinType.md#iota) -- [Shimmer](CoinType.md#shimmer) - -## Enumeration Members - -### IOTA - -• **IOTA** = `4218` - ---- - -### Shimmer - -• **Shimmer** = `4219` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/InclusionState.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/InclusionState.md deleted file mode 100644 index 3f0c98327a6..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/InclusionState.md +++ /dev/null @@ -1,44 +0,0 @@ -# Enumeration: InclusionState - -Possible InclusionStates of transactions sent with the wallet - -## Table of contents - -### Enumeration Members - -- [Pending](InclusionState.md#pending) -- [Confirmed](InclusionState.md#confirmed) -- [Conflicting](InclusionState.md#conflicting) -- [UnknownPruned](InclusionState.md#unknownpruned) - -## Enumeration Members - -### Pending - -• **Pending** = `"Pending"` - -The transaction is pending - ---- - -### Confirmed - -• **Confirmed** = `"Confirmed"` - -The transaction is confirmed - ---- - -### Conflicting - -• **Conflicting** = `"Conflicting"` - -The transaction is conflicting - ---- - -### UnknownPruned - -• **UnknownPruned** = `"UnknownPruned"` - -The transaction and its in- and outputs are pruned, so it's unknown if it got confirmed or was conflicting diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/LedgerDeviceType.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/LedgerDeviceType.md deleted file mode 100644 index 2501a99809e..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/LedgerDeviceType.md +++ /dev/null @@ -1,29 +0,0 @@ -# Enumeration: LedgerDeviceType - -The Ledger Device Type - -## Table of contents - -### Enumeration Members - -- [LedgerNanoS](LedgerDeviceType.md#ledgernanos) -- [LedgerNanoX](LedgerDeviceType.md#ledgernanox) -- [LedgerNanoSPlus](LedgerDeviceType.md#ledgernanosplus) - -## Enumeration Members - -### LedgerNanoS - -• **LedgerNanoS** = `"ledgerNanoS"` - ---- - -### LedgerNanoX - -• **LedgerNanoX** = `"ledgerNanoX"` - ---- - -### LedgerNanoSPlus - -• **LedgerNanoSPlus** = `"ledgerNanoSPlus"` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/Network.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/Network.md deleted file mode 100644 index e5f1453ea28..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/Network.md +++ /dev/null @@ -1,22 +0,0 @@ -# Enumeration: Network - -Network types - -## Table of contents - -### Enumeration Members - -- [Mainnet](Network.md#mainnet) -- [Testnet](Network.md#testnet) - -## Enumeration Members - -### Mainnet - -• **Mainnet** = `0` - ---- - -### Testnet - -• **Testnet** = `1` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/OutputsToClaim.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/OutputsToClaim.md deleted file mode 100644 index 1446c907d46..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/OutputsToClaim.md +++ /dev/null @@ -1,43 +0,0 @@ -# Enumeration: OutputsToClaim - -Output to claim - -## Table of contents - -### Enumeration Members - -- [None](OutputsToClaim.md#none) -- [MicroTransactions](OutputsToClaim.md#microtransactions) -- [NativeTokens](OutputsToClaim.md#nativetokens) -- [Nfts](OutputsToClaim.md#nfts) -- [All](OutputsToClaim.md#all) - -## Enumeration Members - -### None - -• **None** = `"None"` - ---- - -### MicroTransactions - -• **MicroTransactions** = `"MicroTransactions"` - ---- - -### NativeTokens - -• **NativeTokens** = `"NativeTokens"` - ---- - -### Nfts - -• **Nfts** = `"Nfts"` - ---- - -### All - -• **All** = `"All"` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/ReturnStrategy.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/ReturnStrategy.md deleted file mode 100644 index b56297e8786..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/ReturnStrategy.md +++ /dev/null @@ -1,22 +0,0 @@ -# Enumeration: ReturnStrategy - -Return strategy for the storage deposit - -## Table of contents - -### Enumeration Members - -- [Return](ReturnStrategy.md#return) -- [Gift](ReturnStrategy.md#gift) - -## Enumeration Members - -### Return - -• **Return** = `"Return"` - ---- - -### Gift - -• **Gift** = `"Gift"` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/WalletEvent.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/WalletEvent.md deleted file mode 100644 index be23a28eb21..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/enums/WalletEvent.md +++ /dev/null @@ -1,50 +0,0 @@ -# Enumeration: WalletEvent - -Wallet events - -## Table of contents - -### Enumeration Members - -- [ConsolidationRequired](WalletEvent.md#consolidationrequired) -- [LedgerAddressGeneration](WalletEvent.md#ledgeraddressgeneration) -- [NewOutput](WalletEvent.md#newoutput) -- [SpentOutput](WalletEvent.md#spentoutput) -- [TransactionInclusion](WalletEvent.md#transactioninclusion) -- [TransactionProgress](WalletEvent.md#transactionprogress) - -## Enumeration Members - -### ConsolidationRequired - -• **ConsolidationRequired** = `"ConsolidationRequired"` - ---- - -### LedgerAddressGeneration - -• **LedgerAddressGeneration** = `"LedgerAddressGeneration"` - ---- - -### NewOutput - -• **NewOutput** = `"NewOutput"` - ---- - -### SpentOutput - -• **SpentOutput** = `"SpentOutput"` - ---- - -### TransactionInclusion - -• **TransactionInclusion** = `"TransactionInclusion"` - ---- - -### TransactionProgress - -• **TransactionProgress** = `"TransactionProgress"` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AccountBalance.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AccountBalance.md deleted file mode 100644 index 66644267066..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AccountBalance.md +++ /dev/null @@ -1,76 +0,0 @@ -# Interface: AccountBalance - -The balance of an account - -## Table of contents - -### Properties - -- [baseCoin](AccountBalance.md#basecoin) -- [requiredStorageDeposit](AccountBalance.md#requiredstoragedeposit) -- [nativeTokens](AccountBalance.md#nativetokens) -- [nfts](AccountBalance.md#nfts) -- [aliases](AccountBalance.md#aliases) -- [foundries](AccountBalance.md#foundries) -- [potentiallyLockedOutputs](AccountBalance.md#potentiallylockedoutputs) - -## Properties - -### baseCoin - -• **baseCoin**: [`BaseCoinBalance`](BaseCoinBalance.md) - -The balance of the base coin - ---- - -### requiredStorageDeposit - -• **requiredStorageDeposit**: [`RequiredStorageDeposit`](RequiredStorageDeposit.md) - -The required storage deposit for the outputs - ---- - -### nativeTokens - -• **nativeTokens**: [`NativeTokenBalance`](NativeTokenBalance.md)[] - -The balance of the native tokens - ---- - -### nfts - -• **nfts**: `string`[] - -Nft outputs - ---- - -### aliases - -• **aliases**: `string`[] - -Alias outputs - ---- - -### foundries - -• **foundries**: `string`[] - -Foundry outputs - ---- - -### potentiallyLockedOutputs - -• **potentiallyLockedOutputs**: `Object` - -Outputs with multiple unlock conditions and if they can currently be spent or not. If there is a -TimelockUnlockCondition or ExpirationUnlockCondition this can change at any time - -#### Index signature - -▪ [outputId: `string`]: `boolean` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AccountManagerOptions.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AccountManagerOptions.md deleted file mode 100644 index e499e82bd59..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AccountManagerOptions.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: AccountManagerOptions - -Options for the AccountManager builder diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AccountMeta.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AccountMeta.md deleted file mode 100644 index ec2c83dda34..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AccountMeta.md +++ /dev/null @@ -1,39 +0,0 @@ -# Interface: AccountMeta - -The account object - -## Table of contents - -### Properties - -- [lockedOutputs](AccountMeta.md#lockedoutputs) -- [pendingTransactions](AccountMeta.md#pendingtransactions) -- [incomingTransactions](AccountMeta.md#incomingtransactions) - -## Properties - -### lockedOutputs - -• **lockedOutputs**: `Set`<`string`\> - -Output IDs of unspent outputs that are currently used as input for transactions - ---- - -### pendingTransactions - -• **pendingTransactions**: `Set`<`string`\> - -Transaction IDs of pending transactions - ---- - -### incomingTransactions - -• **incomingTransactions**: `Object` - -Incoming transactions with their inputs if available and not already pruned - -#### Index signature - -▪ [transactionId: `string`]: [`ITransactionPayload`, `IOutputResponse`[]] diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AccountMetadata.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AccountMetadata.md deleted file mode 100644 index 7ef38b63984..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AccountMetadata.md +++ /dev/null @@ -1,35 +0,0 @@ -# Interface: AccountMetadata - -The account metadata - -## Table of contents - -### Properties - -- [alias](AccountMetadata.md#alias) -- [coinType](AccountMetadata.md#cointype) -- [index](AccountMetadata.md#index) - -## Properties - -### alias - -• **alias**: `string` - -The account alias - ---- - -### coinType - -• **coinType**: [`CoinType`](../enums/CoinType.md) - -The used coin type - ---- - -### index - -• **index**: `number` - -The account index which will be used in the BIP32 path diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AccountSyncOptions.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AccountSyncOptions.md deleted file mode 100644 index 1ab0fee3839..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AccountSyncOptions.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: AccountSyncOptions - -Specifies what outputs should be synced for the ed25519 addresses from the account. diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Address.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Address.md deleted file mode 100644 index c8a97ae44b2..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Address.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: Address - -An Address of the Account diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressGenerationOptions.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressGenerationOptions.md deleted file mode 100644 index a3e3c3e8fd7..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressGenerationOptions.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: AddressGenerationOptions - -Options for address generation, options is used only with a Ledger Nano SecretManager diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressNativeTokens.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressNativeTokens.md deleted file mode 100644 index 254edf0af94..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressNativeTokens.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: AddressNativeTokens - -Address with native tokens diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressNftId.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressNftId.md deleted file mode 100644 index de243b07e0d..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressNftId.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: AddressNftId - -Address with an NftId diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressWithAmount.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressWithAmount.md deleted file mode 100644 index a32653ddfdb..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressWithAmount.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: AddressWithAmount - -Address with a base token amount diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressWithMicroAmount.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressWithMicroAmount.md deleted file mode 100644 index ea80f65faf0..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressWithMicroAmount.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: AddressWithMicroAmount - -Address with a base token amount for a micro transaction diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressWithUnspentOutputs.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressWithUnspentOutputs.md deleted file mode 100644 index bb81166f7c5..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AddressWithUnspentOutputs.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: AddressWithUnspentOutputs - -Address with unspent outputs diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AliasOutputOptions.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AliasOutputOptions.md deleted file mode 100644 index 1f062a0c518..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AliasOutputOptions.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: AliasOutputOptions - -Options for the alias output creation - -## Table of contents - -### Properties - -- [address](AliasOutputOptions.md#address) -- [immutableMetadata](AliasOutputOptions.md#immutablemetadata) -- [metadata](AliasOutputOptions.md#metadata) -- [stateMetadata](AliasOutputOptions.md#statemetadata) - -## Properties - -### address - -• `Optional` **address**: `string` - -Bech32 encoded address to which the Nft will be minted. Default will use the -first address of the account - ---- - -### immutableMetadata - -• `Optional` **immutableMetadata**: `string` - -Hex encoded bytes - ---- - -### metadata - -• `Optional` **metadata**: `string` - -Hex encoded bytes - ---- - -### stateMetadata - -• `Optional` **stateMetadata**: `string` - -Hex encoded bytes diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AliasSyncOptions.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AliasSyncOptions.md deleted file mode 100644 index 9c5a732ae57..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/AliasSyncOptions.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: AliasSyncOptions - -Specifies what outputs should be synced for the address of an alias output. diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Assets.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Assets.md deleted file mode 100644 index ab24dfb510a..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Assets.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: Assets - -Assets to include in the output diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/BaseCoinBalance.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/BaseCoinBalance.md deleted file mode 100644 index 08fdc331087..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/BaseCoinBalance.md +++ /dev/null @@ -1,26 +0,0 @@ -# Interface: BaseCoinBalance - -The balance of the base coin - -## Table of contents - -### Properties - -- [total](BaseCoinBalance.md#total) -- [available](BaseCoinBalance.md#available) - -## Properties - -### total - -• **total**: `string` - -The total amount of the outputs - ---- - -### available - -• **available**: `string` - -The amount of the outputs that aren't used in a transaction diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/BuildAliasOutputData.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/BuildAliasOutputData.md deleted file mode 100644 index 95718d1711c..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/BuildAliasOutputData.md +++ /dev/null @@ -1,27 +0,0 @@ -# Interface: BuildAliasOutputData - -An alias output - -## Hierarchy - -- [`BuildBasicOutputData`](BuildBasicOutputData.md) - - ↳ **`BuildAliasOutputData`** - -## Table of contents - -### Properties - -- [amount](BuildAliasOutputData.md#amount) - -## Properties - -### amount - -• `Optional` **amount**: `string` - -If not provided, minimum storage deposit will be used - -#### Inherited from - -[BuildBasicOutputData](BuildBasicOutputData.md).[amount](BuildBasicOutputData.md#amount) diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/BuildBasicOutputData.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/BuildBasicOutputData.md deleted file mode 100644 index d85d37bfd83..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/BuildBasicOutputData.md +++ /dev/null @@ -1,27 +0,0 @@ -# Interface: BuildBasicOutputData - -A basic output - -## Hierarchy - -- **`BuildBasicOutputData`** - - ↳ [`BuildAliasOutputData`](BuildAliasOutputData.md) - - ↳ [`BuildFoundryOutputData`](BuildFoundryOutputData.md) - - ↳ [`BuildNftOutputData`](BuildNftOutputData.md) - -## Table of contents - -### Properties - -- [amount](BuildBasicOutputData.md#amount) - -## Properties - -### amount - -• `Optional` **amount**: `string` - -If not provided, minimum storage deposit will be used diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/BuildFoundryOutputData.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/BuildFoundryOutputData.md deleted file mode 100644 index dbc3ab39431..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/BuildFoundryOutputData.md +++ /dev/null @@ -1,27 +0,0 @@ -# Interface: BuildFoundryOutputData - -A foundry output - -## Hierarchy - -- [`BuildBasicOutputData`](BuildBasicOutputData.md) - - ↳ **`BuildFoundryOutputData`** - -## Table of contents - -### Properties - -- [amount](BuildFoundryOutputData.md#amount) - -## Properties - -### amount - -• `Optional` **amount**: `string` - -If not provided, minimum storage deposit will be used - -#### Inherited from - -[BuildBasicOutputData](BuildBasicOutputData.md).[amount](BuildBasicOutputData.md#amount) diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/BuildNftOutputData.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/BuildNftOutputData.md deleted file mode 100644 index a7d499237a7..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/BuildNftOutputData.md +++ /dev/null @@ -1,27 +0,0 @@ -# Interface: BuildNftOutputData - -An nft output - -## Hierarchy - -- [`BuildBasicOutputData`](BuildBasicOutputData.md) - - ↳ **`BuildNftOutputData`** - -## Table of contents - -### Properties - -- [amount](BuildNftOutputData.md#amount) - -## Properties - -### amount - -• `Optional` **amount**: `string` - -If not provided, minimum storage deposit will be used - -#### Inherited from - -[BuildBasicOutputData](BuildBasicOutputData.md).[amount](BuildBasicOutputData.md#amount) diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/ClientOptions.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/ClientOptions.md deleted file mode 100644 index 88f2256c061..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/ClientOptions.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: ClientOptions - -Options for the client builder diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/CreateAccountPayload.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/CreateAccountPayload.md deleted file mode 100644 index 619210f8346..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/CreateAccountPayload.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: CreateAccountPayload - -Options for account creation diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Features.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Features.md deleted file mode 100644 index 3c2c65b2c9e..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Features.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: Features - -Features to include in the output diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/FilterOptions.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/FilterOptions.md deleted file mode 100644 index 09fc01072e8..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/FilterOptions.md +++ /dev/null @@ -1,35 +0,0 @@ -# Interface: FilterOptions - -Options to filter outputs - -## Table of contents - -### Properties - -- [lowerBoundBookedTimestamp](FilterOptions.md#lowerboundbookedtimestamp) -- [upperBoundBookedTimestamp](FilterOptions.md#upperboundbookedtimestamp) -- [outputTypes](FilterOptions.md#outputtypes) - -## Properties - -### lowerBoundBookedTimestamp - -• `Optional` **lowerBoundBookedTimestamp**: `number` - -Filter all outputs where the booked milestone index is below the specified timestamp - ---- - -### upperBoundBookedTimestamp - -• `Optional` **upperBoundBookedTimestamp**: `number` - -Filter all outputs where the booked milestone index is above the specified timestamp - ---- - -### outputTypes - -• `Optional` **outputTypes**: `Uint8Array` - -Filter all outputs for the provided types (Basic = 3, Alias = 4, Foundry = 5, NFT = 6) diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/GenerateAddressOptions.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/GenerateAddressOptions.md deleted file mode 100644 index 4da419a3553..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/GenerateAddressOptions.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: GenerateAddressOptions - -Options for address generation, useful with a Ledger Nano SecretManager diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/IncreaseNativeTokenSupplyOptions.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/IncreaseNativeTokenSupplyOptions.md deleted file mode 100644 index 0508d1fea61..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/IncreaseNativeTokenSupplyOptions.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: IncreaseNativeTokenSupplyOptions - -Native token options for minting more native tokens diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/InputSigningData.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/InputSigningData.md deleted file mode 100644 index 7b7e3b593cb..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/InputSigningData.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: InputSigningData - -Data for transaction inputs for signing and ordering of unlock blocks - -## Table of contents - -### Properties - -- [output](InputSigningData.md#output) -- [outputMetaData](InputSigningData.md#outputmetadata) -- [chain](InputSigningData.md#chain) -- [bech32Address](InputSigningData.md#bech32address) - -## Properties - -### output - -• **output**: `OutputTypes` - -The output - ---- - -### outputMetaData - -• **outputMetaData**: `IOutputMetadataResponse` - -The output metadata - ---- - -### chain - -• `Optional` **chain**: [`Segment`](Segment.md)[] - -The chain derived from seed, only for ed25519 addresses - ---- - -### bech32Address - -• **bech32Address**: `string` - -The bech32 encoded address, required because of alias outputs where we have multiple possible unlock -conditions, because we otherwise don't know which one we need diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/LedgerApp.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/LedgerApp.md deleted file mode 100644 index 047b35ab872..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/LedgerApp.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: LedgerApp - -The current opened app diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/LedgerNanoSecretManager.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/LedgerNanoSecretManager.md deleted file mode 100644 index f1d89c496a4..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/LedgerNanoSecretManager.md +++ /dev/null @@ -1,17 +0,0 @@ -# Interface: LedgerNanoSecretManager - -Secret manager that uses a Ledger Nano hardware wallet or Speculos simulator. - -## Table of contents - -### Properties - -- [ledgerNano](LedgerNanoSecretManager.md#ledgernano) - -## Properties - -### ledgerNano - -• **ledgerNano**: `boolean` - -boolean indicates whether it's a simulator or not. diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/LedgerNanoStatus.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/LedgerNanoStatus.md deleted file mode 100644 index 2db2b7b002b..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/LedgerNanoStatus.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: LedgerNanoStatus - -The status of a Ledger Nano diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/LoggerConfig.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/LoggerConfig.md deleted file mode 100644 index f6a3c7cbac0..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/LoggerConfig.md +++ /dev/null @@ -1,53 +0,0 @@ -# Interface: LoggerConfig - -Logger output configuration. - -## Table of contents - -### Properties - -- [name](LoggerConfig.md#name) -- [levelFilter](LoggerConfig.md#levelfilter) -- [targetFilter](LoggerConfig.md#targetfilter) -- [targetExclusions](LoggerConfig.md#targetexclusions) -- [colorEnabled](LoggerConfig.md#colorenabled) - -## Properties - -### name - -• `Optional` **name**: `string` - -Name of an output file, or `stdout` for standard output. - ---- - -### levelFilter - -• `Optional` **levelFilter**: `"error"` \| `"off"` \| `"warn"` \| `"info"` \| `"debug"` \| `"trace"` - -Log level filter of an output. - ---- - -### targetFilter - -• `Optional` **targetFilter**: `string`[] - -Log target filters of an output. - ---- - -### targetExclusions - -• `Optional` **targetExclusions**: `string`[] - -Log target exclusions of an output. - ---- - -### colorEnabled - -• `Optional` **colorEnabled**: `boolean` - -Color flag of an output. diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/MintTokenTransaction.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/MintTokenTransaction.md deleted file mode 100644 index d3c0f52bea2..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/MintTokenTransaction.md +++ /dev/null @@ -1,26 +0,0 @@ -# Interface: MintTokenTransaction - -The result of a minting operation - -## Table of contents - -### Properties - -- [tokenId](MintTokenTransaction.md#tokenid) -- [transaction](MintTokenTransaction.md#transaction) - -## Properties - -### tokenId - -• **tokenId**: `string` - -The token id of the minted token - ---- - -### transaction - -• **transaction**: [`Transaction`](Transaction.md) - -The transaction which minted the token diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/MnemonicSecretManager.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/MnemonicSecretManager.md deleted file mode 100644 index a0a5e97e5c7..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/MnemonicSecretManager.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: MnemonicSecretManager - -Secret manager that uses a mnemonic. diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NativeTokenBalance.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NativeTokenBalance.md deleted file mode 100644 index 9250f99020c..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NativeTokenBalance.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: NativeTokenBalance - -The balance of a native token diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NativeTokenOptions.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NativeTokenOptions.md deleted file mode 100644 index 585103ec169..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NativeTokenOptions.md +++ /dev/null @@ -1,35 +0,0 @@ -# Interface: NativeTokenOptions - -Native token options for minting - -## Table of contents - -### Properties - -- [circulatingSupply](NativeTokenOptions.md#circulatingsupply) -- [maximumSupply](NativeTokenOptions.md#maximumsupply) -- [foundryMetadata](NativeTokenOptions.md#foundrymetadata) - -## Properties - -### circulatingSupply - -• **circulatingSupply**: `string` - -Hex encoded number - ---- - -### maximumSupply - -• **maximumSupply**: `string` - -Hex encoded number - ---- - -### foundryMetadata - -• `Optional` **foundryMetadata**: `string` - -Hex encoded bytes diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NetworkInfo.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NetworkInfo.md deleted file mode 100644 index c8e66d341d1..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NetworkInfo.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: NetworkInfo - -Information about the network and client diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NftOptions.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NftOptions.md deleted file mode 100644 index aa2bd99ce3b..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NftOptions.md +++ /dev/null @@ -1,63 +0,0 @@ -# Interface: NftOptions - -Nft options for minting - -## Table of contents - -### Properties - -- [address](NftOptions.md#address) -- [sender](NftOptions.md#sender) -- [metadata](NftOptions.md#metadata) -- [tag](NftOptions.md#tag) -- [issuer](NftOptions.md#issuer) -- [immutableMetadata](NftOptions.md#immutablemetadata) - -## Properties - -### address - -• `Optional` **address**: `string` - -Bech32 encoded address to which the Nft will be minted. Default will use the -first address of the account - ---- - -### sender - -• `Optional` **sender**: `string` - -Bech32 encoded sender address \* - ---- - -### metadata - -• `Optional` **metadata**: `string` - -Hex encoded bytes - ---- - -### tag - -• `Optional` **tag**: `string` - -Hex encoded bytes - ---- - -### issuer - -• `Optional` **issuer**: `string` - -Bech32 encoded issuer address \* - ---- - -### immutableMetadata - -• `Optional` **immutableMetadata**: `string` - -Hex encoded bytes diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NftSyncOptions.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NftSyncOptions.md deleted file mode 100644 index bb6be26b72d..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NftSyncOptions.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: NftSyncOptions - -Specifies what outputs should be synced for the address of an nft output. diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NodeInfoWrapper.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NodeInfoWrapper.md deleted file mode 100644 index c1c5ad19b22..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/NodeInfoWrapper.md +++ /dev/null @@ -1,26 +0,0 @@ -# Interface: NodeInfoWrapper - -NodeInfo wrapper which contains the node info and the url from the node (useful when multiple nodes are used) - -## Table of contents - -### Properties - -- [nodeInfo](NodeInfoWrapper.md#nodeinfo) -- [url](NodeInfoWrapper.md#url) - -## Properties - -### nodeInfo - -• **nodeInfo**: `INodeInfo` - -The returned node info - ---- - -### url - -• **url**: `string` - -The url from the node which returned the node info diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/OutputData.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/OutputData.md deleted file mode 100644 index 52eb4bbba0c..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/OutputData.md +++ /dev/null @@ -1,80 +0,0 @@ -# Interface: OutputData - -An output with metadata - -## Table of contents - -### Properties - -- [outputId](OutputData.md#outputid) -- [metadata](OutputData.md#metadata) -- [output](OutputData.md#output) -- [isSpent](OutputData.md#isspent) -- [address](OutputData.md#address) -- [networkId](OutputData.md#networkid) -- [remainder](OutputData.md#remainder) -- [chain](OutputData.md#chain) - -## Properties - -### outputId - -• **outputId**: `string` - -The identifier of an Output - ---- - -### metadata - -• **metadata**: `IOutputMetadataResponse` - -The metadata of the output - ---- - -### output - -• **output**: `OutputTypes` - -The actual Output - ---- - -### isSpent - -• **isSpent**: `boolean` - -If an output is spent - ---- - -### address - -• **address**: `AddressTypes` - -Associated account address - ---- - -### networkId - -• **networkId**: `string` - -Network ID - ---- - -### remainder - -• **remainder**: `boolean` - -Remainder - ---- - -### chain - -• `Optional` **chain**: [`Segment`](Segment.md)[] - -BIP32 path diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/OutputOptions.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/OutputOptions.md deleted file mode 100644 index dfe2183e0c6..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/OutputOptions.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: OutputOptions - -Options for the creation of an output diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/PreparedTransactionData.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/PreparedTransactionData.md deleted file mode 100644 index 23692020351..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/PreparedTransactionData.md +++ /dev/null @@ -1,35 +0,0 @@ -# Interface: PreparedTransactionData - -Prepared transaction data, useful for offline signing. - -## Table of contents - -### Properties - -- [essence](PreparedTransactionData.md#essence) -- [inputsData](PreparedTransactionData.md#inputsdata) -- [remainder](PreparedTransactionData.md#remainder) - -## Properties - -### essence - -• **essence**: `ITransactionEssence` - -Transaction essence - ---- - -### inputsData - -• **inputsData**: [`InputSigningData`](InputSigningData.md)[] - -Required address information for signing - ---- - -### remainder - -• `Optional` **remainder**: [`RemainderData`](RemainderData.md) - -Optional remainder output information diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/RemainderData.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/RemainderData.md deleted file mode 100644 index a3d70a48f52..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/RemainderData.md +++ /dev/null @@ -1,35 +0,0 @@ -# Interface: RemainderData - -Data for a remainder output, used for ledger nano - -## Table of contents - -### Properties - -- [output](RemainderData.md#output) -- [chain](RemainderData.md#chain) -- [address](RemainderData.md#address) - -## Properties - -### output - -• **output**: `OutputTypes` - -The remainder output - ---- - -### chain - -• `Optional` **chain**: [`Segment`](Segment.md)[] - -The chain derived from seed, for the remainder addresses - ---- - -### address - -• **address**: `AddressTypes` - -The remainder address diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/RequiredStorageDeposit.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/RequiredStorageDeposit.md deleted file mode 100644 index dcbb88106fa..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/RequiredStorageDeposit.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: RequiredStorageDeposit - -The required storage deposit per output type diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/SeedSecretManager.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/SeedSecretManager.md deleted file mode 100644 index 71fc7707a41..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/SeedSecretManager.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: SeedSecretManager - -Secret manager that uses a seed. diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Segment.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Segment.md deleted file mode 100644 index 7679cb1cae2..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Segment.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: Segment - -A Segment of the BIP32 path diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/SignedTransactionEssence.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/SignedTransactionEssence.md deleted file mode 100644 index 0237352ca20..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/SignedTransactionEssence.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: SignedTransactionEssence - -The signed transaction with inputs data diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/StorageDeposit.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/StorageDeposit.md deleted file mode 100644 index 98936a049ab..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/StorageDeposit.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: StorageDeposit - -Storage deposit strategy to be used for the output diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/StrongholdSecretManager.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/StrongholdSecretManager.md deleted file mode 100644 index d3e361b1b0c..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/StrongholdSecretManager.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: StrongholdSecretManager - -Secret manager that uses Stronghold. diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/SyncOptions.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/SyncOptions.md deleted file mode 100644 index 3ae8f8daf00..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/SyncOptions.md +++ /dev/null @@ -1,103 +0,0 @@ -# Interface: SyncOptions - -Sync options for an account - -## Table of contents - -### Properties - -- [addresses](SyncOptions.md#addresses) -- [addressStartIndex](SyncOptions.md#addressstartindex) -- [addressStartIndexInternal](SyncOptions.md#addressstartindexinternal) -- [forceSyncing](SyncOptions.md#forcesyncing) -- [syncPendingTransactions](SyncOptions.md#syncpendingtransactions) -- [account](SyncOptions.md#account) -- [alias](SyncOptions.md#alias) -- [nft](SyncOptions.md#nft) -- [syncOnlyMostBasicOutputs](SyncOptions.md#synconlymostbasicoutputs) -- [syncNativeTokenFoundries](SyncOptions.md#syncnativetokenfoundries) - -## Properties - -### addresses - -• `Optional` **addresses**: `string`[] - -Specific Bech32 encoded addresses of the account to sync, if addresses are provided, -then `address_start_index` will be ignored - ---- - -### addressStartIndex - -• `Optional` **addressStartIndex**: `number` - -Address index from which to start syncing addresses. 0 by default, using a higher index will be faster because -addresses with a lower index will be skipped, but could result in a wrong balance for that reason - ---- - -### addressStartIndexInternal - -• `Optional` **addressStartIndexInternal**: `number` - -Address index from which to start syncing internal addresses. 0 by default, using a higher index will be faster -because addresses with a lower index will be skipped, but could result in a wrong balance for that reason - ---- - -### forceSyncing - -• `Optional` **forceSyncing**: `boolean` - -Usually syncing is skipped if it's called in between 200ms, because there can only be new changes every -milestone and calling it twice "at the same time" will not return new data -When this to true, we will sync anyways, even if it's called 0ms after the las sync finished. Default: false. - ---- - -### syncPendingTransactions - -• `Optional` **syncPendingTransactions**: `boolean` - -Checks pending transactions and promotes/reattaches them if necessary. Default: true. - ---- - -### account - -• `Optional` **account**: [`AccountSyncOptions`](AccountSyncOptions.md) - -Specifies what outputs should be synced for the ed25519 addresses from the account. - ---- - -### alias - -• `Optional` **alias**: [`AliasSyncOptions`](AliasSyncOptions.md) - -Specifies what outputs should be synced for the address of an alias output. - ---- - -### nft - -• `Optional` **nft**: [`NftSyncOptions`](NftSyncOptions.md) - -Specifies what outputs should be synced for the address of an nft output. - ---- - -### syncOnlyMostBasicOutputs - -• `Optional` **syncOnlyMostBasicOutputs**: `boolean` - -Specifies if only basic outputs with an AddressUnlockCondition alone should be synced, will overwrite `account`, `alias` and `nft` options. Default: false. - ---- - -### syncNativeTokenFoundries - -• `Optional` **syncNativeTokenFoundries**: `boolean` - -Sync native token foundries, so their metadata can be returned in the balance. Default: false. diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Transaction.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Transaction.md deleted file mode 100644 index 2a76cb78f9f..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Transaction.md +++ /dev/null @@ -1,80 +0,0 @@ -# Interface: Transaction - -A Transaction with metadata - -## Table of contents - -### Properties - -- [payload](Transaction.md#payload) -- [blockId](Transaction.md#blockid) -- [inclusionState](Transaction.md#inclusionstate) -- [timestamp](Transaction.md#timestamp) -- [transactionId](Transaction.md#transactionid) -- [networkId](Transaction.md#networkid) -- [incoming](Transaction.md#incoming) -- [note](Transaction.md#note) - -## Properties - -### payload - -• **payload**: `ITransactionPayload` - -The transaction payload - ---- - -### blockId - -• `Optional` **blockId**: `string` - -The block id in which the transaction payload was included - ---- - -### inclusionState - -• **inclusionState**: [`InclusionState`](../enums/InclusionState.md) - -The inclusion state of the transaction - ---- - -### timestamp - -• **timestamp**: `string` - -The creation time - ---- - -### transactionId - -• **transactionId**: `string` - -The transaction id - ---- - -### networkId - -• **networkId**: `string` - -The network id in which the transaction was sent - ---- - -### incoming - -• **incoming**: `boolean` - -If the transaction was created by the wallet or someone else - ---- - -### note - -• `Optional` **note**: `string` - -Note that can be set when sending a transaction and is only stored locally diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/TransactionOptions.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/TransactionOptions.md deleted file mode 100644 index ba24704a43e..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/TransactionOptions.md +++ /dev/null @@ -1,26 +0,0 @@ -# Interface: TransactionOptions - -Options for the transaction creation - -## Table of contents - -### Properties - -- [customInputs](TransactionOptions.md#custominputs) -- [note](TransactionOptions.md#note) - -## Properties - -### customInputs - -• `Optional` **customInputs**: `string`[] - -Custom inputs that should be used for the transaction - ---- - -### note - -• `Optional` **note**: `string` - -Optional note, that is only stored locally diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Unlocks.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Unlocks.md deleted file mode 100644 index 4f613fbbd1a..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/nodejs/interfaces/Unlocks.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: Unlocks - -Time unlocks to include in the output diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/python/iota_wallet/account.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/python/iota_wallet/account.md deleted file mode 100644 index 614dc5b4836..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/python/iota_wallet/account.md +++ /dev/null @@ -1,358 +0,0 @@ ---- -sidebar_label: account -title: iota_wallet.account ---- - -## Account Objects - -```python -class Account() -``` - -### build_alias_output - -```python -def build_alias_output(amount, native_tokens, alias_id, state_index, - state_metadata, foundry_counter, unlock_conditions, - features, immutable_features) -``` - -Build alias output. - -### build_basic_output - -```python -def build_basic_output(amount, native_tokens, unlock_conditions, features) -``` - -Build basic output. - -### build_foundry_output - -```python -def build_foundry_output(amount, native_tokens, serial_number, token_scheme, - unlock_conditions, features, immutable_features) -``` - -Build foundry output. - -### build_nft_output - -```python -def build_nft_output(amount, native_tokens, nft_id, unlock_conditions, - features, immutable_features) -``` - -BuildNftOutput. - -### burn_native_token - -```python -def burn_native_token(token_id, burn_amount, options=None) -``` - -Burn native tokens. This doesn't require the foundry output which minted them, but will not increase -the foundries `melted_tokens` field, which makes it impossible to destroy the foundry output. Therefore it's -recommended to use melting, if the foundry output is available. - -### burn_nft - -```python -def burn_nft(nft_id, options=None) -``` - -Burn an nft output. Outputs controlled by it will be swept before if they don't have a storage -deposit return, timelock or _expiration unlock_ condition. This should be preferred over burning, because after -burning, the foundry can never be destroyed anymore. - -### consolidate_outputs - -```python -def consolidate_outputs(force, output_consolidation_threshold) -``` - -Consolidate outputs. - -### create_alias_output - -```python -def create_alias_output(alias_output_options, options) -``` - -Create an alias output. - -### destroy_alias - -```python -def destroy_alias(alias_id, options=None) -``` - -Destroy an alias output. Outputs controlled by it will be swept before if they don't have a -storage deposit return, timelock or expiration unlock condition. The amount and possible native tokens will be -sent to the governor address. - -### destroy_foundry - -```python -def destroy_foundry(foundry_id, options=None) -``` - -Destroy a foundry output with a circulating supply of 0. -Native tokens in the foundry (minted by other foundries) will be transacted to the controlling alias - -### generate_addresses - -```python -def generate_addresses(amount, options=None) -``` - -Generate new addresses. - -### get_outputs_with_additional_unlock_conditions - -```python -def get_outputs_with_additional_unlock_conditions(outputs_to_claim) -``` - -Get outputs with additional unlock conditions. - -### get_output - -```python -def get_output(output_id) -``` - -Get output. - -### get_transaction - -```python -def get_transaction(transaction_id) -``` - -Get transaction. - -### addresses - -```python -def addresses() -``` - -List addresses. - -### addresses_with_unspent_outputs - -```python -def addresses_with_unspent_outputs() -``` - -Returns only addresses of the account with unspent outputs. - -### outputs - -```python -def outputs(filter_options=None) -``` - -Returns all outputs of the account. - -### unspent_outputs - -```python -def unspent_outputs(filter_options=None) -``` - -Returns all unspent outputs of the account. - -### incoming_transactions - -```python -def incoming_transactions() -``` - -Returns all incoming transactions of the account. - -### transactions - -```python -def transactions() -``` - -Returns all transaction of the account. - -### pending_transactions - -```python -def pending_transactions() -``` - -Returns all pending transactions of the account. - -### decrease_native_token_supply - -```python -def decrease_native_token_supply(token_id, melt_amount, options=None) -``` - -Melt native tokens. This happens with the foundry output which minted them, by increasing it's -`melted_tokens` field. - -### increase_native_token_supply - -```python -def increase_native_token_supply(token_id, - mint_amount, - increase_native_token_supply_options=None, - options=None) -``` - -Mint more native token. - -### mint_native_token - -```python -def mint_native_token(native_token_options, options=None) -``` - -Mint native token. - -### minimum_required_storage_deposit - -```python -def minimum_required_storage_deposit(output) -``` - -Minimum required storage deposit. - -### mint_nfts - -```python -def mint_nfts(nfts_options, options=None) -``` - -Mint nfts. - -### get_balance - -```python -def get_balance() -``` - -Get account balance information. - -### prepare_send_amount - -```python -def prepare_send_amount(addresses_with_amount, options=None) -``` - -Prepare send amount. - -### prepare_transaction - -```python -def prepare_transaction(outputs, options=None) -``` - -Prepare transaction. - -### retry_transaction_until_included - -```python -def retry_transaction_until_included(transaction_id, - interval=None, - max_attempts=None) -``` - -Retries (promotes or reattaches) a transaction sent from the account for a provided transaction id until it's -included (referenced by a milestone). Returns the included block id. - -### sync - -```python -def sync(options=None) -``` - -Sync the account by fetching new information from the nodes. -Will also retry pending transactions and consolidate outputs if necessary. - -### send_amount - -```python -def send_amount(addresses_with_amount, options=None) -``` - -Send amount. - -### send_micro_transaction - -```python -def send_micro_transaction(addresses_with_micro_amount, options=None) -``` - -Send micro transaction. - -### send_native_tokens - -```python -def send_native_tokens(addresses_native_tokens, options=None) -``` - -Send native tokens. - -### send_nft - -```python -def send_nft(addresses_nft_ids, options=None) -``` - -Send nft. - -### set_alias - -```python -def set_alias(alias) -``` - -Set alias. - -### sign_transaction_essence - -```python -def sign_transaction_essence(prepared_transaction_data) -``` - -Sign a transaction essence. - -### submit_and_store_transaction - -```python -def submit_and_store_transaction(signed_transaction_data) -``` - -Submit and store transaction. - -### claim_outputs - -```python -def claim_outputs(output_ids_to_claim) -``` - -Claim outputs. - -### send_outputs - -```python -@send_message_routine -def send_outputs(outputs, options=None) -``` - -Send outputs in a transaction. - -### request_funds_from_faucet - -```python -def request_funds_from_faucet(url=None, address=None) -``` - -Requests funds from the faucet diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/python/iota_wallet/common.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/python/iota_wallet/common.md deleted file mode 100644 index 864e8de8cb7..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/python/iota_wallet/common.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -sidebar_label: common -title: iota_wallet.common ---- - -### send_message_routine - -```python -def send_message_routine(func) -``` - -The routine of dump json string and call send_message() - -## IotaWalletError Objects - -```python -class IotaWalletError(Exception) -``` - -iota-wallet error diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/python/iota_wallet/secret_manager.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/python/iota_wallet/secret_manager.md deleted file mode 100644 index 178108d5ee6..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/python/iota_wallet/secret_manager.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -sidebar_label: secret_manager -title: iota_wallet.secret_manager ---- - -## LedgerNanoSecretManager Objects - -```python -class LedgerNanoSecretManager(dict) -``` - -### \_\_init\_\_ - -```python -def __init__(is_simulator) -``` - -Initialize a ledger nano secret manager. - -## MnemonicSecretManager Objects - -```python -class MnemonicSecretManager(dict) -``` - -### \_\_init\_\_ - -```python -def __init__(mnemonic) -``` - -Initialize a mnemonic secret manager. - -## SeedSecretManager Objects - -```python -class SeedSecretManager(dict) -``` - -### \_\_init\_\_ - -```python -def __init__(seed) -``` - -Initialize a seed secret manager. - -## StrongholdSecretManager Objects - -```python -class StrongholdSecretManager(dict) -``` - -### \_\_init\_\_ - -```python -def __init__(snapshot_path, password) -``` - -Initialize a stronghold secret manager. diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/python/iota_wallet/wallet.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/python/iota_wallet/wallet.md deleted file mode 100644 index 808b3aa16cd..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/python/iota_wallet/wallet.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -sidebar_label: wallet -title: iota_wallet.wallet ---- - -## IotaWallet Objects - -```python -class IotaWallet() -``` - -### \_\_init\_\_ - -```python -def __init__(storage_path='./walletdb', - client_options=None, - coin_type=None, - secret_manager=None) -``` - -Initialize the IOTA Wallet. - -### create_account - -```python -def create_account(alias=None, bech32_hrp=None) -``` - -Create a new account - -### get_account - -```python -def get_account(account_id) -``` - -Get the account instance - -### get_account_data - -```python -def get_account_data(account_id) -``` - -Get account data - -### get_accounts - -```python -def get_accounts() -``` - -Get accounts - -### backup - -```python -def backup(destination, password) -``` - -Backup storage. - -### bech32_to_hex - -```python -def bech32_to_hex(bech32_address) -``` - -Transforms a bech32 encoded address to hex - -### change_stronghold_password - -```python -def change_stronghold_password(password) -``` - -Change stronghold password. - -### clear_stronghold_password - -```python -def clear_stronghold_password() -``` - -Clear stronghold password. - -### is_stronghold_password_available - -```python -def is_stronghold_password_available() -``` - -Is stronghold password available. - -### recover_accounts - -```python -def recover_accounts(account_start_index, account_gap_limit, address_gap_limit, - sync_options) -``` - -Recover accounts. - -### remove_latest_account - -```python -def remove_latest_account() -``` - -Remove latest account. - -### restore_backup - -```python -def restore_backup(source, password) -``` - -Restore a backup from a Stronghold file -Replaces client_options, coin_type, secret_manager and accounts. Returns an error if accounts were already created -If Stronghold is used as secret_manager, the existing Stronghold file will be overwritten. If a mnemonic was -stored, it will be gone. - -### generate_mnemonic - -```python -def generate_mnemonic() -``` - -Generates a new mnemonic. - -### verify_mnemonic - -```python -def verify_mnemonic(mnemonic) -``` - -Checks if the given mnemonic is valid. - -### set_client_options - -```python -def set_client_options(client_options) -``` - -Updates the client options for all accounts. - -### generate_address - -```python -def generate_address(account_index, - internal, - address_index, - options=None, - bech32_hrp=None) -``` - -Generate an address without storing it. - -### get_node_info - -```python -def get_node_info(url, auth) -``` - -Get node info. - -### set_stronghold_password - -```python -def set_stronghold_password(password) -``` - -Set stronghold password. - -### set_stronghold_password_clear_interval - -```python -def set_stronghold_password_clear_interval(interval_in_milliseconds) -``` - -Set stronghold password clear interval. - -### store_mnemonic - -```python -def store_mnemonic(mnemonic) -``` - -Store mnemonic. - -### start_background_sync - -```python -def start_background_sync(options, interval_in_milliseconds) -``` - -Start background sync. - -### stop_background_sync - -```python -def stop_background_sync() -``` - -Stop background syncing. - -### listen - -```python -def listen(handler, events=None) -``` - -Listen to wallet events, empty array or None will listen to all events -The default value for events is None - -### clear_listeners - -```python -def clear_listeners(events=None) -``` - -Remove wallet event listeners, empty array or None will remove all listeners -The default value for events is None diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/python/sidebar.json b/docs/build/wallet.rs/1.0-rc.6/docs/references/python/sidebar.json deleted file mode 100644 index 6a9c4d2ed32..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/python/sidebar.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "items": [], - "label": "Reference", - "type": "category" -} diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/references/rust_api_reference.md b/docs/build/wallet.rs/1.0-rc.6/docs/references/rust_api_reference.md deleted file mode 100644 index 2b2ecfe860d..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/references/rust_api_reference.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -description: Official IOTA Wallet Library Software Rust API reference. -image: /img/logo/wallet_light.png -keywords: - - api - - rust - - cargo - - crate ---- - -# API Reference - -You can visit the [Rust documentation](https://wallet-lib.docs.iota.org/docs/specification) to learn more about the API Reference. - -If you would like to explore the implementation in more depth, you can generate docs for the whole crate by running the following command: - -``` -cargo doc --document-private-items --no-deps --open -``` diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/troubleshooting.md b/docs/build/wallet.rs/1.0-rc.6/docs/troubleshooting.md deleted file mode 100644 index 0aa7fcb2af1..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/troubleshooting.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -description: Troubleshooting the IOTA Wallet Library. -image: /img/logo/wallet_light.png -keywords: - - discussion - - channel - - problem - - solution - - discord - - stackexchange ---- - -# Troubleshooting - -## StackExchange - -The [IOTA StackExchange](https://iota.stackexchange.com/) a nice tool for developers to find answers for a problem. You can simply search for your problem and find a solution. - -If there is not a solution at the moment, you can submit your question and share it on the #clients-discussion channel on [Discord](https://discord.iota.org). - -## Joining The Discussion - -If you want to get involved in discussions about this library, or you are looking for support, you can visit the #clients-discussion channel on [Discord](https://discord.iota.org). diff --git a/docs/build/wallet.rs/1.0-rc.6/docs/welcome.md b/docs/build/wallet.rs/1.0-rc.6/docs/welcome.md deleted file mode 100644 index a028327b091..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/docs/welcome.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -description: Official IOTA Wallet Library Software which can be used to easily integrate an IOTA Wallet into your application -image: /img/logo/wallet_light.png -keywords: - - requirements - - wallet - - software - - library - - rust - - python - - nodejs - - java ---- - -# Welcome - -This is the documentation for the official IOTA Wallet Library Software. The documentation can be used to easily integrate an IOTA Wallet into your applications. You can read more about core principles behind IOTA client libraries in the following [blog post](https://blog.iota.org/the-new-iota-client-libraries-harder-better-faster-stronger/). - -`wallet.rs` is a general wallet library written in Rust. It is being utilized by our wallet software `Firefly` and other software components across IOTA ecosystem. `wallet.rs` contains all the logic to safely build wallets or integrations that require value-based transfers (such as exchanges, pay-as-you-go systems, etc.). `wallet.rs` includes account state management and backup, account creation, transferring tokens and much more. Needless to say, it is also based on our official _one-source-code-of-truth_ [IOTA Rust library](https://github.com/iotaledger/wallet.rs) and can be integrated with the [Stronghold enclave](https://blog.iota.org/iota-stronghold-6ce55d311d7c/) to achieve a maximum level of security. - -:::caution -Use Stronghold for secrets management. It integrates the best security practices and is open-source. -::: - -`Stronghold` can store the encrypted seed at rest. It is not possible to extract the seed from `Stronghold` for security purposes. `Stronghold` uses encrypted snapshots that can easily be backed up and securely shared between devices. These snapshots are further secured with a password. - -## Testnet - -To join the public testnet checkout this [blog post](https://blog.shimmer.network/shimmer-beta-network-is-live). More information about Stardust components is available in the [tips repository](https://github.com/iotaledger/tips/pulls). - -## Joining the Discussion - -If you want to get involved in discussions about this library, or you're looking for support, go to the #wallet-library channel on [Discord](https://discord.iota.org). diff --git a/docs/build/wallet.rs/1.0-rc.6/sidebars.js b/docs/build/wallet.rs/1.0-rc.6/sidebars.js deleted file mode 100644 index 659b7376d2b..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/sidebars.js +++ /dev/null @@ -1,189 +0,0 @@ -/** - * * Creating a sidebar enables you to: - - create an ordered group of docs - - render a sidebar for each doc of that group - - provide next/previous navigation - - The sidebars can be generated from the filesystem, or explicitly defined here. - - Create as many sidebars as you want. - */ - -module.exports = { - docs: [ - { - type: 'doc', - id: 'welcome', - }, - { - type: 'category', - label: 'Overview', - items: [ - 'explanations/library_overview', - 'explanations/account_approaches', - ], - }, - { - type: 'category', - label: 'Getting Started', - - link: { - type: 'doc', - id: 'getting_started/getting_started', - }, - items: [ - { - type: 'doc', - id: 'getting_started/rust', - label: 'Rust', - }, - { - type: 'doc', - id: 'getting_started/nodejs', - label: 'Node.js', - }, - { - type: 'doc', - id: 'getting_started/java', - label: 'Java', - }, - { - type: 'doc', - id: 'getting_started/python', - label: 'Python', - }, - ], - }, - { - type: 'category', - label: 'How To', - items: [ - 'how_tos/run_how_tos', - { - type: 'category', - label: 'Accounts and Addresses', - items: [ - { - type: 'autogenerated', - dirName: 'how_tos/accounts_and_addresses', - }, - ], - }, - { - type: 'category', - label: 'Outputs and Transactions', - items: [ - { - type: 'autogenerated', - dirName: 'how_tos/outputs_and_transactions', - }, - ], - }, - { - type: 'category', - label: 'Native Tokens', - items: [ - { - type: 'autogenerated', - dirName: 'how_tos/native_tokens', - }, - ], - }, - { - type: 'category', - label: 'NFTs', - items: [ - { - type: 'autogenerated', - dirName: 'how_tos/NFT', - }, - ], - }, - 'how_tos/more_examples', - 'how_tos/exchange_guide', - 'how_tos/use-python-with-IOTA', - ], - }, - { - type: 'category', - label: 'API Reference', - items: [ - { - type: 'doc', - id: 'references/rust_api_reference', - label: 'Rust', - }, - { - type: 'category', - label: 'Node.js', - link: { - type: 'doc', - id: 'references/nodejs/api_ref', - }, - items: [ - { - type: 'category', - label: 'Classes', - items: [ - { - type: 'autogenerated', - dirName: 'references/nodejs/classes', - }, - ], - }, - { - type: 'category', - label: 'Enums', - items: [ - { - type: 'autogenerated', - dirName: 'references/nodejs/enums', - }, - ], - }, - { - type: 'category', - label: 'Interfaces', - items: [ - { - type: 'autogenerated', - dirName: 'references/nodejs/interfaces', - }, - ], - }, - ], - }, - { - type: 'category', - label: 'Java', - items: [ - { - type: 'autogenerated', - dirName: 'references/java', - }, - ], - }, - { - type: 'category', - label: 'Python', - items: [ - { - type: 'autogenerated', - dirName: 'references/python/iota_wallet', - }, - ], - }, - ], - }, - { - type: 'doc', - id: 'troubleshooting', - label: 'Troubleshooting', - }, - { - type: 'doc', - id: 'contribute', - label: 'Contribute', - }, - ], -}; diff --git a/docs/build/wallet.rs/1.0-rc.6/static/.nojekyll b/docs/build/wallet.rs/1.0-rc.6/static/.nojekyll deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/docs/build/wallet.rs/1.0-rc.6/static/img/bg-2ab9b09901d67717ad0179ee92d7a3c1.svg b/docs/build/wallet.rs/1.0-rc.6/static/img/bg-2ab9b09901d67717ad0179ee92d7a3c1.svg deleted file mode 100644 index 124ccda2ce8..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/static/img/bg-2ab9b09901d67717ad0179ee92d7a3c1.svg +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - - - diff --git a/docs/build/wallet.rs/1.0-rc.6/static/img/bg.svg b/docs/build/wallet.rs/1.0-rc.6/static/img/bg.svg deleted file mode 100644 index 124ccda2ce8..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/static/img/bg.svg +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - - - diff --git a/docs/build/wallet.rs/1.0-rc.6/static/img/iota_logo.svg b/docs/build/wallet.rs/1.0-rc.6/static/img/iota_logo.svg deleted file mode 100644 index 61151245d87..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/static/img/iota_logo.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/build/wallet.rs/1.0-rc.6/static/img/libraries.png b/docs/build/wallet.rs/1.0-rc.6/static/img/libraries.png deleted file mode 100644 index 002b405e0e6dc6c881cb21a5307a61c65f664a33..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 47013 zcmeFYRaabX6D``fy9WE5Bq-Sq;a?V{eoaCrR4ws zAYuLeKmgJ+@!xMkI4Dbs0IJ4`4&Hx2n+tyt1^{Yeke&@;0DwjwX)$3{SBT>m3y|qz z5=n5S*Lc=is){KUeH;KW$cn@7kovb4CC(W2Vjqa=tK&2!g=RgrA&f-`%`31B)E#Zh z1?l^C2xk%Uwy+7WyeVkkvquK|MFlg+C>C4XDJ32Iw=W5%kQ&9O@>+ZMH0E^=7ak9b zD37Kys>6J^Ti>>ydTSmN{N_1c<83ZpPfv48mQd`La}`>3W@G7}|Nk%lUr)l*i77<- z=O>ifj+?AAo$N6)L0pmh>FY7~1dcWyGCc`sp@$ffgB;okq1UL?#;dw}f3InZrFMuD zd~fTg3w^HN=pM?*2q&*HrOMsx_V!s#%GO2 z{V4>gDi5ivk$4h(!Mq>pBh33+kn<4m*1sNXHs&2r0U=eV-w3olK0SRkb$`_G-rbf= zd7Fj1+Z+#|Ilq4($gG@yW;D*hC4(N7G(4{+i4x9)9@_w$85wd75b&+EyV-YeXhHxfzCsHOQx^z56$IFQz$Gk6(E z;4oR&G$&V{^jL|=eUT$|J8Fiy*+UYLc=wU@Cq86u7i{VL33e!Q?6*TaJC>5j|!x1ouiwu0@Ql6-DX4$>)eq}WWp zp8+AzFzv*wY6!b_L01ixNoUTk%FpcN1tRrhbC{B( zWXinRET5RhYKpLc!^wH)7$hzPgzVLZ+`GALM|_n*A&8yV`vxa42_5(aEe5&ZWAYgT zC0@6HtS?)Npcn^#)r)SM54gU7K7I+LKY`F*G^rxH_NoV^ywy@2u*w6~@8mu;VVV4T@{ z%4dMZt=Hmui^m|BIy~r&=+`h8pG?``g>*{Ezs|&yRO+ zYou@6J}Bv*m#5y*w!HK@7qae#vvq&;wz>W?kmF%*4=VtvAvsVh&v45`SsKepi{^*j zYHKYpz>pbdFpI5Coz&m|uux?LaMO2+$6zQugVyq3BY^N|(umV1 zb##4VKYSkdDN%ELo)n(LD89{EAsyvv)iE;m59zytzq;sqT|NiG6co0`ib`f@ppW{L z;q_w2$9he|?J3bP?+frOirk6`__f^NBTc~9b~MKMQhj0Snn~n0VrYn1ZWyBQmyb__ zv0r0~>2va^Pgr_AjdtlXJ#pnKfe96$Q?`JmFQ2$LjU*VzZm@wH59>UM| zNIErT`Kbf%=M+PswAdv{U@H6}Q?f9CltNhMKL7!+Ec*r;dN~DIGP+s64DCPIcjN~d zVY3@aX@)jbro-W%ymIFu$Y&$-)$1R;=7t5N3V*!$Y-Vs#_2>a{C9!rpIUtG5?wFWObUpbJ5>BjzQ@7! zA_9KuX4M3}-Y}Og$t&>;C8#sZ5EkmVuKp#7(P{h|Xn0V2Z|j(g>_DERZFsJj^PZKk zP#0)8HK>79{P7Uk_s=*MeM}W{FOj!;`m>${a$aZ|m!^S#mS;>CKsHrv==8WnMsWag zW)XuS#nSWkJ)`&+ccOJ>U;kF3uZ#BhYtQ|wPqU?j#%6Gb?Fm=1;YuI4Ga?g+h_#!z zm#*8DQR6Y3kWX=qyGUjbL?L6a#lym)gvMSRTJpOQ0+6{A*y>sy$dLeo?3R^&}lf{>kCkkk%^3)jIqRq(J|Pa_KDtX5dpX%e?LJ0Dfi(4`z`!!r@@J{#Gfc3t^91(a-mUl+0C=%^!{S98XDk%RB4 zW8-=Xy32c-lQg`GViw}e*dYu#kRQAX?Nj~W-lkU(`rKLm-VSl+C@ajq5@^iwf34Et zyBi|@Huc4pyKjqp3s&%P;&qez+`!>;3Hrr|i^{^s6CDAOsW<*y<>Pc?TIn6;B_JO1 zVGI8!hDIa+!8p1~#_m%r0Ajki4r(IJjE*B71f6I9l=>8JL?0AzH(zv&3mDfW#kE&; zBNTt(`PzBFyAG*SN#3Wya>rYEG&awJ3>7d;^|u&V0;a4!IYbdn7N8wR8nFx^CTvSO ziP5Zkqvem{4E?~0fcV81*y>{+Og(G~y{6*+iigJtV$9hg#xv@i<*eZjTgg6N?P9Zw)cIk$kY zg^RD*l~h3Q=WNpVbNqoKlx}S*+8c=}pf68^CIwn(Y!Y?9jp*!%1zRIJaCEi?$my>{MM`L!G3 zS^3HXq#TVbfhOoQ`tfCGX83k!P9eKQKxWHdr4>Jb1};#n_|RjqV)3r_Z>3``uio(s z{s>>ut`LsoPEX%8bh%Gwa6(b%sK!@KMdES@Z&A^@$t8Ph&~v-xM$QCepQ7K$R<#{`xHl#t^BtAu;Kh^laFah9 zD(#tQ`m_5jBc*hCtFzQu(QSCbqg5Z@I+fi=*&bAwdiuu58V2dS~%kO5OFAu5gC~9XWW-87>GUTRfCdS5yQfEpxVYVvl3yv9MYZmKRLAH zhMm)2(#f2lP9nm97b8|O&Db@H^!tL@JrNVs)>Z0GHJ1FD9<7&oowkH4Sy+iL#-bb z1D2d-{*=2)acVFA3ikmmw?SU2i6lv_O_hr3grWS@8|V6Gc>vWQrDO(bKji`Cd^`CA znZcsp@$m~?GT7IXsX{m(nkuCL{V><7ep?3glP3}^JWe=#$CSyd4~g`fCM*x23XFmL z0ZOb54AjzPDsda9&-lFD|CiGY2jlbq$Spt517C?4k*8W}2dSoUwl;l%!1v^RG#q zB5jRLT5!WSYLY>a?^l$Ops~)yjf#X3__;&NT)|QVL=O!9``2-y-n(fHWcO%+_60?v zz@%ktNvbOZWDYVVxZ*4?BibPxqmf(RZI#ZFOO|Jd^!IJfEzp`Y!WooZsn-u|t-i6s z?h+gP^eY5XRV2KJ3;p8ppy8_#A6*7g#NyQ&C%oE%xG}Y5%legLK)uxk(|IZy`9!fs zE@HFBe%%rIUDp{3myrp&3}$9^LN{XrnR^}MU!GjaAWsOqnMfYTsa47f0I&Hwno;6%Rm~?Y4MR8@4%0uiJctJl;rc( zu`m3FkjLZ&S%v^r96O=arY30}uVYH4OrBB`H!1Ma=16S&hns}!&kbpokj`;&aF!{z zQ1-|l`(o3=!43KlYrf*56hg$;Y5ez~Dx@{vGbZf6X8{^-5pWi;H&?fUYY+WlU z_6fKN%7hw9(a(T({Hw0vBF$(m?uJ|1xG^U&%F)i_LCXV4r-|4E4NHqX0MoP9Y@|tk zR-T7+=gK6C@eD0jTmvMx(^s!2Q)iZA@~^f6$DAcTSsER*p2jhd51FFhMW?>{IY2nB zESzr4oScRt_a3Fv1a9_?E~XW$1AnQ(@am{s%|6Sp&=E7@+J!hq-c+|-dh#WMQE&Q+ z&?UkrQ`yE#6DD-Cpvx(t+ybiWjta$?)&n-~3}&!e9#2-G%X!qX3=$NF__8)IaTh*N z5GNZ0UdW7L#KzLw7SaP}tv(SN>4rnCMo{6vZhq{z%3qK~_&93v5w{O2ZSk7;o)6Z! zP?Y07wbo5J>BFp2NusKWS0fX{s$NFc3eSMb`y(9;5qBTr(9d5fmJq{Q}m z{h3vVo6k4rxzPvnF{`ZpSH8d?MNY_0^XG3q8jhy}9iDh3KHFd2$6D2mLvg+&gn5U} z8QL+6>K(6E0mn?>SY{a+!C$=-WAlNjE*4~Iwg;DX*;W04vC$_@_NdOBf-2# z%X^_!h0L zKXyu|cRP$%jSA5>+Q>67Ku}fA?tF_Eg4wuxZYK?X8whd9Lsk;)qTk8foAKazJtTd2 zu{}F$&5}=qU09imc}0Idt}8jm2v9m;ojN71(jk_nEOgx}m548;`jZOk7Xl zG{%t&M(*&oJsrxYThp@#W7y$V_@v)I80Kgurc@S7G6~cR0VP93utYGLDWOj`ual&H z>vxjg(9z?2ws!$f=lerIB4Xm6o+pKkeGO75`QkNkGXe5XYI@JCe%UKk>PY2_4Re6P zMRoN#n@eHP70T5?Rip1P#cs`K-{-Wqmp90@^_=d6n-6pBOKaju4yfCJc|lM3^_Q48 zAC5}_eS9i);mgZ0)`8(H7wE5veA7hDzOhSF$c0UDOJ5;X+Fuj*wTJn#MKTmJVs17> zA>0WxK`p`$JOx5hw4D?uX$#RK%7E%Ncc`^z{a1_oMeqP7RQI|A64NvxTT2QYG&EYr zE9$!f^uUdhkN1ZVg3r;ksdxlq*{g!NU8@f7znRC^f+Q4W@YiwDeLE@?u5hr9vna8l zHbWpumF{okc|C80*YSZnCgmIhIfxTkpMA-VgX&f|o@BINpCpOL=9k*~KE_*_Njk>r z6kh~7*3vt1$mmwr$DrPFF2d4CXgwRT*UHrx43;s?A300=47v?GKq_-%K#ut7FYgP~ zWG71h>2i(1$M~fyt-9uBPO7=a7C7O(IemU%kFd_eJ9fuL3}w4p;!Py*IM7jeSB5%I zdtF2jRwIzY`a=dAh7)p>XRN z%Iex^x;-4KMIh5>h=SUfQKH%%52i@ATuc zUAkRL8A%SaQ?6}ds`CgB`+oaN>Hk4pw%`I9)h#iyNhydEdO`Iu3)tC2Q)a4Yo~~?Z z`BlKR*6#G#GZYx}s3M`MWJ$lTOl3usaS)y=e42MFk0=JqxT*v(L0yXf2|;g?Bhf0? zc7Ip%FUY#lB&xzxT?26t{D!M*F7%XhAYBla_*IJ!uyI34EC(%R*Yu zQV<|T(7XYLB-@9ZO&@ieQ@k1CFuDY(q4O6}4{`A}1_4Yl5+j~VbR-*<7XB=i=@__YA(>nzxQ1v2IkEtds;r#k|C zRl{Us{?yGK<^8U0Y11XVBaopm|67@2dOKl23k_;^f%^tK>%8#@bm_%7YM+q08+&$U zlR&Kpq5Sw%sFwpRk#2YRZqBgiHwQJ<_;{K$KLZqG2z$RlPpf*apvHuCB!hF2>iHQ# zcA+m|22BK;ZSVd*<>{P*>YPXw!DsDqX--C zp50$eq=Im7o;v^|yu5FEOAfJAz6ic~S<#gp>uo|DjpQfu;E7jv`L~=im=k$^ZmSb zIas3N^1f|qk!&Z_f3@XMc!B6}|2-kGAU6CFGl2RmC^=}>>g&G~zoN2kd&WsMC@hjw zg;6Rg%pZ){^CQyhfJJK)b6cZ;kTD4XQyAF}r1T7n0*ze2dZqeF5o!{32bEF8ez>96 z02gg@oy`jP(h`y%ptLD1Fk8tbnYiz|F(V21d}asmt7l%yxqYpWE~#z6Gbo`Qj_9se z=&%r)vsti2)_Tm`2R7aFkt!Os-Nf0MB@J<-#?zsAq*ZU@lssAc$8B&H z_J!EDm#^yc$TyjIz2RvyWxcS-;!xgJy*yrxj+chpB*LW-CTt|iYe>n}*pWbB%J5yC zr*i`f9n+GDqp38;G^9$ISX8T-=a2Wg^51k|#lJ5mayP3L~l!3ocZ2@7>X{4EJl0BxT*1_Dd2_KOJXu?evS+lyB}-eZIZb& ze20`l#ef;)SScP^%qN|^aQUl*WN|#hj&Kx(MriWRi$u~)N9|U#1&v7mz(DMb7|n8( zNcKdU#sgEe`*0|X3Q{PpyWAz@3{Dw*-*CP`R+^3Tx7PfJya*CkwJ><=Zehg%Q{Dq3 ztPN-wjxDl~6jbqX?l=a9QZwz}o^|;Ep2W@?;Lp36<;TIqdl-ZT6ELkWIfQkN5VU*i%!*$rueN|B#LmlwfSEhT2MEF>Nb}& zfHC)Kr}OC=p$LWsDsXAK{JufZo~smd48g=DqYw}&9^(ay(KPq{BJHe|f?tl2+8mjN z#M;g0NAz(bq#%y`VX%2JC*DepsOb!{zx0S`valugHPvF{)I!4*sp6=3_&OaId?&mt zBGuzfd_q9w$ODKR=uskAA`k>tY8usxm_g+JBmlX+y>CmP|9ftg%22(nyGoB&TdVSL zwE}Ic?imHa++=)V=-~@NJ+VZ~c8F(KrLAW6t%o2uxSaThL`iI#FTX&4RP3$e=sW9~ zBtMt)J=`&9?Q%d-Iw6Fo21nj<&OEZ8SH2^kf0xI&;3&vM`)b@6}{ zUQswuWoo=$HFcaxvzR!U$JG7yoGtoSrm#}KdHeBp*|67W4?h$S-`#h!*Z+?a%eFLe zbA~;oZ>veSX`&E0y+v6dur%Alm#`ZJ=WFYyvvr@KE|MQ%4X#y?k&r3zhto?*43W67dyyBTA|k-rCL_uebr+~6&uXmwf=T!7l;|#8h_4x!0<8)X5L%? zSID8>ZGPk58SWw#hNti;ZuPef)`>AKOyOLpTUWxloVi+Wl-F&SQ zCZ}j|6Y5|xY|tSyGsK!)PFNY{EYDqqv_fPoW%Ck&(zTvE9?22$MA&0EMt0r~wHZ!% z@mGE6L0qoBKn&&!h|oUF`sSDePgohlx>aZi#Zm1LY%!N+#AEk_dK2)(=d#Nr8oKvK zSB#P0#-|BxL^a_PvudADn{Yl@PhBHLRxD-b)aO1xlpp*1BJ8hdlO~G7dJsvP zr@}3kLW-E2M^&(#xvJU-TwRWu!=oo&lq# zGg%D}Vd8-6P)Zn5ZyYj7Q4pn6~Y1H{zhei^R%Xku5bX=R{$9CtCCKkxDP_8=(j zaD+|nPFc>bSK^6&5El>K7V|D^2mBSyfZ{YIRLnk>u^Bkzlw$VCJ%LV-7B>eZ|L1lHF$_Rm@h8baA z1C~X49$IS;QhNp+V$UYm-`TvF({@6GN+=AkWoScW!4E&D*xoWu<(x#!dY`@RrXRek zUc6=AU=>{8v&D-S&3WMeC??Cq6I*%lroZ@p{X1`Hje0ZQ!{cHS4qY+i##W0QC=L~C zpc>kF>OcoxRoGRUIHU_?V@D4^~I7vW*FadD4 zr6D)I(5g)bQ<66e4w+-VqO_hkPff>JZc2a%AR}#9S|H-{6W86oCXnjkJO9odJ0sI- z35K<%fDC>jsAJBF^Bye6br3PVpnbO$Wu|Wpon>pb}0O zOV*_gD#+^bE6C}VG|o{?VwDzr6sQ} zBxV4nJmIT|$_aD589o9;iIl@`ugLPB9>w@NuWHa@LR`~sGW)-Rs7w7QYohGwmK8x! ztUtD&ik<(=i8bDx97v!FM;94n_m&D@=%iDgA+wOfvfhcrg37q_aFzLV3oQ-LL-&t- z6N|uYKYi;zQc_BMga6-HMrftg{=JLxyzA2v3oiXb!Dw_meQS^65JO80&zJFT9tT)R z#lg>79T?oDfSB*f`dti;2|prcA6RPQNv!QnXrp186x)QMC}Gl4sq$)VDHAK8S)~tw z6RwguMOAlH<_gw2?CLaY`-!L17`}r%WPLZ(93}${IZO5p?o0(S5Qk2(e8JnGfgF=h z;594Wf4y`BRZFr)38uV|5hnpIDa8PlX~ZO8QB|h9gxCO!RFN8E4t3=&aA$vx!Ecc$ z+#p)tkAV%{DR-u)yQ^gycBb~?aHFmlMlog!s1FcQa_;reD<0>e__P?EVvkYGw!=+| zkA!fX|HQXYaT9fSB*ZfzvK}zo(j@RFEX;FlTu6_yVkQP(IV?r-Phsxok5?OHO}Ovt z7@B`glz^Gl;W*pmpi61;sP3DxVfkZx zeysBAy0F!A?{b_-ksQr1b@=v$++I~k$e1$^ zIXQ3)UJOF!o8KEWnIc(I(FQeckqSE!OBH|>+Z;YYDLo_MA?!BBv=(O|fpWt*!G4NT z@%I80`YYC|HH{gDP1pOs)CQJ0%L(i8!5mz(eP zrA{ljcnU9EvLzv7jWEe)i$zN3iczR|g-W+zQtLqW==?DY{2Gg7HAdJE-h~-ZV8+7w zl`i_%V((c6dp5;HU1>0_vA_eDnSO*(utzeI6X`@JrlX{S155EfC{&G8?pM#>!OQX= z=pyK#q}$ldPRitIyQe7p@JfR)fU#Zboe>RWiM-aRxyX zxk7?$ag=lDc^CZhG{3?i&GlNHUhiw_!Bn@LIq-$EnO#kt<|69;Ew%rVHpq}2+JNY9 zRHfN-GV=hB@yM|Og?<>Q3uk-eP8HXLkAblxC3qC3cKyC;wE2kMc(r)UwiRo6S zj$a&AHo@Q!g&{VV1C+sat|xzP{6C7w(hX=iV4 z>MhM?XVxrCzGj>{HU?r$6p_*u3CkHeIVay$8{rj^SBNKv2PKS;>uYfKVs}W5lYRyr z$0tqHB#}b~uSOjCtq1L_8L&Li zJzXnBP;tAy#e+D6yCm;xQQ=ca6l|=XaeQ~ixolP)&$V#lJHGSVFSlvth_V3H$vs@- z-YO1N{q)ST4MGY1tfW|zHPF>VNW-)7G<*qcr}CBYZbOYEQ2VL2{YOLZ+h*&qI>kZ~ zqqq@_ic7EDM8YiyCK1T%|4!14f6tQ5j(J~;k98)x*hh0vbD)#y3h!d~q6mtxsBX3b zf>FIjAj91B6NTh~&DHDVkr-7Q{4n->p+sM%g&MO!kpquIWPr|ywi_!5-2*iU@t{Go- zB!`;VAvIP3z!N{o_{?kbPj(1!<6sE+-IXQ@n@Yb_U6fjmHyAk}WGqKg{&`ggLnzN{)cB*Q#l-GQMC_w{w63>%P#eE`q(#e_0 zy-JCi4~2WBC&HwJ>F@s$Zj!%Ae_S6}L08yNON}SPpYZ2i@_)O>VpBz8-WeRzxAH39 zg-ri=u1M6on=)BmfrMpB>|-v=Z%VNrctQA^U~lXMFo-tDNL^UP2-%6^0Xv;4$P}GK z7QnC&`~$%7xejt8G62VGzTIxMGLLo>vX9Ao{8C2~W(s1QxHpIl?T$>reRKo;IJ+V_ zLgZn1V~{${0k|jcpIwfmrDG|4{ofvDSu2vn&IyV8o30%7Owo@@tEP7Tmew5n&_;CQ z@!l-_zA$^gb z_7*tn4Xm)3A_p@_#i}a`+$3zSJ6=Et%Z|nb^FF+@5&ON)%UOC|=0pe8sigY~ci}`; zlu!5%`~R=PJM!2eqo_H)J@~;>3SF6N>(yW)IUtBg0W|3iuRdd2Q!(y>%7<8zvxQ<| zuSc?xf}jQ;gx&k(oLv5$oobeg!5G@qLot((MS&*}`QvM=^6%k*EKHoI`@LE+WA}12 zwQ#1Lo@qY@Ln>c!D7+r!pO{ zd{NzA2A{SMwObI9>M_j{zH`rKzWy9w$R?Vn@agTgG@`<5CJNlAK|5#z0ShIK@ws!Y z`G!_L&&MOSNo&H`szRMRYNbNm8+i8Z#lRQH9I6fhchtY_X%79EV(fER{HjFR!iqGq zJd@QFDIFdsM4qeq!i z%0p?!&s}M6??tst(kcbIb2Re&+MNW>gcZR%MbXJcXAxV8qmtqE$-LN&9sq`2#q8^G zN6?ky%?eViaW#Vb(!%d$*-gj0W{U_>&l zOM3){JZvFuIAaH-H!vm1yzn1CT`*UNo3WU-j z;_WoTH0@gmcVq5b`}Tx)+;bn$%K0HCH?oH-1~6!<9Bf|Fw>aG!1KoSTR20L4Q^Wjw z;eT{lD^$CmvItC#R>6u26&dqGYwQClQSjyte#;BLZR~{~Z{cKP@j_KjHXzVm9&WEi zMRUSfO89C2Kokbc*4$EF2_J1QEFc>*gRN!@wp8fD#aCPIyT$P=zn`eN=4M7GT*kDI z-|k@T30%1F@I=t;2QazVt`6^9E?+8ap{BP%I%>Z3fNWuTs9i^gdmxT~;@G?U?auUH zrdkp!f(C#d!VXp~JFf9xq%0PB18=U(DfLf^D(FVF!+-tkGS^Gz;N?oO9kp13l%&GC zc%VTQ63_p1FQuEaD;?q{;eHZ(BoeNL=^%M_7FO+SM)`7WT5P|PopBtF!N2st2UVGA zmu+ckxau=16a?ez`rQVMsZRUDcr*J+aahJWt4%4v}wm@oTuW&^ZqjtJIf=#9oF;mFeoudos4{aq@)L*}#>rU8{ z9wdDq1A45-!!=HGY4$2-*BV2s;-hnu>DQu1_G?=0_8N(cwo^}ZPql|=%ZPk!`}5sW zjV!bVG5|TcnE}bjO?R$3wejg9D+L%<)3SE?icDkf-6f_a@#n;i$`_tc+X&=v^yx`X zq$lQo)HHJM+l-bLx^C9*m>Fxaa)!b)!?$0|dHWYdJrf0clI;naj5Hg4d0# z>+NX>i}$W??+eZ~+!H$W8moTrUx=j zYOE>PIJoC{^FZ(g2L3nJel@Y`D3t(r&@>I2g-c8J#9HqC6zX+C&8h;AcXQyjj~!gg zV&toHE^ljK-cco6_%~qkWdY+}ydr7qiqJm|=PCbP_Y!#Xc`SFm&4SY-=z%)Wgr5Dx z2F@c*-`*oBUeK6P~EJVK!!P7sNvJa?zMBG1zP z^-3=O^K)dbwR4>kak^jaz{l@OUoBAtmgl^ArU+KL@TRupoy2vq#+e9*od+lHcK%$+ z+58swr)>#y?Xo}bMA{UKzT5wi6~uZhGJW_7;xWrk(M*k!VF8@$=g@}qpbvUs>ErXn zeM}L!qPu5)>v_|?LKzd7{HH5Ecp@e}P9`{s${`gk_lgjkmfM6|c&X0ZBm6S{L6=>r zqNyu|oH7OYL=%kw3!)fQ!V43}#QV&z59jNiPqcFd=aAktu)u>c^=!URhV)jSwiG^e zgbVS5rR3*9w^~??VS8=FD3`=D`NYshofBeJ88b9$fWls#I1gsrwAqvxZY2;iTo$P; zvVD}~&bQGSqM4}Og$m{vMXyD^t}0iI?S;jZ8Di2gODo%Q?l|Eu_dk*QWmla~7(VGO zbMj?TGI{dI_$ve&>AC-CYJXlS~p3E9CDl0Pg zeTt7?`X_6&qCo`oyw@mFakFtZdLkDnGCnKDHiN@}2@$s#+i1lx@xVk_MP)j4nTF?) zD2dg3`%l7dZD!&Tm!?UII82FZai6^%RN^Ql8@%i)ir$$_m*UgTGvbLFZBxv(S~asP zQLrf=Z;aziQElL${ddO(s=MESmclWMl**Eg90 z?=cNap0wDiUStE&2veWDw?bds%=p# zxyUWFYI%9SAr#m$%1>06Dw%|G3w=NpXRNdFjYK8!6p$C|tPR+|CCy zy*qF|qzeYYiX`_I`gstPO%h4rdNm3^~Kdu~*3|=M8FSWtB?}$Y1w=OJuy6`s*b63&1;5 zZB`#nz;%eQ180r(@K%}s{1sp(4PL{Rjm ztg>T_2+6%P=$Ul8qpZCm(LHi+>+Q&>^O6$5nwSk7dH0H^6xqA5sf)_lP%&j^Yu#pUPw!Fv=k)xb$dOWDA)we| zXAXZW@-hhutV3%@vHPXkJWS-A_pwOW{Y3MKR#F;r+|66isE3UrnFPpRXPvfOnE9^k z{eV}!ExvpfD7#z{;^+Fhv_QnFs5-wxWNN%#uV5GL&}od9yaX(Y&KYFqp(*V>kvBC${gxb zn#T&HdOH;&-t3ZJo2^NCJ2qU=7Qpki5K_B$mshPSkjb$*DWgWyPbp^_$55Lh=TcMZ zlLKEqO?M~; zC|w$6QDnvaLmp2mpL*>DRPvE8wF%ojdy2&4(#o2y>MJYFvAMm{>WSo(G$?b$F>|tJ zm@>XUB_4k9C2J{jNdgb2gTE76U9SjNL!-fU)I#C;i}rboIKAeVyJbvLgoR~hQ3Aq& zNixzqbX`R|4<8%S_Wx%cQ7~te{H=NLNWGs?9H0FoT~<<)tGf`cD|man=S&f`Z>&Xo znqE`fj>&Sl=QCKj1T(g?*}2w%X-(l9ru{sUqo-ZP$E2=E3fB=+fAb|t8F*o zXXPpXi6;;^RUnW^Ck5NgFrv)NzRqlY`JcadyD!z~`g`LkUys{R>3J`==JEKlGms`- zN^Y}svpd%wfqgfWB)(A&OTxf`U5_jg-%Ix&l+Em#eM;|!{L+v* z|1i%+Ga@MX>D}x)GRq^|-o}|$MCrIlgnA%zv7Kp?X@yJ()q?4W%uuMAzliHu5H9j5hz$73ktwe7qtOYT8SO zv`yNO-F9lUs}P?)OO5$|*QVp1&b4mL*Yy4Xx+iJ4cAf@>S;709SmL^ptflfTyB@bE zAWTLXiFM8tkrchf2%rLKS7SBH0|jzT<4v{`x|tDv_InWMpc^9(a#9gQQhJJ@Dwhu( zQd=3(5E5m%2AvnN^v8|tfMVnhS4QGvWe`Uk=>OVb_sIOJ+L~SqVz?n>O&P>G5izGU zHT0Sjf`%p^^lnt43Kb^>!y&k2T+ElXJeAU#uTd;UQnAR6C zZ5QjmXA1p0@!ddcZ_C)`0r3$WRBQA@riCkTOj8mC8;>PtY(6M5DLVkKLbYM@G8qHA z@)(maoc;f9sJGC8C28s9V^~vpq1t%38<{$)?H=O~k5?b$>Zv@A59eo_9&wG03{E8*h)l^X(M=C)p5Q}T*%>A2gEx5M_Vf!@nY znc(56x=C!KBlCgE&h+qriA&-OTSf)Rt^F!U~G`n6W-Sk{PQ)S@vc=~KKq@J+nQK*`B z2z`_c_&Z@;6EU@0*s*6P@g`+1er{#&=c@p_9RBxGg}DU^<&AdjGsnW#Pjq{RLVV+L zb9%H90%a1eF2%>+M1tr2xhkCxDsMf4u$-?uqygLzz2l(Z)!7fITY!+G&qUKlJ#Y$u zw;Ug=_NTRw^L)(zL(@5U*VTPrKelZ8k0o7|+aZquZ(d1ISxY}>Ze*tTuw&C}oa z9pn4~dz`(`8EdUMKXX&>6}?JPevI@CKoCu*6M&U?Roh;|csgIOha`|8;DUfk{#KEW zumsV64d>ciD*1_bL(}Yav~NecCj0@ne#s0CE5;6DI-hp9v;Sn7GbD%A-nnPao(U9M z)I|ka6ns@%fAm>_1c5)Pbu_|vwC}91GlepjjI=FubNjDxOWi1|j|w*3E+42L3$v=k zxLqZc>oP!0XuV?aAH6wz-T^w17?@r|%S$mO>YBLwQ{Ekx{oCIRr?K)}C6jhoH<*Af zV5tu{VKL$7*y2mnXJ7>nXE(P@r&%XC|H#+yPmjvD`WGpB-IN6e*vlTz8sU};N}OZf z9==Q~@#K$#(WnCniD_WZx-vvG5mRF<7ndL@%%O|<@BStUMZB|(ni8(RY9o9f?{v1in@M&xf+A?pN{GNW1o9zQEG+L;bqz1UK@zmps9&2) z(qMD)*Hb@DcmkG4pUUXInARmy#&$VV-bzwrN#l{lm%%pPzYC)oK;uoz8VPhnkf2q= zFE%zrOBy*T)!Qx4uIBUaQW}Cy=WH2&0a2N#YxcQb(viB z948R=zp-Jt5hIEY?_HzUw&jm#)_$Jqe;)F$jh9^OrQRN=9 zKV){$BWQ)nNJRXHq9XMjy0rBOdUS+xc*TTV6oC)Iw{;(fhA;vmj*u;C$Sa z38$>;^mC6PmrsxCe^Tkn?=kgzTnspP&|XOU&<}=^mV$0RD`ohxQ)A~Q#LN%WcOkru zCYo`}t97A}2^FLF_u$LJ&PVN(OeQj8=GBxgf3+_GoPQ25&ph9$;V5BIsvc^IX8+Pu zeNbll=K5TR6IMqtr5kOHg*P&&yw86;Z}?`4c)_@wlfF>fnEnA*lyiQ0?R*gN^Ld*4 zXdNdPTMPj=dTxyPo+sLN z8~;}qk(RdDh>ev(@Vh2hPraGm`!6Bdj90rJO|-$kDJ1`zVz6(kTn|WJ=mgXH?*m?V zpYRDy8J0Ddr?t^Ss?|^v_0CK`s?(x|4-c$__#7!yD@wxyj(L@iGQ*psrVM;urt2AP z50MR{*btESq9us+M2BQCq#?+Q;2`lie9XqAy!Zd*4s@z z3qrfF3L4Z3rUq+!VV7HDYpz8P5t$2+_*#E-P{k-j3MtQ!9AGT#=!O_JV$R zbH)9t^5Nep%N9$|B-_A8-W=+`wYPzZ;ODdRardyflzySP&>NZeLOs zP^NhPj5g-bJCBCCrDUQHVozhrhJuO-0D);NyFBbGu-+0AeT=vm36WqwV1|DuwkLxo zhwZ6OAx3TP46G^=iYBP@`+=1ApZ)A#hQ&AnFs}pC@`(z|qCAFjTKE}R_~*LlpCh0F z`kGK=QoGa`_D`+ojIaQwY+Xn=Wqtm;7@CWe7|lM65w(xZHw7P(_tYo)RkvF^Xh-K_ z`=s<*A@B@?l3WccG3B$m|QU6J?z`wlVjV)fNa~ zr=vlX_tP}EZihWSv(MH{)y>gKRf{)%hK536DfX#|H;l`N$Oqr1XChW>g{d^Tf2t1& zG>P`YM7A+UwF=!I-qoj82qJ?%QT0PK{cz#az2` z4gLoY;67ngAZ4y{Ri(_AR;Zp=VmL&6t8ZqFK1vA_PXN&}I0m$-^42PX{7`w;TPf@b z77fpP>P<7h1J-&oq5wg50Ov>P(&FNrnblVAtdcMHg?E@~grg#eT<2Odk#gZvO{q&7 zSh4!9(7P_bds#yhSc%Z@c!(j$6qde6^-M^5E*96Ti*X&nNZ`eCE`+8Gqc$eFlJXeM8I?8q!}V{mo_@PtZ;7l=Ha3Z zHFJ5T_9PlcaIc=CjJ`-DL&?yy>brq5{%-f`phG6HP8Cf3Jht%~P>wW;U&eH2{4+O6 z{J$TC00)bI3}>8Rmh;_^QNH3t&EQY03*{)H`P&&5+Wi>OJg|T*E9Sv6*h~kbEOZ5> z&gnZwg<2)gnoJ>-;)bM-;H0E*_!QOWZ-2Y##!T2-8hF1VF(e4dlR0#MsqcJox#&GW zLCpsFg+V8-+#9rhyQSu!;4Fwos{vzZ7|%Hv5A&l{zy&+~!j1huq_4po9A)+h!ooI^ z{|>c%Jnl`5?PoC6UNQs5n03cjSjr^rs&~N{b)W6J6^kJVuUHkQwE>NaQVfW(V<>)xY*u zU)V#=8V_(k_E@^>mzXj)v@!Q(>KslrvV^`eQRcm*@*F)G(+AR5J;4SuV~SHGuyuXt^3-#Urh$>x^;9kyoz6|v?Xh?35uS60t)4M^e(qgI z-VDEOP7i=?QQQlyYig&^*4`0`<>I{OEk54y8jLyH!XW9ha`t?tzGMoFkeAxfAQQ6e)Zti#Yv_`n%j& zi)KVhDkwW{MK^!B9^pl`G`d?Jf)8#FJT47oGl$vv9*%;$WHzbvy#2HIuUaM;9r9we zD@sbnfjw;?=QmImVQmZ{5$tgK)Nok$A|%71(+vD6Mu^qAR&o`yG3~qxQ(iHs_`;hb zoo^T|OYOha{1bz=;=byzY&fu_Q&E{wc2H^}yMhUI?b>RY=F8XE!3V!*`aHtvmK&fh z8A*T>nX&49AJB>FNvq$R##`YZHZ!+zrHaGCoqV0cyLp4O6(5bA4R#eRjE_oQ1 zDwU-;2ud06nHV710?b`d0|y#RK)+11I;B5kWcruJhAmTYvcfrW=iNYvfk8JMoDMKa z48~&7?nNbZi7g)?P(}V)?ubbZzp+}MFdIuFfhrDA;qmfZ#@3BLkew1iU1WA#lX21G z2_eEfUJ(|Yd1$rVw{Nxt0iP3!;(=gB4DJA|^AltJZwoh)_qgh+N6zg~v6&|~W~#|6 z!>1x;&<-c=yrR7%ffT0^2l}Q}X-&X`D6a2afWn;p!7;&C74|<>2?=Bz$q*5bZ{)^P z^0J$p2{&9;AIEJpdifsp-9Om94UaEfE7$|@H|{G)bbP`Zv!An0 z#eAvWzTeWiR!ICDx={PqOZ}U3>hidV1g6k7V^glEDw*8FJKO{KACLYfw`~#e;%)Z3N~{`8S9@$HW{31r_29;^ke z#ZMbMuYNU2vnO?E8DQdo8gqDuws3`!Qy-c+2Gq}0{8P3q4K2Mv79CK5Z_Jq!ihewm((pD-2yP9h-jik&fw_aux zW7Z3DJyu%`=3J~7rugPqG37bfAiaF1&x~G|yr{9~Ao2eGE%bay9uWlh8KQBr1SXwS z&Aicul3GA2sc%somlI~ic;Ks7eQTHmm1rjZ|3iVa$um;}oVGyUyzn|Nq#$dP)P#4|%!zaTp6A@Q38_OC1kgNhIx~#dXxGqCBulNobl&d4b@ZsdKK? zf9mzwlm33s$08GOQRFeRYXC)G2*o(A$9c(SdNIq?)zB=UB7#ik3$FKhfK0h^;n4LXRY-*?XNXkxUfTf;&hNmInDoCS$#y=u@t z|IqP7+{B(b7nd^l{nWwmzRxFF50c~nCcj@8(=tALR zl?=z;k1IlpM4eu=2Ul=znPG70mMxNBJW-L^Sb; zC!r!z*a$95dQqB0NtSdkcvUz)xM-5n%M^KOVj#NHE7b;T)x&7r!62z{fd5sKxz@CG zhT(8DVq7&!r9laM^@u|GMZ>oa`&ot*bzh1jPx62u%KzU-5cVW-fP;%~`T9rot%Vc* zFf>QWk6e1nFL2<}cj+q4#k{N+U>Gj4E#cFzTrp-lc}eT{#MkaA(T?yiER|3F9j0C3 z=+}%#DgNgX4tj-^K{KZIHc2RHGyb9Zqm)!F!4tW5imu*nN=Vn1>}^hqY}hkj5-)6b zCx(JRxO|2ok$w+us|_XyS@{2(4};+OMiFK_yA2tVp840}h~q{X47kW0|xiArXcR+Cdx2l+OOvlc9Z^HOgwn5lM}vdZl<(8wfJ z<0HzXh3n+u@7-RsUwFc4DGeZ`mi1Re;>&jO__z1!H4S-o$agzpWMBtk&Nv;7(wRNA zYDPBx&uMO6iabIkPMYO=)O{BFwHsemy#U zm4DzT)%iGAQn+k$Jab6s`09}IVz*hy5?``KUutdDO>-7RWt!PHe^q$-9>bD{ws?Re z{!E{IrODl9D`{v%B6Bg+z_y_7{O+bhru>7}yta$+VKtd8;4_b<6W=~@Gr;zfp~=^- zRrx<}mcoM6nAFqASQ+52`GBM(_a2%zpWBhT8Yj9Xtx_c}*2iVRt4$W3Y*JWPTGIrU zR&#Rna0*Kr-kxAP zU-cHv!00Pr5rXz74*JAVDu@djOTB~Kv87gMHjOe#=L1P3{7xo6<5>O|6jMqL_{%Rd z<0^iCuPR6*qX{wm!>7OyO=$9rJ?yWvLD_iye(uBWEII-((-iM!58!GB8CRpBI;fB{ zR~L5>k~kBU2w91*SV!gsGG2!@wp#~)teC_7?nGiVt?CYLb~Je1+#z6REFcgsB!*vI zg@^Jd)@v5X8AC%d6OO|jUCrlreMIK;tqUFvF)E=8u~Wno<6 z;Of*Ia)tpThU$rHb##fO1mWh!LYS*e0gnEsPU%4}F{Wh}8w+nstQn|&SXLWPv)_I} z3U-1|@AlQ{WDf{W2QCd3MGW~LIZF_J@?!sti0$P2A$-d)LtENd;Ka2z!LK2KaI+W6 z@izlXg-XKKcbD`DH*0P${PQTnu#?E1UB}OX}sw@^1@9vPHi0&v0UB+G z{A25u;~GA@8d%uRed%Q=U^x+l55Tg&ye5RsP^=)%`;{HjGBUWA3+zV&Bx0kwf9F`T zz^z~*cZaNJS(%-T@j>MYj*-nym-y5^S`0^XA;FL!+ zkpae5d0&S`>+*F7%y5W6=yh% zToynU`t!^3-;0~na3RL;a&j1|QM3=UsL>(V`13$Sd4uDrnEjBs>IEl&wNr%mhsSi{iQjmmTi6$_;KbkfS&0F5Cj^5%<;Q_P?(+3J50phi z{(pmjdb5KXc)TO8LMXSabalBepz#xcAvnZ0Zk#uk+#kFLeS#t9-5U%zs(mnJw9TOq zKX!|ur%QkDQeWmR01~5JM5~Fzb`ZN3b!(x7!Wkb%YqC#%O)t5->8#%$zP%(y1ok@> zPC#;fR-5xqaQ!}aw3sC-^m(Bf?j73_GZms*r0Zo%i2qWWIFWFXm8!ua$a;`8$rqJk z@H-uglm!!%IU{|Ht~T*^S>>G@*a|!=u8X!8V~#bjum7}8diw38&EB`5NtQ z)&N4&!5QR!-FOG&cvz5j>PoS>uN5}%hpBy~^by!Sz2Z3J@{Y~tMr7@Fy$U;-39cEOKDp!w5wdY*l&~y~o%GwiG~(-;@rX8@ ze<;%Odh^Ae-Y@Zl>JcsBUKDBOd5dOG_1V;M4g8g}0>|L?xRDulQ+1do_v4Yte zCx$~ccQI4FieD?gtfKY#(1yzmmNHjnyEa3Nn+=N_%cJk$%axJ9C+D*lc2v}9S5On) z9^AHjI^>P)Vte3eZRN~i!9$wQ%8pkM9fhRCYq^R?(dA|YmM0&K`1&a7*RP80d)|`! zew&l-_Qsfzn{&g2_T{u@%rK9+`(D<4xf4y&yOsFeA{tQ}^)670Ua-jyp2X*Jh>B?p zOeYQeh7Sqh2Kfv4eqN@MONBwSN`_#dQKTyx%a-Fa9_bqR;>YP6Z&U<}2hdbRmf+-qLRA`5r=KqYs&j#{(MgGKRe{A||mMX8Rt^sU%U zQD`fypU6IzrJyp}u|`Y?Q1E!;9MA~pWn=Bd7Sjh*3|aiGAlVy>2+p#Ise^8>I4Xxw9!2ew(H`{ zrs{cDiq`RJW{$mk`CF|`EW*z_6ZL%kj7AUFT*cZscdA!ZUr;cNTz91tL%a>WWv+J8 zpdgbC7?u&ldYrsV`;fJQy0-Mn8DYqhr+x?$HvY2j0oY8=7ERA>9?;F`9fFI{@5qZo z>6Err6Gjf*u}3~Ra1fxN#L)Mgf|ihb$X?EvhvE5+fN*e%p~;kH&((t)bJG;YTs4%1 z*+L=@&*U`kYm%EzaLX-A~Kvw1qXs#Vs|pML#77WF1fg{A3~t~hvJ z8Dm-}?*diHKyA@_`Fp1|=z_*MzsacH9n~ z7dUhD(ww{+2?0tv+c~LQNH|bvMun(1wPtX&Yha^NfO1W}s;$E?NuO_yo@vKZnnSs| zWns}+7zk8_3unsR2ii?(I}k~-s)IM%t~>0_iHPZKmiNUH!yMxFL)UR8xZT8!Fx^h6 z=ds(YfjdDt7iKYm(ZyhJJR&?=g*B2mExPPeJK~{1dWLblhNp+Oy@R$#Bg|>3Spb6q z5FD^M-RnUu4nrfflxSPFN&PZKbzS@&6g2m90Q!4~(WZNSfHh~7{mTH_5w(Rm<4LcM2L2 zh<(9VA);nHD7_M|Tgm#-r7q`NmX&W*F{=bB%AzSFgf<|{1Zic$qF2pNz8c4NQ9XZiTp{xWakO(!~_Q-Bs7!!Z>mDLbI}{CJ7bf9 z^jRmb*(ZE-b_<5u#?#GNZ<2mXB5GNKk)DXn2gqyLPC+*ivSMk9+SGmE0`BH%Z=vmF zzY1*(^OD|_9YC$h=wVryXu~UE`AUeoUY=UGk3D1?O~;UnbRkkeJRqvee^ePmg_?EC z1-2(LN(_3Qm*Ao=G0&LIBpYbrj-yqLD1=61`-60lRyNNCs`Lrr<;paxk~kv^p^8x;ANHLjkZUYY5i)Aa6Xb342$-pQ}rzF8zyDTJ4Q$rg)NE{Go@WCH< z3oWbI*013mUIsp7Q~k~N+y%5(6a~3Dv*ObG_+EZqo7ql$UP z^Ttls+!lCrdT6g27am5|AZMcM!bVtXwopxu>-o`x&ZAKzem{u1bZ#} zln-zEU#{5BH3ZFGx4Z;-@h<1fQ+tV@rv$y+1=zFNo@l&=r{}mtpZ+$$kbV3q2SajA zeH~b!3%c5wS)lfEwh=s6Mz!u*y4vx^co5gUajXUE0it`m$@}R^GMrtjRIVKl3y2zd z5sid1<0-guyaZCBTm+18#~7MA`XxQTrBsAUR)tNY1JH7LwHc~njHSG*5#z6TCqv@I zN&7_cBmu7EXo&uge^pJtA93x5)5E^tMBSMds`84H)T2(WFgdPaVGzpxRvRU+^?QX% z!{b$@+8UKP0}rDJiK$~tUhNX|m3h5CB>UR0+m;@)qRg64ZfaQ(@2cSR1;n)jZ$#-Z z;tLh$xaT!(a@*$qtnM*W82&P0c(89KAZXxYv06BlB3URAM;(nzpM?s|yD7CXv|Uj! zg%mU_+KwMd^V%%^{JtqG8n8~CX-zzEB`ebJn=;aLvAy(D=vZc^DK4lGPnt0-JAzV$ zAp1&YH$`9u^Vyoh!jxB0cJ|Lh6R+O3RZpHt^s->@a8o#Mz&n(RUCVOl1l_hc5gbc7 zTg7+KDNvm2A75N3HR_>Bc_=a6cUw#-&4i@hMqu|0}Yf`=qh z?mFk}78$T3O4g6CNcJ+i;1_-2>x};cj6cpG_a)oVp_7P9G)9DYbGxI>YdZud}Z_)qVC6p9w5 zXnJvqm=hrOTZj`wZ3vUz)DaQb2&@ru47?2lZi**LZE7;+k7Su74G4Tmnq(KlCr|MD zK22f7{;O^TyyO*lb9zuWdcBd*(B8GK^u8|VP#3G2w0M@-2GKKwnpMDDbzYMay!Fv()Tz!o@X zFPEPC%QErLXtnpGTC00zPpCwZC%@y1fVTT}Y;!-4q_<9moUnn!pAg&{-Nb1-@=?(z z5+KAT;pAfYLc;VDk+ZdQi~W~q_QlK;r71(U9U_fWib`6Ho~IO2{K>! z;UBVD7}#GA8O6(tsn-svaB2#?WC@8Ut#K4|IrCy~tI5{0Q&v{#mjAbaTxNn-{(r5KL%fu-U;V~TY7>t_9wOqb1jR`!X}+TSFd+G z7NI5r5u$Sq5&dq`4?Db$TjouH8<&9Jm$Z|h-GxsK-P>PDY{zo#?!?A!;H!**?(e#X zAJ^`K;Fov#+7DZ=a!nl_)9L4EGckJvvSAblYa&7?1z4j1RVKJ@HFD^b!VxpfeF8p&#*TR2pB>el%xkb)BQF1CGIB@+b!}2irAu^7 z{GMzUDvpet$lM z%Hm}nre_Y!&$53zL}`@|ciN9J#!ruYoJs-LJndVvSVTKgPnFx)mZ>0G%{RGPwNw9^ zZ_FAhXB(bGaC+2@#xrr|QuL^NC1Oc%k;!bxNeDbJ=$9{pqg*>UxDfHXX~km8+hzjj zSBxgc1&cv`7J)XMACo+4Vyx zr)b#SHyDZrD>4+4SmqD@nVX+Lt#`_}fbJ%2M+=TBfLPiDtX}mT6+qNIr12* zd9EB8Q01(=mFowR$(OCDdU*{fqFmPfY~9BFF@$8Ixl0YTY;f!pxIoE@}J2U#ZT$Jc(tcIv%lcIie*uPJW*!~0@52=j~g zM2{++D93!IC9lto*~+siv;G&y23(#ge6&SDBy{7Xx^*)g?#RryJGLQBFFi@o#fnzp;wL zK;RJoC7)~1Psla_m3*`c5a*E9fl*+7dyFk)74_m|+odjQUFlf?V!<6RV-6u6W%%ka zNj-GiB*~-sj+KR3f^RT~Ce+H}Tb)l;VJ6ECiY93@2TTr1^iV2_)EGuRd~EUBjWkDy zT2M3+q=N!_Z9X6P=VyA+b|3J}IH;}tZ^;x$50`UVHUlR%;=3D6r50cGuirjvd4pg# ztDUpP>_V38v3LFTrj^d=H3XHAUlG>2sHH%a7Ewk2ft#(PBeplJiIyePOgY#=E;@GC z`SKlQfK#}2u(wj_TwE{iT1eqdH9)EhoDm|n*j%oBzSMeJ1&Wi-c514t4zp64Oft8* z%Y8l!Fc2cFa~iA<3i2N$_J=3OD%_XP@90`eq|!$JC?t2(y5x(X&jTdy+g`MxqeU=8yTIg` z;%+l&v{57o`Kj~g!?4H`b<=Hd2Uzag@5n!vn-psh8Se|7;!$;lULovvsVLvO{h5Qu zdAj0#ZkctTLrH_IZFC^jxlm23&O~Jd3kM<#GUo__8}W zjwj^a+M#$+*`*yvT9eER3=7C$Us|g=YhS>T4GWAU4ZuT#WZsju+@&ZEn}EjRSr|bX zCZu`t=*f{pnuV1lGJ-H-cKnHcaFC;-27(ai36F4ZxD?=!UWvTi>=Z-VGbd`gUk-$T zp5@7w2tz7RfDj!=BG1Ap%ybj_Nw$c>TV%6I!~5z86Lsgo9Z}I9i@`J^#e^D$x)WjesNK|s_?bXVi zKW)%&YNqe=3R)L}Uhl6Qa`yC+<$tZRbST)~K08EX(B7Z|U|odY=Q~eVk(JZal!@!5 z3u!X4O&XhxE_2qT`S#OImAd^knDG0DuwrGe^!L=Gx^PrPx$sXtJbH7d^J9oG0QdL9 z&y)w2MHAVV&`q4<{eYvVFL@phkHAjI6#%k0Nm)s=`jSZJx&Ioz?()iqZHK;Ek*8!7 z@eeAow1D(x-m66o&wv5!>OwVGFY4jsTzMU00js0W%YDQyrOXV%RoUd(0 zv)Q<}Zzc^AkE~IQajnnv{xJ4&ESBbdRTgx$RBXxk@Z{i-@EkZ0*hFdufH#W0#2`LL zeRFoiWgr{|?r+C9STx!hw9GG6sZ4S(gc*ahis}owO@dwo4|JOLZ3I2fdZ!h-&BQ<* zS;wkWbguGA2;g7lPi$hNaLT1*hoJ#huuddOFEizh_LPv zb08O66d#*EbboQ->rj_i7F)qui?y_9^(ND@wIbUwHV1SL6%iHCR-2igO!#-e-5tMbe=xRk)VuDo7QV zj_F*#xOt_6kkU+LupTr*)9UN!iNItfYw_4F+(w0+zYycgygR|m^X-;J&je)5pnn!O zTAOUBDkH~DUb)%~Q;B%NVP)gGRS&UythHWI6RV=vD(>Xy@%?6`$1y(I=hQabwRJ&6z|NLA$f3>tKSpk z!d?tv+gYYml0Te3WjZU1{@2L!&A&Xo^$%H@tN!O(wdqwNXG>ba90*vfwu0#*7o?aw zhqSlUC?4t#B|vx!7uwt11uemkobOdxv!k;CVjDnV*2@kgWcDBmbjF`#y7+LUGGu6g z=bW9xLZw&n?kpe(&$YFV3jZtQs4nMMlTX?PAZ0>23&w##vUkOKd&gjp6tGPfyIa9! z^mmdY1nvcZnKe1_EF<#L3>&W|Vu0Fv3jI*%t{-i+)pk(#%asjduUA)j*^~&Nz;*E8 z8+l_qr%(M09ILp~?7^zR>q-A;HQV{n^*m#CZP8PoBvT9#b7slP1~Y~sNlhMzOQbO% z#J+fd>YsV0ScpWX;&Y2Aa$C+7Tp)K&glTxYJ2Kq)@QO_3m~}M@py`(Vi5I;35@M+%?%A2)HMj-EzU1cjlR5WQ&|6cN8vI`4Qbkf$EivcpKJ}x&!WAU&~ zJr~$gPscSjy)43os$%qLHtB{JOWU=F{uwW}i~9`>8v=qZDW>S{7;nZ*G;_!(>7560 z;g+&RCr}~GE$g`*mNjKpC8$^@2@gB0HbN4& z15^zmI><6YKSG3HCP?0Q{C-~Q2N_*pI#1{em5Z8=%U3GDoXo8LeN6t4r&Bt%Wvmi_ z6Uugj_?-FCZhOPG-!5q}u*Xia;^+%v8+;cCpl_5L@z7}|6jBR38!L|Y#WuKgt?*Fa z2osT9x~mVyWBm?_qZ>tT=w0`g?+nP21#y}azN&_0JiI0J?xxRDpzJ;mVz#@D$%af_ zyObYPV!$r68s3$(psT#?+#2ZHg;6uc)n-d?6|u zq8W?I3`-##wL=pc3p7~Kv^DDrh5_2GiVjGuv^{+wnK6IH&@ZtphW(w5y!m(ra5q&t z%8>N^Tf2F^!wH*Vcw_KR;r<@L)`=dH`Xy2klyHTeM}*Y?-WI|F7i;LIU!=Z6I+2l0 z_1N$t-H$HU8X|YxKrMJz!L{}UpR4f7`$5dZLMWn{0~w)6!{?{hlpV}9-kJNMEvF0&Sq3oaYxput zF_lhZW$y%$jCZM@;K+;%ls_Y)2nR~{+{Gbo0-m{Ox>7DTGM{FAPPg61hPEvcHaaamF3(knqYaIXVL z0593$e(*(%s;pqVJ9-rZAI}tN1Easpc{f_q6g$UQyiQ7A!qR`aEzEe!Q1LlWwRE1k zUBl<~O*$I*lR#=rl{Tkp0yU~zB#dQHvV2swvM zLy-2=r3qKX625gnaJ)1O+n{tSrR5g)aYTB<(HfQN?Ce~rX0OWII5u^hzqw&M6Cr&N z`s|1Xb2AoYKU_V-Y2WQbv)|WTHugj{A2>uP8QHv9+TMLX;{rE&BitMpDm#~m4LmA0 z)&k!(eK?4Sg-$a>JbLo;TAtc2p28c6T!j3CK_QCoE3up0gZ!F|QdJccrZE7e}h=>*ydKDY!xPE5o z*EDIj>px-=q5&ZPARibav3Dl_OyZu9IV+4}87hN#hnT!M@A@bc0<@^3*n9i|fj7L3 z$DV_aC)Zip!JSRAO73k)Z6bOrOeTFeB7g|jfewU!8f5LwAVyx?zCpwikBZ*wLE(rZ zOle2ZrSV|<(uqT)4A*fP9^dtZPSZ{9pWGt_^=~n!#MV7=JYWKa%AKQF=e8!HoFs@Pqso$iN>rg*5pZEqDWfA77E^#xxxqW56 z5{VPTC`~1@p&xx^MXIqO`&p}tA#qSvLM9^mGsXwaD+a-d3J}THg!i>1F4WI=M&nQh zNf6_NkC!42mjhX!&=hTQ+mIg-u1s>~*+7tPM%J zaOd-1gSSnYq*A92qyCsiqOD_0kOL?9$u>T&$4n&cK~<4C-9a9MWoHQi1cOI2T7l2(Xd`vg+vMWM$(6lSRh_#;xMd!8RX&19ZmEPoBC^fWg(WZt!tw!iVY-f3h$ z4_H=u?ym@{0xE|oF;(;te`Tfi2hwV%QuvIEIks=GTll~7LI&cbY(;-fYCDkEHkrb4 z`y11BqsrG=886GHVujrwwwaZ@(uI*M+5aRo{XMp`kZcOmIwBNtQ0?&bwY>0v^EhWM zckF1lSZ%f5=r03Kx-T438Na6XQ6s!=bm@*Z2}jo)kzukc=EunPQ5qfAu+AF(HLrVn zTJV%9cf^av^IUrb?Jhp;tOto7v5@=XUpN&~J@6*ULOw8h&*jc5>5;`}-_OexaPc@$ zhwJ!VIdof~*6g_vOc1QPMi;Vu5RBN}mx<#o^)uwU1a7(UZQB}USj8%F<)Q2C6mPmZJ;uj&Z#^HFN|vrH1dx8hxo&zRSa0|}ezf$Zhe12E zi08@7#?y46$j8lYpxpabn_dQju0vrJ@-Xv%f=Ky~NBN)GsRvB;PE`S;k+tv03>> zWD;}`KCk-`55n#jO>vHJeIE*dJmKuhO&JdJKXX(@@$aKoJAqcoN{n`>CmVO*jhEM@ z#lrio_^|zY>c+Do2AG-v-XclznishTo-e(io;xpW;oydarVZGz#gYQhEWm1vGJf5S z3m}oW93r|3T*g(sG3puezj!+K;gi(#VN_zj?@nnqc6QPxPPqNeVl5nImpl;83L1)T+JEwK_}(YjSb{t ze*>3S*f-E}?px`zJX%w%vzW zhNRwqaqB&r8X-mAdksL}7b?6?9@bw^ClF_5i&4{b`}Ny_UK}9|Lu~cMp1k}@68rf& zmU@x4~@OVSoPy;QLv%APNK!)%NeGr%-{k# zjH_a-80KL@u4g)?j&&@4GGDA)ib=(!p(n1HDQxQaT{q{}#7EVZi!K~*_LQ)5{qfmj z2NK`m^~>NlI_cxT`CR5!euQT>y)6qYpggDmK`v2p92re0jTEf=>R|0WpNm;m|F zhmWJ*7nA2J*B)nEMI3kbJCFGZYkxR>C>I4rOgJfH$gYZEF!Nu%pGN=As3Jts1!o)K z=WItR^+VF9vQviPK|)#PM>Wh5lwPVZDAQ+$`~7Y32iK~frk0`j*v6eci=R*UD-DoJ zo*J6O3f!lAL8oDmnfvl0#LefDpWhS`b=44Glko+8Ihmgc1T=x(+)I0KKI1+c>4bfO zg#t`K;F52q9PA9D_Tzd6;SD*K2>WRv1dZ zAbgFeEMgSNvbkHL_j;qR5vJulGIQRjkenY9`Hx+dfHCi^~EY0lj%)}CUQb3BAOgB|FufH&xdxm9rke&33=X6FoiGScvA`*ZF zxgYy^VFz6)`X8I4W-=TPm@i{}?Xknu$1}G$XDERi-|9q+M2V{O(HZ^>Te$Hgi3?-g;g> ze}BnrwtxG+b0u3hr+;i9N5>SBGeV(J`Ll4>cPK^b2W+X@b3JFHV%l5EGPBx+2YK9vPd0q1c_?B!Z2iXQDOcr0qL@|AdEj1{l8LW2XKDbO5FO zy1p!&ioDjGRe;IlMK$uD09mCbK|xlp?K)e6jlIOe{a1hAE=FdD-58eG?5o{dx5aD+ zq6--CYRVSc7c7gmjWxstX&y5-3s()1|5w>rcE#1SOBfg!+;wnwhu}82ySqaI!Ga7L z26xv43+|c_;KAL32DiZi1RdOScz?p#-}jeZy;gVET~!yi8u~w|9UZm|#)Jv6`)ChM z(pl6P$4_hTXI_ulI0_GtW`R^VA-Sv74m`=A0*`y=t;7@b2U@_%Ww-_xNNc?Robs;R zNSDH8@Liy69}=6GRI&Tb%-RGGMt^xF_pe z^ezT(l!z1oGE;$0NN*=gk7?DW>v^-N1*|yx8-~9%;X!!n4bakR|3W9 zn|Hz)wy{m>SJae0o^5hBZL!h0a^3is9Rg%GFI?Y09$*+`Wd;vP5;_#tnw``Ih>Q?TLAwFWC!%*d#gDI0>F$)IEYXFISHAXOMhs63>;_IBVVxEwvUH#2~Tt0qc2*j1( z!AxA|2eoIIY~KbMCo_XFpdogfWcIWZUqbC)b?mbPeWD_S%`=2_js-Sfvj z)9#;OH;P}4=Uaz9YG5OdZKS@lWjd~yzf8?vIKpn-teIR=I{Vr#7WzBsmP5pIf`f}a zc+P~YdOTFU0~qKQMj<>&6RDZfLVlT7H%K~eXFk7Q%>IJJh;%~C9kf|XvHyYKCzV^cx&FBm zGGlI8=`V+JJk0P3 z0xtn>!x2Ynh%(n1P$b5ion6$682Ur?z-@vTs(GXAn7&P%;Rn#rw(;Pu5MP!Pqv<6y8VHi2^Hj z%vmALk67iSMd)gXK{T+*F{x30qRP@P()Y2+pzm$9jMG?oDPwFYRN3EBO1Vvxl^OXS zV+rTUqR@FnM^=p)UH8NYbm#tC@`y&U()lyx{9*;lME4jyvEcqN3uo15M5!Yk>!mxF z^|}L7iIIb~@xw^_WVu{Na0=lHe}pI6^gr2S*NQ;K0gHlXMpRZzyi}wd+7GLzvryJh zuIw209)v?}sY+o@h9FMn?$Nq~BU~>Qon&iNw+TZi&GV503J(q zNcZf0?Vq9vrYk2qA?rRZMt)$CvF5|+IK(J6%2cR|;5axG)JfJm8$Bj)z7Tv<{*p)X zeyUmX@0?UZS+WTUw@)w}SvxbZ;w}ca%Ieh+?ZB*HKQ_+Exy-!0l?eTw9a)K1p!yP9 zFR!b|gXRPCU$|88NOxiW>DGw%*FckM4CBzbV5QL>oZ#f}lV-R7en0LT$Ojnlr}l3q zPp8Gp7$~;wsyT+0gYM|$<9xRJKK-^QlTS_|M)-d zHf`60{@nHr`ifL;6>{~9M)?gjgg6=n|AHWWqh}R$yo3&Ru5At~RJ0Go=h3ST2s&ji zppn^pxkwG=Y`@C(Woj@IX+F`Rei*W;!*Lnp z!+xc!fB%$2dHp5+J!Sa8*HJ=f_%+FPb4Ud9M8A zD#Qj=M*Z_R@3GjWEp6x-HQx3u5mPL{`~z&E2rVirAlbO%Z~Kmpc{tNKng}fi75|O` z=rlh3&lnpxxB0yO$O8oIb zA;a4w1)~jYgh`07D~oO}8TumEbX6nlFWwwChR7E~Sxai0*vGmYJQk+VKDE%wE2 zX}?<5Uo(%LLl1iS*K5&Ojg!nKO1ysJzeH)D-350>98ZL1?;2bJ9-kt`5zg@h{I7lqr<;)OPUd#1@l2{RJQrb_{4DYxEKzb{zcpAoFXm01 zMlYZ8z_Om1ZM3=05_79Yd8rC#c_LygUGaAI2Ru!bMk>%&;6yiDP7YU!h^#4+|we7?Rv@!w` zf{9yjLH{r)FWlQ(5Cbd1ce$1Wn5TJEj@pwHD74=gp1gm@*UPMC_Xke(?vs6=(lO(sSM1<)r3w8nsC^ zx33ApD=8Adha#&~0-aoUR!gomweX3}Xv2{zG)2s2hYUo>xr&L!yQIk8>VQI3?K=x` zH0^^iwc9mV5H6RPE<71Dn_y#9*Gzvs1<#f^?Pjxm$h3wBAc8wT069<(Y?S)hsq`pd zYD++U;*f6jp3M*~*fWXft&VUWr3{%BTNgNmat5@7#JL>(367ORF6jFsty))z!_;cJxXE6D@10_LYf%9jS_<{jh*Jpnw_R%XM;EG+Q8 zw2{T@j8fJ&drYL;MZ7pN65S%8NvMA_}EeLh|(!6b^{GhFCze{x8FhR4wtAr7k8H)?{s8 zRKYRj*`4RhkB2t zSkelv7=OMgVF3 zW;{6TVqbseK?cs2s zX@&ec(h|*FS>24oeHoUJCq$ik4M^)kz zfm{RSJJT{k&(egF>}X9uq?nIi8=IMA-!7{*lzbkRzb>#q68DbM;y{0XGq`G0v}acc zr!~X@1uplbI%)MepOLF)`XjwfOFx$U#p%zjUg1p`%^6n?zWctxQBo3hKaSB^-nDrx z9`3DwBJ!hGVc4Xsv}pcr-`P~}jgMFX<-{?;BofaFvt>#PgMX!y}Tr`f1dB(r4G&`8JjO;Mx`$5jMnrVg>%+~ zWkDz-7iDMi4XOlW)}x130wa3_nctAp3m~NWT&m@9W1K{5N)e=)4InOQ<3dCU5(Anmso?;Ud9aw8y(%YwJ*+-03q_6Yy!e;AmQcU*tAxu=9L=AL zIxEU~Yiqr7n<<)3NYKU7qf_lLy&5n`*K0ASRKbQKYEZ# zUQ|Q793oTZs^HW>=)i$h%bn04sA;IlVbeOtYBU3dME~}RzrrmHtde|#Tu) zJ#u~j8dX^B$IUy_xd;{_FTSD8YN(fF?Yn8&!e4Ej=#fhmV&^6EB8U?vypFWn7@Y)& zXCq>t<(NsD2P_C&$gWDIx%V}vmF(EIxl4jm+uF2sGT_qx(Ny^j*`ofp{$o_X)>>&L z+6C;*ZUOJd>T=YF4>lT9n5e9;dwnO@RvXgmfrzJl|KTV+ir0^+$p=xcqKEaCjM^7B z@shOLDdv-*lOv>}_mQ(6fIXZ(>1sQzmpGg)OHprG@4SmqQ;g4DE1l&$LDBL(@JN%P3cP<)}T79F1r)382tv^v^5| z%4(6bIlXJlV3H|ThqkmBSKG41hW}+KU=kr0a}Uq+pC(@3dpDua@moZd)F8yR+-4WU zwx-#4ls8AdteO1$Jha%F-8_>+>-~Gb^cFDyE=a>uy8Wd1q-8NU5QyMl!D+(v-j$Cj z#!khhiT2@xppXY$S!n%kf*K;GM^SBI2(LP-<>O*5s`S*oDB@5YuZK$Wf|TU;4Y;1* z38qj^@)MD!6C2(a-mqQx@9J|%D2>OP)`a57fccCO{1o!{6xD;uGJB<>MGYaDX6t;> z$V!&`BR|V&ob0F0;v!I@?eLOkJH(#B;_)HTQ6yKLZFHn2UdvfuuBYO?%;Twwtz^Xk zfA4kYJ#FoO=-EYIE-)eo4Rc!4KasU)5AD|kYCLbx`Vj4<6!A8Yj*}y)R(6(H&3qVZ z8St)_*WZ?o`^(e!I|(Eecwrd=7fU%+o;SYo!qTk|j%dO6q^~bj5EH?E>hRGT7r}K( zbr4MbXkSP7>Yp6^B^-i-XPvrd@f(77zNCT}N83aSU(iJf=izkzftgva{)M2v6x4=Q zUQk^_i@y$c3E(D5pL=)|XKEgD9Rg%B})JuY@HUacpuZHrIv?=ZJ$=FV-*nlEuO z>0w7)6qhu^@V4nN*G47}zr^Z-bkLR>tMEU{tD;KOyW14|8p5n$z zBe#F;XNHi=J@8%7DxtuU{elcL(;J_f^Ek{SvDSjkea=su$atx`(|kWaz8#MD6oGU+ z&xZ25ZW4Vd_N#}neOKD55ws>8%e3BfE@rry{hP$W^-9seCkJ9$ZmsGAU=`Qkrw^ht z-6vhODmdjzHXy3(yp$y{Ne40Ra0nEWs~$3@lN(KEqSvYWtsb>+Gl3Xw2F{23e*b4( zyy-X8-ZIX(9$a%le)+nZiZVlOJF-f!CkkSGAep$1!v>-(D6`X$=cA@H@|G4Pk-yxW z28&Q@#@jZtCF6Z%M#C&}rLQ6;QKuk9 z%{(Nwb%2l2Ag_(A4tc(0G!FcSX|$H4j<}4Exbe4jY?*RVOn#;Mb~;7B6{dxQtM>MM zb5j^UbW;YYcIsPb#F(S^E4ZJEndVBjV^So>Up=MIj$8{}1cya{ErZt?NEf_;F2kDFk9dV5fSXnul}%4wutC<{ z-W|>(9ZbFj*~QL8U#pH7BM%LtiE5@6^Zx0!an!E4csg4HT^aQbC<&Abk!^NevItY- zrJ=f`e~%yI{S>JCC%9+p^p8Xuvm>5wd1pP>i)O_}wZKKu5@G%CwW9!F9JXC*GQ>c( z7zs-UT(PV&8{No{H+y*wcBlgj{6HpRU!3`r5bD{uai1`wHO{wM4hY_It2771k(B~_zn4I=n zKk;dMc%tjnE!T}`ws`vs#cAZ+jSuF0_#Ul2_^wzT-R79+UX1Iq3~;XLqBqut74d{L>Y?!O;5z)RT-DfZkLVoRvxd(Ksq$Y!XQa7*rESIB=&@m zo^1cwbA48?NAR{Nn^c2Y4wW@C{!q^Z;5_S?pI%&DK_W+*6)Hxj0|xgg+Oy^IiWu{n zvgBd1qVZ`*(bI@)3I8S1PO+n$6!UJT>(EC5N;LD^)mEvki_3K!naF6J^D+&~B zU;0&$fUf*_#@0>+OoOvErKV;Ep8L#x>FScPMoPP#Nc#L^?`A2h6*$^l*h}<1;UHF})=j+K zSLk#7`k<85BA2DuDP?k<8_WKwir4KVIqa`q4E%jE4AXh#?%{Ta>anRG>W7(&e}TY> z*`w;ongSnu#?Vbj!U(ZuZ0T4ZEu7xBr?D=)@00-A5rQ)qshTS);~9T>NqdVGBPc(5 z5SO0#fLx5uxid=dWI8%rm=Gy%W52L6pP4hu7CktlF@r=~MOcmh(FaU2R)_1hA{6X6 zz@RWsoSS{vCk-+<5QV{xD$0jF6W&x@jIK7*`@^261VzE4w3qH>=7@s7YQ!W>Sx47E zUZ69>0J5m>)aQXnj*@7-puuQ5|Gv5odC(z_23I=cV@6ebp32ZMyV`KnBZukq87^-!3X!0IT@yvE;2@4tPs`B#f$Q5+ zmCo9Zi9s^MDzxalg#MVhzgvXUzl9fE1YdvPr9>!gJ z(`yy-7&#B7p9TPE=0TpFSTDApH&1{0^|!duQTrMha+#0k;g1Mrea?Q9E z;XxK;kw`)99I!)H%iNf$$QbjK+0}TUgwFWDr?Go*DaU)&@V~S>&@m}K_Hg_eu!R%y ziMi>VEFzdi+StTD!7#50bDZ{r3>e*<I;m`W+hB3x;Mq#-Lvi(*JoB* zsg*$_DG=GL@HWSzjivvbxLdgdx)1iIMKqx$#TKET*2vX-uZ1_0qi*nMirX=5ulltR zTIr}#-{JkvEAGq-T_XjealE+^xSW+TqNuJf$ff3-AaUWTE0`+8(jMNND^%6iMdKg>M<(_-6Ge`0(h`6J=?H zzCGUEYD(8cP;jxN0kHs>ks_CRS33%EElDbz(>;EOqUNbG#v-*p(OBHEr{MPDV~r_| ztn$`jub*OHAWIx`?ljMr{tNfA5h1dsM`L+c7uJx#S}V6Y`=~@tu?_vGwbUwfq&DyF zkkmY?FBY!wrxD?ac4ASNEw0NF;R5te2sN@$DRWNnkQ3yrJ*va)1Fq&^W)4y;FfsKc z_y1BNoKn3cdVR+fLhoO*YDcs1q@oSjN5Ys=!J-w32or0UKwXw|B*!4SjIw8yPmUZF zQj1+UAghy!KVwLLwojvX1b##G&n^Ql;`H4TsvEFaspoaP zApnZ7B01PET(YW|U#z{zwB`l0$vo%8j;rY3D->X&aHtGXnW)xJ5)<9>k?Ef)cmH_YU>0Qp zNc#A{&~XYJ;r#8be1?mIgQR9Q{kpR8Dp1&tlI#x@Z}_H(?+Z-RltUO)g=l<&mryk@ z&D{;EB26=`WQGR5OV1CnGLJ}|=+|PIWHb~qap&|huw?*@V%_qMs9F<|AoJR35exa^ z1Jg&s%3i{d;wK$xfDY{Rkt(tNx??h4Lg94*m67y)OGIorC~DSxnK6DIvyAN6je(R3 zNh)ht%im9gmyQTZ9a3gt{uO;*7I+iv-EjhozC#WTWfHOaNe1B3s{op3+CG96;Q;pf za>XWR0gQ5y_e`>wr9?EfDtZ*t;d;?tMkoj~KWCV`jabujqOa8i669ez5YXEox&^gC znN@_9b09f0Gkb7sBJoeM4ii_RnMjc`Eyg?L0%$)-(Mjgdh>b1I`i&~8&L4+XxY3Cdk#wl!nD z(C6FJH6(JY7j~FY_gv`i)0>&Fr*BwB)@tzL%|_~b2Yb9Zd)%}f>AQW}8<0}7zWkW> zv)<}Ia?K>@4&%rM`p2Gi7Zsw}yu+I?LMJxE{&>A#F6b6F}f6*WoP z3V9+tnG={t%2*Lgpxgw1s zzt0Efp2_ucHB*%yVHgMnQ5>%50^upEI@GShE9|BpE$aT-KIJ|GNS3l}0016IniX>_ zHq{t5GfaLNtZ@P${8}tqc6qo6%W?7pYeUO+nSwKJyvgtBQiqG}OB(tDb#r=>B`0du0{x z`Aq&c?Qkzv$=h=wV)56Q|4ehz#gdM1MX~iaDJJupfBp?km^x^nsjO~o`@Z+t6oE+{ zFrsECCUma9XzHVva~Kq>xn#EV-D*RTq8j1ZI*mji=|>}00Rr!ZR7W{dtTXJ22WZF0 zj1A}OL`ba#(_8Zsgl->m-Ra4Ih`c#r+%U$6?r?R!me9`HMlwoDb$-m(4gDjIHhYw= zGY)%b@)5SSya`1Fy$Z$pS4K6T_WS=#+~(^5T;eEyElS?VVXEoTYDig4xP8>V0jBpk zPEW@r0XmgUd{cBKdP}Y%_ zcvI{Gs8-|s96B8vQ#;LwG_u>V9?MBvVARH@CF^#g}Bs`~VlD zJOq0nqE5oGxW#@k6?nE6liibLPcR*rtI+1I} zd}a)#pCf^)ENMAJYPG~95 z)WHrtS?ymedSPs2_Gk0f_~+6{m9Qz*l#^ObLny8nb%A-mfQ}&4c}AktQlNbKDoN(9 zrT;W6uWQlu=XXv=R=`F7Ku`-YB^I|jPWox(M2Vu@h-UdO`S>_2@;S%jAHJQ)|H_0z z5WkR@{Y`TT1Cs%>%a@3do=#?$k)4}!WDR&yH$o`AL3sIBP}vBenH2wwhgqonpI4>) zy()!<(qSTJ5`mx0Cw&|*{JmId()*cDKE6NK&0@{agiG9k6FLMm*`|DH+!F`pnEQGk z2F_=x{=~JG;@k?gm!;#OG<1Qr>0OJHISOV-4UwpI5wcwpl|dXS?6b5~dt*@?zZcAh zQ!!zK?|HzlaBs$DBBOe8zjQKRlC*GQNPD$gnE0R|YXKC~mJExeWhJ6X$rjX-9~= zFJ4Dgoi<}-diDkA0z?FZtVP98pZxF6n}&AmBw8v2xq}8GelGdBXlhynMMe)b_8gt7 z6lg9W?}rVr37VS0EZ{gnfMKSc(zW0CyI^<2kz1s{XnpZPI#Y1|P-vxavvC$eL=n`n zIgBK1&L@VbbdQomlGFnqL64;$fnJ7QBTy6?vP;= z3%4)GgYDB@3BOURVxy)w?{gO=jbLw4=gd(xRwg&kUk)0|z@6QI)H29IqO7}V_YO&8{3rZ!eBM|zgyRaO#D?tZ1_;gJx(vn~!mYAN?QsL{@4kRw- zy!hV74};r@h_tcq9lbzE8>ZcdhLE&#fiN@oAEEc|jCjSImdI^<+a_k zw!Ntl40ZzHZRGXY%(J#Y5=w0{`9}eiw8#b6>e>c6Wkv;RT8|({ypiL<%DGMTC26Dz zq^_0MVOsjfax5p7SQdJ`omdkfR)J0Mmmz{up&x;s4)6B9!U!^-c|(n`HKO)g3V+TB zk))TnOA$$A=kQQA$VUMY4@j0Z23hSIRE_ekg(X9t`nvxMrqg&Y!89b(_P9s;NlWHn z%Co#VOr|mTfpTsImN09Q!4Qs0D=JY{IGBVa2NgE}pw0FXd z=Uj%xGIYbA1aj08yd2Ck_~$80QWDr^$fBCDrZUo)M4Z>cLhUBgc}4QGET_R)5ZS_# zzUJQ<7vUhFlUja$L72V9?5j8lz6s$3*~MG5m}Xchxv*$@sm*IY;2G}>QBAL*8v~y2 zM`ka0LsF!1|FrbR4-TO)L1ezTU2`W~gXk@zuLB{EQ(YlJHMkAl!uH?)N%0Y}6?)0K z?KTT!%se^Eu9b}lthTDLFH4-@iPJfwPaBzzrR=hH&K2_$*O)aIw_%iEO@ry8 z`Xi~Mf3#rB{%HK;qk%O2mSEZGBO6^N12!n{x9o$=!+`hx*e*6GCHUbZruICJ{Nd%~ z2RZT{p=2txOdZn6G4Ji^ai5893EGH#`0qTMnX$cDBW~eWF?fPucnpVFeb6Uehz`C}b{@FPHL98Y9Cg9`Ta?E^;s5K9D zP|DD*!I^CeqE~1*r+PoExs{U}XNk@1!UOu95BR}c5+x>i^&%m%18s`tuYAo=x|*hXg>#$1)E{T4 zHV8Rcb|@CZkS>x&xqm{3$EhmDE+$Z1Lze>9?dB{>@k=`$7DoPiUYUyz!Tr>4PF`)= zq(Ud}fzi2-MymXfBosY#WBS#%(2l~aWG-I3@n|bwusx=wOHl2KPQTb6OzlSN$sCfD?-@J7DruVI@A4OR=D+6CB zs-$6M1!$+VPC|u~pwUGo&N=~Zw7ZV!JSXqm$825udUlA~2V4nz{DWr9&3*^>=>j1{ z-G~KuQ+~2WurN_=2t|pxS{gK#iZU5cwk2vV7oIMI`Skn;8k6?k=o(^N=_=b71(ijB_HJh= zatLs@tG%pj%s-GxJO%pQ(MknB65YC45R~^>dp=yM!KK!t(-+vgo4bdKqJO#r8s2GI z!yQY{#ezUV^bT*U?)Jad!Zwhcjev}QG}5I&z^jU+w`15s>6WudGBE;HH!0S*lB_MSsV7GLmi|!#}P9nY)W?ZKCC1K=*Dt?V8cH z#*SxsA|mY8d^&ln7{8G>XI~fhOM=0@S5YcvYH=zDN~(|Mox_1pK`lh6+tC0YZ>$vy zYv;MlYOE!hJ&WFY@LZb#OYu@-NYMLph`sONq%)U{%~;&Y#;B)2C0xzqbKve(<0J#3 zc<|{{?aS59Y)D*eDFn@Z#}|cXn45IA)gY_87Xf;pIFr-~Y^#6x<>CteU|9o$x~yc| z;;Eyw$=0c=+htY_GdVlcK>DOKQ}=0GU3V9R()R|Bw7e%*a^<`Io2kPG?KM*4HVD^k z#I|K@YGoaR&Mo3};aSW0+?dN+1UOUGJwsQ9nzkXH!Z!~j z(y7BI?Z0cC7G-4w@-?8Ozioj6OjNEzZB2|S2{ZO42)_t^!}YX{KxiKiMPBgZP(%H*`=pX?oF5_&c1y9+@5A2L@dlaJm(xwil{PlGLO^AD`N zskQ{26w|9&cUkf@%!KHcSN5HJe8|9H2|a6C-jrP}t!WRjuPQ#4LrWV{1P<8s~hdJJad};sA9qu8H`i+d0%{=0F6=-6?FA|Z9=Q@D+t?johi8{_p zL}!7yD5uoH-}%Jt-D$meDD<+ia7Uedu2=L5gigpIk|Nl0moT7jUOf>sey-;nLM&$p zP5>oTkchvX`aTH0d;b<}HNOSB*#Rk+ojw2r9Jw(S309`2%d&r0-FU5(X=1W^kYDPq zjH^C1^EY0Qci6p|iMmAoG`a3}=ha^uJ1R5`fRG9n0kyp+;QSMZ2VL}If0o6SevAS5l=+&;%4ABN>0pPRW* zwbik*3If)*mFad~-XZQ0{~!2nuHQ(RfZ-Pi0(`kSrVOn(AEnr{-dupayxEZ<*Ut1f z!4g8Z1obtgpRPq3C4>To5nn5|+02Vsrhk7c{LleM|2Ezyl?c(w_=Rv1S7OFB&4}}B zG76OB9d$582)jlWIUx{Tp016edH4*Z*-VChz?gI<8M^alhf-__b-`@8GIN8(^QYnA ziYJpvB>PDxlPo?I&r$;HzJHNGQxRF6Hr3kJPh&TB)jE+aM_7M|)L;heq}|bv&x5QY z!@N%JoV2_O9oQa<;&3;+w3I^>kM->n{bW1soL|1FWlX-$;{W|8G>uZ0v_RbwA&Ksc zYAM1-O-ZjUVJnhCt_z7JL&gTdq`KNB5#Vz^d++$%*4tvYUd}AqLS9JtQpCNxe$FnA z(5Bpzcit?TC2Bk)ydCt8W-E%dOo&)5q-i5)_M4$X#vYJeBIc z43zlk{;^4t^cVwIrm%5h$n7gW>J`8S`@+_I1Ss+ekOvqoVpwBS9AJ~M$Oc?th*Y#j zpsm%1s;>N-$wx^LA5HFXPJ3 z(pBF}&vm}uofC@F-^#!);)sYCZ#}-Y_F$@821yN}Akg_WL*-lkhe>`>G_8j9p)mD4 zJ8X;|mz#e!Tfy4KdaB~>`ozM!yw0R}#omcQLvR=rb=&p15aD3)mq&Qv{1$w6fYB-u z4N{Lk;2&@;-~H3*@H}@au!`lDii5VPX>d4s`tUrZFlA|9r%i%MTTFD}?#}nFNj#W3 zDc%?PyYb>TCC_ytj@uXE#C%bjiK%?V1flD`{6fE)^;^EBU7R5NU|jn zs%`#o_;oUk-`KL0!F8X98IbfcvE=;goS}Q79Nn8ZXf)isd&)!H?40btBZTANOM6M ziqNgU~ym&Wx+UGXLE&JSu5F7$Z;+Pjq1m%_dkZRq_9PnNV*jhb38-9Rrp2Em~ vKY2xU=Sj`DH`qTZ{cKf7Lim4vu%1VRMe!jMmNA2i|NW|>pebK3YaRA~fl?gf diff --git a/docs/build/wallet.rs/1.0-rc.6/static/img/libraries/screenshot_faucet.png b/docs/build/wallet.rs/1.0-rc.6/static/img/libraries/screenshot_faucet.png deleted file mode 100644 index c1790c34a1fe778cc34f23be0d6594243c2e191e..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 32652 zcmeFZXH-+$7cYv(!ch)z6cGgh6~O}>K&45If{2QM)X*a$H54fUNr0#*s0gSCNbjA5 z5+D#rBA_5O)Pzt4q=Y2&1PCO#@&E3BjQ8b@_ddMw#<*|X4;gFkwa40XuDRx#<+tX} z+lOYxf+xgJ@bU2p-n)C-l8^5&n2+z!z@Nu>J%B5l!o22Cu%)p9AF}^Eg?Dqr^Oor? zKE9enfdkj0y!+!%@7f3R@d>s6{vGNJD1E}m2fujl_ATpYF7&D6k4`Vl?rcaOzjyb- z>|Z}F=3e+i;f+IUd2W5Sk_*BHJnFN6@YI8rj-K%bk2Xjl92n+QKY=+@(a+GI7B{ty zoc!a+pTG;RZmuT1+6m82yBDe%cDL=_OrkPDH+YTqL=~@#B81vC_>!d#@p$3OzaOg? z1NiIr<(pI2qK^OP;?gVi|Fj1GU$vmU>V{u&ANXU*A8YQ^Xn>|;!=>r zjZUf66=8kOr^jw?+o*d>)E=92<0|x@nJZFqp6E$y3|IroP9y(=sY$v$AuU=Wk zYU>R0X*;-&BXn-WJWD5RD6sQp-{AYuI^ED8$ zuUnb?IR#vU6%48jlPFBC@y<9V{p>kt>-6a}71757#SVTchsFI$D|ru@r*AHCcQySR z!>U%HiytSPe!!OBraGBSF#uWwQ?R@Q5y>7k^xypm3-ArK%TNu=b9qL=cXv-OB$oBX z5PLOZhSfWFpm?a=YFAkU+9TXnUnVNa?i2)R1rN+uY~`B z^jhP62@TICV&)buIA89(ri13x-kW|F(~gwSIC!rGJx~Dv?+1Od?-XLJP4pCf7X6^s3+6+);!U!jsX&tr26)G{uc*m02nEfkr;ehzRNFIGbKHcvGwSXjqsVFb;DyTW7lLt#_x5O0uzzid%M?^ zX{S>^%WGB*M0(Ia!g1xngv#T8mFYEmPY%jBQ!~^z2U?N-I!ctY64Z|R&r`*Ic_`j| zZ!nfqXfad~@e$u2O|#`&PF}T$mk^3SF>K|Po6`qWj`u{eV{YAcyuXvl7-5yXmW4uF zCx~l(lb(oRhU*>>NY)lLjx*N?u$x?K#6-1ChAQef&wBFR)bZMxxBy581v}2YG*Wcl z4POaBuOLA#tBJ`mg6DpA`%Q$|qO;@mec!A$?is&Jq%Ipg{Mu0Md@wu%?#{{C=q%N? zrU_K_vl=l*^d-_kZdYDUe^`&YSmUg_B9T&$_VEWyiqW?I^bfC_rRf6BPdLiZm)3ct z`RWj%!e9Vy`7cuV8$X-o<(7aww<2|_1{J-dXA`OO(?*kR4?LjhBkYoAF?6&uYi%s8 zqi%gfHZv|x?X2S&i<#m6*;&n-&SawRhnlRn zcB{eOGdFq#HIoH>nJ8Z(juSDKDSW1BsKIC4765}So{ZxEhe^Eqn<>AFsdfkaVJK$p zVe?jsiL-#^*Xi+H@+URD-ESt-Z-k;wip)Ed50L@}iu$L zm$^#LvVR^e(>l1>H7KkOeAZRvIAyQ{Ts35 z6ck;j#mvIM@tC=KYhP`Z;{f!xP0jVAp{6fLKcg9u4$nzTLt94)yTqE+=3yLc%*+ydmB1xY*rL=lk6OIDV!+CG_t(hniyyNc)!l1kkk)tcBV?$%6c$(RftP zZhYeMZ=J8piabT6A>Q4(P%W7-Mkpq)nZo9qnjxI9&gP92_U7W(+(VI0-T?)Fy(Dj` z^abXvW#geQ2&|r&67YD%nhkuF&Z_7qeH%^~cE+=6D$ug~_FB}8PPH{==iOF%QY&jb z$xmIt-w075^Kt7SkZJoP2B#y$qx^N+8(rk}&E z=9-j$_Lnc|Q#EM4Y4*>pD1?9P`4LdosX6t>V>f}Ix{&&5_R|`d2=?KfJq?Kyp7`dQ zB$sfckWNT-MhW88vDB1?@}rntbkJ(t)zcwTj~xeAR?dH)K5;H&-N0Ce$H2`A@6>7! z9nS7v02i6c-O6ib1ctd6$z^j)`*xR{S)6ajIZjghO;wxkrjVM(Fo6O;NJS471-M2n z8>%22xGZHs@+HEymt8T7ou17?cYV>^odX6a-RF`ShZ(r$zu%-e@wzLoxQzgFZlkLDvdN!gVS6X|Tu7Dogm0vtNu3kjPW zOX=ShgRh;2m{KZr{4uw$By6=22~q57B$jb8IeGMm#)QR>4kde}=DqztPoGX{bo|$( zyW5%F+UePta5p<@S3^?&;DRO+adg%v;P8V1lf@6MF2*wS)?-y#(olp?JmkaUXzz8= z!>vHk-!u1ert?&9saxuR4Po^-la`lAoUhW3?J>2lbE<;S`evNrVdz|1n*YHLPR9js zW9f9chpCX_jCrSPTb*Xer=J9=RH zLPk{Q1)hiZ3Z$m{*$8Owdadr%(FG@FO{xh17N-o!v%DNcNho~BrYf1o(^pQVbDP7@ z>RCwGX5hYQ>au}I_pxo0(JW2Sine48E!9Ihtk)H@Q^mDpCOB#KhjwvGW;oVh)$0rr z7e7kB6WQnae5p69ET#QQ=ds{nMDIps+_K%?)ThCkLkOH!R(zR?CGE z@S;x1BM%)y>Pu4YT0YmZDXZ zZ;D?L3VUaqfF`Fj))>bR1i%B+_A@6EGM%s+Om3a7AGSkU(?L?F1LHm(C#W^U#NQa7 zmKvK>Noc?-9+Qk1`-w(l?`zmBr#|9W@-RL5$_jT`;`gFNTAU=(=+V*qQa@w-_$I2g zDlkd$ipu)!^-QNtY(O*gXQ@T(G9k8>#p6r4QH^#gdRj(e*|1swaKD*V z`*u{x49{Y7)wRBjeck?s;s&-Gzt?TNhrZO1!onSCzSaQzkt+fJpG2K`M3whjy^%2Z zL=hf)bh8W3xgRL0Q=b1AedjNU!Wqt7kS4wDo>d4bCx@B3IYvZ%89U3~$^&60b9Nn9HTv(sP&Q#9XnRs1;F>_j5EdePtiJ#^sLL0 zd9%GqefO@KS(Q37su&RU3)eedJGDP^kYNmAs7ODBP=~)OCW9VU9*wj0VT_w{>?n0f z34v&Xah36eGyKA&*n=k; zoM%!WY0A~baUVJJi1IOAtY6hvL~TntM-851&F+;nLP?*Mk>{ZUd_V`W%*apso8SrR zeDy_s%sO*9sVa>R_=|AT+4m=O8luUN3j2l=RR2iujP6;w*6;n zV{AeF5>Nbp7V{=`xw>;bcBibnTY*&b{U(Th&5%I**kDMX!hW*a{qo$@|e5}q3=rp9D4wY*LqyadDeLu?oU|bY`$Mqa+-}X zmeRJ{F>mS+{2lv#1zK2#Ts`GIb!@GBT`z0 z&5_{zP@o74-`~k-EdzYQ&2&m21c$U#?s-QS+RUWttG1V<1=fF|G#eD-w}R#EAYUYh zg1PF62oD#O>3+!@6JfRepmeo=zh`{EHf+l^hyDtt(66Hi9wVC2yPBC7Om)9yd_R#L z*IV~qu@E`E>=Q0+5-s-S5Ng#Xsc_nU$em!KitTc3%SMlWZLwt>m`(zD8c2hC*&9}@ z=-s}qWh(8zwPJ=*>y&nS6mvK{qc5WP;Kgw_Sl^MldxU#{i8+4tp3j7|r<%+hk9{3* zM_)w8d)13nEx>_YP8uZ@>q>O}!$HYoJlLD_^eYlp1DLdRsIB7B7z_BDIDmPuE*{Wd z?k;D4WcG18)JoGmK$RmXQvOGUX?1Of^h)xfiJ%6>?Ttvd!C@CxV)&P*!R5!}Dv&#= zsta-KzT2uC;hbk%3w=pZu5D&(w^iwv;JA#w>m?>Ln)^FLr&N9#vEuEO3DONTs1$Nt z@uXbB21#P`Pp}Q@0oxuvuAqvCES1e}p+i7CD^?A^P?I*yhmyRcdBx z2H0zyPk_9%|1$@e^oJe*bi+uLzhClpzI=lEJaoeGa^Lz($YKs-2=E{<^oeEM9p?vE zCA`c{k=b?y!Gr1xCorkx>G^$>0321S}xu|zbNEV}JFdj>OCARfv))aYq$`ptoh>zc%zB2T4Z+hKkz7Qb2CYTy2 zC;4cfs@Wl}jE%x*`l>Tv#7ktC)9`Gcm+8mV8;pNAJZOY2ouEj_JtbGGE`f%GSN6_N z?sVR@!Y>H&&!BACS)N87?BK#r(WZ7=hC?P+eW9jg+M2z-FKDue%SR29Grb&kooekCNok8_PM#)AsHm7a{}QM?9E35pa9Pf zE=*VP;+>z0uO}`Hu5>GyE|0t9)ds2hN=s~7yHLz4jmb=R=eU7Q6@QCsx5XpBJ~J zEhT#As{lp_DtKqB>7GiQO)d7bpG$F=K2!0c27U*i)V1Mwx&~BT#pu=a0LQ>uD#B7c z(EEG5)xl-|2_7ri9QIftX_^oBo`>I7x+fmo_As780fM`R1;VCFU=!-qHeU4n@N`F@ zfJ6WFKId#IaD5b*M@#08R;^_f>rBpTvDw22g#rdIg|0iSkBYHPYsha0+eWMH z?dd?eT2JQK_c)hzMuq1{9Sl|RLxo0@fjJ0i)3Zf~oDTwR!?SH8SUh}p)4lKRR_D=E z#>=Z^=;fC`{BD=`5_Q734kQB7n=SsdRWO}{DoA!9EY0}HKhWG~^XoN^R2kpZVpw8B zjj0i~l}u0KidKr3jNBK(ZghXd(`ZoY9hbnkY;2G8UAwH^CDF1l>I-702 zwj5`G_ZJkeGA=&2ISWnKg00W@@{k=nwCcTR;Rne5@Woqo5x8m>KaFi>Kr@}MPr)GyG`$EnYg8iE<0cj7pB#j%3O-S~xpx*ATFV-rU-%Uvd zzoloI9TL;=>gd5^#Ispp?VZ5~_~|#_PGY!ej%tB71zbdUUg+3UiOb_TP0KSax_T`W z`_YMmlvqu@Qv2i49Tb{XyUGV(1jZo4(2?q3&+H~_n|TdTGYnH}2?Ie!TPyw;E4-q{G-v?Wa~kR7gvS&WJKl}N$gcWl46>i#gO&AtjROe#YIrg9HT zm({CzW>vp}%1xQxmQocMR$usN?=Te8s`(*D!x691>Jz1^AJF(@r5zK-jM2_Eud!|6 zG|HL!T`qb(-f}nWfa2a)g*N6Lk3Nr#u8v^>Q%dM3#X5MWSU$JbpmLWP^pZnSeO=@{ zT3Z8UvOOwrM`GDgHZYs~$FT;}O%O4mE#Gd@NyK;G&SY753mYP1XhlDmPu zq7JAt|4XFBgQKJSWZdzT%HDTDD18ABX7IyDD?5=ReIl3q&7BUAE)J)0))k7AxoK7) z;^Zm(s)<%;%PNj*i)Hp^LFrwNAzV?JUa8pft3BAfrjwFQpZ&g+-~qVny5G`Bi`^5w z!I2wltTtWJPIk+!B!Unq0~Z0@>9<>qrQRr#ifmZrd^bvu*pk;qRAm%6v{}rDWMnM@ zRyhl3^;!w^P2LtE8rvD}E2`Mux*ca~5HXeG=JUY7(&-x_>3g?IKwPzLUSCfCuufiH z{@OoTYX3Gan-4uNNF<)cFIL)@3fpRI#o;Dyl8GUG0#t~qnFt()^4H;d#nZqEun3^w zIXxHB!JLnC@Ebs!Rps{{bb~kb5%XOb<3JZbC-Ib-45eo)LRtf5)HXlliEBlCmNUZ` z4VRpklp1SL8Ip)I#OGq{6c=$7VFm=mbU_GrLv87w=F^xYN^)LGe@MV0j*P zqR0!X+21?larMyt3en3Co~cp;AhK!cTvrTez~3-ih~l0_qd`rqWddta$SZY`%G zmcBe}PVr|Q;=8&1o6EGT$$tl4%g##jG{Fqgj=Nh$dYV3<@gS#G@A zWCL$uJ;<6?aa3L1uTOZ>61n+J0z$4^Px+eCB4=uAUuY`PhEBb{`sGdbIm3{1dEjDw z#3;8SJR+#GF`bnAD0WCj+dPf?^Vc{*^;yJPVBeq3l4v_H`iv$!IFh&B{oeC7SL%p~ zq0n}0Bv{k4A@^vB9a*9wW=DbCoFhaV>Q(|bNbH8k8DMhJn`%3tL@G;XO(0x17q)ae zWG5T-AV5VBYZDM4IArd>@e&xBxF4WzC?gZlqu4c~lW0!d5Ci1q0Q5nsOZAKT^$)|d zHP+T+BM-Ae!L6QRdhW7hx$XVrGYa4&M=xG3;1I)OM{LH_F!ps=heg9P?=8n%nqNRp zOl-lclhJAy$W?VIFGC{NZ_(E#9rh{rv0E;?ZmUB-kpC!7?)LR9Q>sUkJ;AFZ{17$@ z!pI(rQRs23#zsz97#j#gU*aj1;{{%jaChi~oAGP7ihcieJ%A4O90Dvlt{ae&4O#(4 ziX=$pjo9J@ufrA$`kdy04!OS5x=IPl_0@U{RS`g8v$*BanxzZQK@1}d*Bt#!PkFp^ zqyn<#1&4|xCtHueDxTN}20p9sEF8PcSX~v~uSGA_>ptwbA}>3~91j#Ttz50I+2|}{ z4Gyx?8P4$EYw)%@Ci2q4&-svBcAn>%&8X~QK&l2}=k|orzFXp*5aXGBuPkR^=Q&ux zb#q01`_el&V~pzpC4J9(Q6EFEw#!IW89squJXhEyJXzkAnw9tV%9jCOm{VP%wRdo| zxtf{0v-W;FuJ?gEX%8D3+Dw_vioMM<=@l*QuF7_~j7db15ZiGA}O7Rr;G)9dKD_$Qz(5 z+X697gVI<4ukOqk+yjgO*~D{Yi3BJ+H^H{R9Z$_HJ09t{r-8{#hI;xx6F(O`mE~}D zsLKe^$qy&W%pAur=WwSD5Pq>LUywz$2766LQQtKmeTcao^Qrr>Qktq_etZ0%HG%i( zBt_l7CaSL30d*dw`ni;fd8loEAE{v~9=`JmZa&R4fs`=gfcvb>(i7+$%yB^A!>gOJ8jy!FBQZ2`OK1K;8)hN@~%= z$9V-UUedg{T$LFY8-Tk!*Yh?RAtqvaNt z(H$#tQsI=@ZnnREu$SUY8_!6aa7)nb4eEDGq$kYfqY!2rW#X!?*1KUZm7EKkBvyQ1 z`Z&rxDhi475}eRAClIdPy0Y8f`00U&lN6DWsBsGE+cW+l@8lsJ^F-4qyTm?I(qh|* z{Jza@5i652HPIu=6C@$^|u_YI44x9>mJ2j9Bq4DV^4ReI%o zXPGuIamFv~pd`X^{-8Xm`9YY|9=~b0+ecg9`p%hGB*7lF`N4fP%IkGU!_Lgm%sZi5 ziZ8~V6)}Z`8^{41#~pnwE0vb(j;hmFg+=~xMKR)k z(*sByRMdaqJ^$*kBx>i0(|9#8c89mrSsRtv}E=9vs%!T~T z%|7vrl*-q4Ta}$?mH^ua)?bhF4{gG)1S6_N436l7rx8s@xgMCv%=f&jYQQ*yY z-F6@Q^3t_#FZ*`fsQU-y-G!{he4UoCAI106u38MQ`8|FJF0Sp1Q&UwdJtxwUSUxY1 zK^+J#HPgO$kkTT$rZn;{ay_d@UdC*&ekpd%Bu-Xn=$qmdA1B4oxlh_GUv^;k4Z#hn z>9x(5ii}QyOE1$!Cv4o5cgt1-`nTvB21!>y)}9YhmWldSfVaC5vOKE><5{&C6I#hI zG9!OSs_Aa(d;iDF*Ik#pXQs>Tt#CkY>OX6u`%^vw?RZC}s8TbqPrwT~wfDMFAS&{=(BBG&l4x9+$(Fpv(h+NptiamrL@2KWdA5B2kK1WmsY)hPWOI^ zr0B`ENio-qy#`XR*i7&TGi~HKkl@2lWqZM?-hMwMv*isFh~5Pm({4q2DZv18E^W$1 zPd_h1NC)?}^ZF;f2Jjh5mazWtoM1Q--687C@7?z1miEf4jr3=e4~tR)1|}1MJ}5k4 z18cmzJ%4O8vQnV0Wvy?RKTgBTFDCrk&hVGR`)Lr#lHuM!@xP@5D|O`3_+XhG+rAf^ zGUjpNdj{C8X@g)|Trze@cLx`(RvVxq8M>_*GJZqktGI){rE76Y#6jNl7f+(qmlD|= zG4JQcCk^@2wkVDBYOWz${RIbz#V<;lg!Puj~3bVU3;$R_b#>!_R-t-y(?TXLH7wDX6Du zF66US8%x5#I3X}%Nm7yk29c@r-hQA8Z|NnI!~E2IH_W~a0+ZnPI>@$?Gzl^4mJgFT zJyDhvBSfv(Fl6S8ix7UT|+|!Z?6|lJOmQ$|yeaJSc4N8e??9;lo1WI}Q8AOKZup(9Hrw z`L=O=;^O&?$D$+QvuEWyot~saa3709xR*i#7S60PV;w+_$Yv$F!g#alLIta3qI+73 zuvlhIY_oyNB5of)%)hc3+zTUX$!upG8e+Lq)%{!((n^{W06p*-or^|Y9uI1dznI>4 zF}7Hq?-)K zz$vfyI|UkGSazRgFMb`=cxQ2<$sPsh8!Vnv2=3@C_rzOgK_7r*GrIg?;Tz(UZiyQ7 z(uX-84M#l?Qsvj!a|e`*C(zWSqZ4(P2)$z$?@U2u?~-M^8HujL34I!C zjWBSClZky8UN+CzQ&#khykbYg`R#`eUWx`kz*aca-J{ICFN}oq>JK}GS9}#9EybMc zp%U{aXrMJii1u`m?ruGcr$9;wHv)kZ8g`CKlMQ<%=I&|2M-9re#DAN@318=T+Osk&WXM}vKR z>FcL(t-YpZ#Z71%nHj{hE8g}KpO8ypr@u(&b6A6o19D~e-TS$g0UjM*ytP*Fz1 z*aCQ#R_|ar*hRA{yWV3k4e}|o_8%ATv-gW)()SCdW)APK=olAu>*yW0p}TbSYwo>W z5wXheZTpFBb&O(`p9-7q=*aL3RUj1~2)Xp6uRv9<66#ys#=a7~Mc`-n_>>HL#F=k1 zU!IMeFSJPCrdu;A6h=R(XmmN9dfhW!DXe-wIb{8zskUcn!acPuB?sv!c+Kqr61E^ zqI0pi{@sem2m#Z9gMUFs-^y#x-xe96ec$5tZYY}!p=lc$ORhmt3DcR)7T-CSK7}ix z+|;HU(#N*y^6##xjQvacvneWWnovG+%a}Yr0_3L)rJZSOP)l5MjitS=vriOg;((op z?#)O0t#uRM?--)#WozL&MGFcPNUkz~`!uoyUU{On_j?1pUxVGUm7G%c710Ae?(=N# zO)zBck)%(*%|yqDwUXYI75(h^mK0e>wTTvf-|L5HI*WRbhPtrHPS!5e`f`(g;^X8m zZt#KJA31D026d|Iz%h>@0mcT8Ht0E0JUr*DVCnPVp~OhIJr!#_QtOIv0a@gC>mLp& z3fJpjl`g1!{{Xv00I{=G+s;dGjpq!bE$uH>fx}ti=oVIZ59sN$%%H7`gEIBD83A#v z7(sTX#)ju1zJcq!&|GASwKMqhbnwaa>o*OX(@(xGs#hL3td*fbO|p^IUOp0ha$_pb z=dI+bUW<;^vx0gd)zEZs;aF6(dUJwvfj*;zg6S#4TL5-VPPLLXjdrZ?8#?A+69lx&Hi z?6!tNYwt*ne|Pdo0gsNq5om#sSwl`Bh{S-o3_b8I6?v@y)96?(J~ZMc@`g^faWp?`5y?NG3dSFaN3 zAki0G(DW4$_=Yu>>M8<>9|F828Bc(95FAx4e{MbsVrG>9JoU!aR@_Hw~b)tUI zw5Gi7njiLz|GVKa)dzpxaDPq?6**GHcoC^SGQ<2by@YB5-ft;C#41;OTyT7bBzi3b=YJ&CK7t@M(srJ=wjbNCS~#Q~em5WO zD-(K}^`cwn>MZ6P#6ZK}?>{aY6xCWQ4mEgnIQFQ~lMwX|(&Fh= zxg##VHr}J2CTa}PeY;|F8pGE;xtms-(3D&A;@UuciO|YpEdJA2IJZo zBIZ$rb(3>sgp;0Fxv0Wbl1(>ZP}P58@tO*VX;$eV_Ds}f^-O+YzsAX3XjnP-kH)f2 zIRnd*Bk-TQu(t1edon0Hy=Piz`h(6XL*bEghjru|3h$ce z&+w98><~9_ zw(*?#9%pZ^&nPZS zf3xu#ho2K|Y^c|@hc>W14Q7A(!<`r`Q0N@c;vCu3w7Y%h_IgQ}dHfjj%NqjfY~VEy z|KL9B(?Rt(Y+W|P!BkJ95BTuWaAg3nDeTtx;HvYdPjt|_=~I+gs9Aw@xF78-t#7Mz zem9jKcu`kNzHs3(G7bl^%YPi^P8B3wd?mRgxfUhkXX3RSrCyJ2>DONWa*{O|9!vcc zh*fX2N)94=C{E>!=l-l$MubCpLYsyED1+VQcsKE64e@!hcZV?Qzv3YbFWPaqv53LT z$u(?h4gLUAu>3TOn*E=70l-KAY8J{gwah2)F(fXn9Y$IghxaEhs_S??lBo&sLk{`f zK>Rb1q5LOe^i*ol{p6a4Q1hEdd(g{Cv=a<*pMYRB!n{P+MT9k{Mo~$)$q1SnYJG*A zAh(;*c4WkP)Er$~{JL5{o};U_olg5s_=7Lk;+6Vs#HI=szlp280jkl%RG909DXXi2 zHa{Rm}EZ8D}}>58f(%=G!3y~f!I)~8t6io~WL_BDeVT_X^ILdf$3@xQN#E>han zf+;}z^4_C8y|{lF08~o31-mz>If!wuxXGd7-+_0+Dd`lDkLz8jAR)8lE|Ko3%renE z5Ar)_huX^OX@TyTMAMc}^wF&2Hlw7ceGfl0nVR%|&sW&2f9#EG`se+yYrD`@E6b59 ze%YueY3iygm9&o1ks~ajAF!nbmyQitc$7eJ#?*D#*!UwFcLK#@7)m&EV+{s z(AG45$>ypU z#-_2m?{Lhg8-n7lcV7LqL&++fHZr0PMz-W}Ci zu%_g+ip4#)c7~srf*(6n$*#!|d|!Lz>+E3&>td+1+ei^yOci@Gr|QSZ%et)Y$_E2) zWca-&4}Aoxy%itOv@M$0s(ZGeq2!WP@$$3TedTGyDel>rRd9P}G0M_S;B$?vxd702 zxZ!MYrAYhEgjKmII4D^OWgffz@Dq1@nY+1`PHy%jY1=JgmFen65bb%im`Dnxi{Yr=q(h z1&bwVE0VB8fxd=ORT~lWvllX6%Zx@%za2lx!jRM2`g;m_Cg|kSa|zN|xI`cl*#!(l z--alcm+Av`7zvCWa^{taE$i%Y`>f4w8}chQn3h=z(G^}Tco7O;fho;fs;Sjmk{v_6 zXH%JHQ~p81UY7R~Y#)pfqD8}Xdux_S&e1!keGuV@rL>%q?-il{U>gf!;>9abcVf5} z7dF|gg}RX~b$5;Ar$SgikVr=N+j~RVG+*~$blbK=SW%2XmZd^6zTPgQAuagnsM$g& zJ>P{Fj%rf>gb@Ol4nh&i@j$#;b24ZZulePwdZQt3NHx@__1(WpGbao5yB3#-G~1P% z!IjpXuovW7ox7rC{zXydq1wrO1~{UdBlCRi`?zj;``B>Wh#A zNwMEZNOjeJ5s^TN%fCBrUv&6i93uJeg#NGE|3D}=D=Mygl2-3m{d#biFLyyZLhwHW%W0m&fBNu-3GeHWIIBmi;g>4&Y{>n$d64A(Y?w+l_xJqtR7{8{-1v!dK*m(gG}865P1dO(%bhN0PG51a_~MOxGWA9 zg&*0D|4)rjpMhOFu+1F~b1(t?DHXPIU=9Bx-wF6#mKDugY_BtI;se&nJt17)dmyM4 z?-O8O7RPtO*YrAp&2j(F8({I(F;$f>MOCONJ#tNsGKtuq!s)E=Y|T6({k3Adp|yLq zek4;^d*K1hWZ|+ivop=XVcGOuW@vX+31v9TqXjFu^_hRW^4!5L4wUXq@Gf)w3S8TM zjL2X#D(jGDh=yxE&TljR_Rp}N_T6gf1eW(&_YmneFsiUE+ z%g(#0d*hbg#pL*SoY1^-B(4(+ z_#mRVyFX{nKR#l|)0y$ZlsnRVYq=cwIz@lW(Ui4zVM=x0TPZT^9WH67R!;8*=%|O! zxSA@x=OlE*biZPi!p)PLQZx0|GrKmgJbK(CTg0D@A}rzg z?7kba8CPo`ryZ9Q@K|YEOMmpNyFOj5z;65tQnUerAlEWxn<)x9><5u0__B1r$fe8z z8zw&71)P;swj>A0^@KSU0^#s?tj=@`3DPp+(_>R^ykDN`eqfhcq_4rEqj%c$C1MyJ zfub!jd$rAP1b!edJrHTc_-wy5OkVE?KvoG-1ICe6#0t2!Vd$_rPXfm$uVvxV46d?b$OQ(>8GrsbB`b=W2%)Xf{XRHD z=DZ6&ujgoPzr(6r^-UkF&j7zrK<5mXn;ZC4<~dzwBz7)?04m*cYUmUY7~_D)Xd z$5l+wXX{TTwL$RO;jg+%)5t+YM$ANQ_o%K6zJy{Pp>hyv!JCuXIafiDX>4{Lte;+@ zg~!@p$kr;1w0E`knQ$&6DFWl*?sg5-iRwD#0Xp^R-9dJ8V zh}!t?O_t#Tz!l~>BPeE|^3p{!P4?4jf87r5DO9;HmOXZCD%-Y94JF;a4kF}Gg$NtDD?IsPK z^Kg^~Hb&}4KGB>C{+=hE{mZ-x*xvcL6(F|!OG%Ixuv~L}RKR?>s#E!VuG#bmi{3i` z;(kP2(Xf`6>7cExXG7Q1^TcVKU)H5X!$4|rxTwP;m!V^M7FMP(y#^X%_IvTV>t$A7KaYh4UGACgshNfhk8vhV8gFU>|( z_!b+qipGSW?;e(HCXq*tdc-~Lbb`;K+v!P5jh*pS_04;D$D&FV;!3V(-%)cMfZVM@ zYACnUgLK-70#*Q%uOFK`?@oLOOcWx{^r`PIN9#1l{qWODE*`q_1p33Mm1TpOJA>+@ zp7Fs5nq>f~o#x4H7P7^Vz{!7!@C`f&RS7FE;Qif7520N{qjjq?7pE|&V{e54o za=1y_ma+*tUo;16D^V}4S*o3W0B^Bthu>&>0Jt9zuS60RMhx>W&egk~Ttb{19?;il z;c7wID(5gzSUzXLr6LcbRCN2w4BArQ5}~L!#58;&ljQ2NX3~@FMcJwdnLIe_92rX{ z#TqYzj8}<%!U*Da?+^OwYwaB4o>6$edW1_o%}G5-HDpGTxfJqZ6*ZFp@>od}^&xFU zPhEpmgWmSTeCx0G7XBp?VeT?+k+im%xOA~-wcgo>P*W#}nFF|MZyKx}z!sJjrVi|$ za@3<-)R?%Db>7FF1olnmwJ^c+YlE?|^v?dCQ++U(%oyR?o`scYxbn!|VBI86(;%XZ zvEap;(V)(KU&IbdALbi;ULErf+Ng?9_Hg{<;>)&U)gKM(wq|kZG;>IhLf!oh@rdW3 zD#ANS=wr{yDCiKMmHZ&m*+#nra#mY~XB9JHdD^HV*J)_z`XLPqkQBtEm@>D(Ss+b`MgpK?-aYCel z5Z^m--o{al9etm@yM0KUy0(>Qde;fg_<6@sP+aGXV9(%7mENOs>;BqZ{$Y1L<5k^C zs=7AhNQy=!Gmn+$qI3+R=Y8ud5*{Q^Pg9(=l$~AjEA_jygP*6Jec+fReKG|M-fgn> zX@xD$1wGVsj(qSgO{%2TGb3&~)|gUw1pVyrrG7`%;=D-Tr`+KN%5>i~3?~Up>U7e%ncXY4l}Q`X?&;P}l36I)f>oXhm>mdO<(}`6GV@ zgRa&Z=J`Vdv)37HP}?v6?@--$xzj>`2U}9?7`a47KYlhgJ*U4s$bDfPqQO&u1Kh{} z?B{gmel})iO`M~J{8)irN?(HC7S8gAtD#Vg_s1;?2)bkVjC`e#VJ);&5o1Ph3dA?I z^C$StV+qI%ghP)vLABVvXuJ)1rwcZ<+rNaBAmqxR>zWr)dZM9W*wX|&2VV9z+=3Q!Rl~QV+B4||%F;q#+Nl~5D)DlxoZDWdv zAreC9q*}8GK?JR$5}}5~7|x@6|KIhVbw0f7tn=l3%36`Q?_BqFU)S%NeorVWGwMJ_ zM!*G#cp&AARs?d7{z6}km}u2>v)~ZEeyzk;2w1n z*aDoNMMBIM;8#7%T?vlHC`gP$S@pPSUlCjbC1i5*viqCBaVD-qbfxV$EC6$DO^y0nRh&SIaX9pS3-w_l4jPiCr`4M9XpPt~40@lx3X1KlF=3Ehh2c4# zl4TVJzSEo#iTY1N1w+CH`j5Zo`U+5HAH6BXV702c9~N}Lv98_(l{bmReC_l~Fq+O2 zPtTcgZi|5Kml|n%SnP$>lHi#2)_*-EktXy-GEn&*O~OuQxv3#H)D{vqzizEHu*G;a z9}`S`#bEQAhIq~E16}R4%T6MBwk&hb1ED&x8}+4qCTI5N@?1f0?6vLHwfSrP z-Wn{V-fIZ`8l&d}trsB?G_c~4I~_ds8k0Wl0+YNnW0a8Rm~?(drevb&03lNYT7-n& zLRVhgWV#HxV$ya5QRUItQM?H=t+Y>d&OP9u^r0b}JQTBiCZ`c3lY0_wxq)KIkz zjx%cuRdjk5Z(xT`dLm4@*e36!AC=1+3Vlh-)CR1qcl-Xn`sy&Jm7Bf zgZY=3EBm~|b|iy?+{QX`#alvdhi=+RaR}rDs%ukB;lYuMJ+3}$5@K>Yv*t=77t|?~ z(0N<5WLOS6U{2kXiG1zjWoqqi?^zHbM}k*IR*|3tO6XdVB}RU zCMcd&7Pwr~N#JefuwqVJi{H${5M{BK7nhL7cx)a+B`Chb}Y zLex54Cst6zf;sqe;@&^9ckKOEtaa5d6#4!~do?5HwN}O`Z#Tj98_7ic$_FEI9@The z#FH^&#oHt@LX(dN>9_oN9}-U|maDg%Hoi%pfrZH=(U09r47;)rkTwF<;p^oC!lb3S z)-;~iTK_Hi>1URGKWtyXEHfH@;C1(|Es0OFgwFmDY!g)4%RLRRm=7Zjv;-^@APT2Bkf19;ctca1&PS_ zJFi9+T(2(R)w9HWmjJx=1G4pTU~I;8c*7$&!%~t~vVp=^k6Q#wXjr!I*;o_`9^tw@ z6h0l}j-Rc&QGi>Or6;0?8=tSN#Y|sfs2NCPh%;Sxz71{(w=T|7;Wg28=fTG90OGxMk8QZI42JCc{$ zs~%ODS2X;*KowN}{-X||8%lq$(VcO~cRk1E*z1lK4JR;r{cn#4+X4BT@qxn+d&=~9 zTe)}6RBD0mnli0IgagPp6BuOKohGT0wl;Oy2}zhP7NbeHv+; ze6WU9_wM7?NpGwYOgcWCsXgOIMFMI$`ctft^~v%q>AgTv7isu%0(v$<1R>i?cGSIW zrf6ACIVu`G3tnk^!(3q{_uZB+jWF~UyA<%~#3|o81yKJ^4tmo}EVQSUpAj6m z)#UR%rc7udmXp6JLMEy&@+!wB!2pBS`RW;ul#R@w6|$0pV}WnC*k%(+WH3SQlL9Nz zX!*q8P!#9^cjO?Sdg1ZRms@CjnWLB5VBp&eb4Wc=W}m9L4QCV;7Ig$Wd?oPUTto6lJv*yu^>fogtB< zvv-z-o3<^Da%y^#OzDLf{fgeSncjVfa5Gv_muSDe&siSe*ccSD{z3@5sVR0pk|ef5D~>SKIj1Eo$8)}{aS z%`IKdM8sEQ5)L&HqbUcii@A`5Q*-?h@+5?q>l>bu)8jqdBW9nSSSJE$x^y+Bv(?3^ zO_SS~-a~!B_I&Wzm+R2gH@!C)@x%Q)kKSgff6f_POZf5R==8JUrv66V-Z8EZB!Z_e zdzAq9{#_78x!EP!K8o)Z?mmxIcif427+TrDCb~h~3lymRyhuNcF7brvK+^URHhcLZ zuI&<6&7ufr4A!lDm=}^So9B3|BfDVM_tFN`UZSf;DI(<{b)5A%6ZZ5vb)tGZ!Y-yy z<~A%1lDo|O9M5(ac~+jcF|nf>Y7D8EZ-Dr~5d7pzS{UO zIc(Njhhr67fw)M>r@iz0LB^_dMFc@{Y(4}2xkjO%87NJj+F9OG2sw`(Gwu1VBAPsg zuI>IU&^shA^y81>MZv)bPqsoC(I57Lx4wxls43_6bLtza8h)0ZfQ|W;jcSm%q#kvz zSe|Wog6j4Q^rKGYZ@IEV?oIOA_Z~NtZuvK=ws$5x8Ga->r{oSk%$PA5ok=r7I7bmp z2ZHIIr6g_x$}Ueu^O{U&PkF@r&Z0}$%cr`sk;kOFQW|*C7C&N&1UZ8@1x;}=FDuX2 zmbN$b)UI55mDs?iE)nNxyV9R^Sa%ymCaLzUiqI9jlB>zrf_^%!)huho#O5^^MNGH< z3=Y{7!TLJwVHZG+nXZ@dzM#hl?&<0Ee_`4*b|LD=n;_ZJ9tjHEHo1(H@o=G z*P2|4+${5FWKx}pd4ZNEqjH@-uiMX!bDd&3oZftu&lyFV^)$`2?9X*%-VU*jS$5q7 z0#Zw02F+8AH%ruVxOp=wBC+`Ur`fUEE8PPdZpat=%^143Rm>i%v_)A~77v#X3@!WI zZP{c!o4mcUVdCuKk&<=^SG;vE))JVCyVl*XzZ0SZqmzO4)#XnPVTsle8|f!nw8O5 zBrDlO1qkv<9^z^WMIRMu@pwEY14c(JXiDg6RZunPhdJBWGwLI}Kd1|D&d6VvOTtTt zG^ZDlW{LwPw^||6z89RHZ`%~|cT1MGS>k4J`HX{ux{iM-c#_Cyuj=j`nzbn7ZzE5J zdqd;w3PzAwmT#=RBf*teG7DMsTfG%t8yHn#-J?f)UfQQ$QxG=7TaUlU31Rn?zo)vvuhSrr5O$dHc>^A-YtCxZ zPYnIai3z<~Vw5*EzIXLT$%ULS&bxVsPa8B}^(EJhmwGp9n~%P3V>Hy=m_b5PKD={F z30L94Cb2Q0^O~Ek;>^#pjj+C>S3*5~9*GV_YF4F)SS+J-XC&e|;R}a(KM#f=80nQ! z%jA&Db6HyUaS=-8t91VbWn)Qyw}Plq_JgFCwt*W(Ia-zN`m&0g4?Q}}vD}BVMq!|Q zTr+L_LAh{CL1{nD8}ld|zPw-T8JIR_(K~^l_aL%YW6!k1l60?4H?<#QnBc(Fmb8${ z*kz`?MwP2*9>P)r?DQP>x)X|AqDzNH@axaTSn4}1Bje zl9b+_#ZSy+V}v##1vyW9-N$ZYex~GU)AqqPNnJ8SA6E&c>^f;a9|OVWBU0G1u9hPJ za}@P`=578>x&Qn6VQ;y1=ud!E)1YzUKP9r(pThin_u;JzZXP?vP5^<%F&03Ibszrj zKX23^8HrOBKqCiuXuJVmv1e2H0;Z4oP3Q0skWq(n!?3(OVUL~Gvl=7&Vnz7w6RueC zH=p>GvMn62&#r}rp&joP0}VL$2sD$Zj@P_rl0?0|?xO#xzm1mu+c^F|rEmX-znA_R z1R1&E))#mb(fbIBuf`Us_ePys2%aKkV>X(*C5GTy+qTbjgcZywi(Vx2ME73eKw z+sJqwH|)awUq#IJ?Svk+!G6E!N3Hmn%80Q;O`gnW`dvi_jPz&C&lZCrUN!#+?! z`Zg8ocr$OKYY!6@IHMSxNHtx_q*sc12lkbhcWZNiOwruUr1VS3va!ze{W6zaN&xQE z-)qeanlg$;PkF9LH>%wt{OEGLM`b^-)@~;19{?CPAh>T1LGpt|{Li;k__%U-fWD;8 zx$QKa#!50ypuBxYTG~>{355V-i=9B{s8;z}@7J6=ZPF+o2>w*p@0)vWvhHQL9ff{E z`E-qJ1RfnOR<7-QzDOxn0`Y=@s=Ai;@?LHbP-OJFQ_<~cXcm^IQrS51n81^=8P6;tQ?{Q0J zQ+Vl4RC9kLB*l~IRrT)%$p!jra3EaMA8?14WV5&$l>spIe z+EO>sd2S2qyW|^BuZ<>`M?p|=kofsuC;FeRZ?XW^GUk$y4=}Z z*d0aUBdu{`ehmIjU!<2`BdS8to?>_bsQUc#i`DtV$>|4z<%8wch%tc6R20;x4=1M|I8=u*L(?j>zCcn%FAn? z9_Tt;Wampa%eZ{EYBfT0`ER60MGYZPR5*Hyb)%38jBD^BWb-@-FEUH;&+l-qKZpA> zD)!dCYw!Fs;J`h%p1(NHu+(CaVTikeebs4q=j}Il7tNA0pKsDpb+@#e8`slVBgTTj zVLs|uLL&rO?fs34XM-|Pce1P+!gC$wR5q6we`w1V*_l&V4FS6)(oJ0;^45-&c~hG* ze>$ME_XT&^ovU^SYy*4uh2P#=#wmi1S5Usj+X!7X$$I8Rag0VZ-xymy>NAY8X|2Z9buWTbW&7XM?R@45^%}-s?OEfZi&Mz5QaG>i1yp+ zV`ShN-9(pVb1~S`(4MC$Y}^ZzFo(sBP>UEvlXY+-v~$8qIoU$0>3wQYb|1g2xg8{TdM z-4_l=CFq8Yn6)loxH_t;C4{};#kMWIH&Bp~4A79q=iqZZBXJzF2 z?D>n^89qj!wyc9p1LY5ZPi%KX|KlqNYJdFWX_Wll(g1oQ_WOr~_cqJs#sB3#Gk7O7 z=(;UzPFm{zX!480k^*LY>b`{@zpu-6ijXwuLIa8b~iF& zbelFnqn5glTb-+X-Q_jxCig z6F}!ZWHxA-l({;}^YhDzWP|eWL{+1Y@YD@ibI%P^@88o9;aU2745;mj^8Gp3OC$O2 z)bHYW11zcRCv*=0yC7Faba!58(zacs3*Go_-q2gF`|!WAZk;!yeek>nuhfSuoR0|- z2ex{j%f+m|DKpyN2&S|QvxxUdGhuS_Ga*Vg3A}r?rsTw@1vdG>xYA0 z`X9Khf3@r_?6P-Y2P^p!bhZbpzD%2IzP=HWeGW%inrZ0P@AX3R^JJdEy^-bV*nKMA6g@4j9mI|p{R5Vb`34gpY zH;fQ4z|gI&Dm3VDKS%2)`o&XEmqWlar-Z%9ki*%>Z@qB3>MS36n``@ zVc*ELVCRHQ*AWz0VEdR<|<#Y*IT z<)&-&D)*Pd!%o2h{8GUo>2oX<2*b5WSR-5uChYuI3?8Di0MHIc(>3iudJ`rnw5{EaCUl4nB;!^x>&1tRkv0j*$X%j(eIz@2FM zY7?W*^JSM+2mx=OSGSH>rY|~xVVgl#Bb+E0a=#;qpa#M@2f(g(0G6HY(E@c=n+iIS z*16LiS783Z?2Y?2c%$u*S`V@Fviz7joyq+PqVSyEVtRdMTPM4=o)p`h4Y=4Zdhr%6 z^o9DGF%k@Mg|TR}l*$k2fev(aP}FP04*x7=+s1Lz+q;&Lorvz3j_OAsnuk*iZQ}AA zPIYC=@g~%eS*7(NRM{V;n`5_z`)#3~^PC%{u{NZ*Mq5_73XbSpQZw7Vtc!NnYCbgtIK3 z5ka_ft?{_~HnRuCK0|UBWz~}w{Nt$mXSIBb)l+5&Ig7GY z7LvYkc|x`yw9Ps?!|4=Ai96vFw))EjX`k&cTCAP7=L?{NjiV3L)cofD2(0O+cP?v* zQKqvl4)KB@pzUxz_ZV(Rh5mSzg)q&Fv|w3#I!N5#GUlCBKj#Nb0{Z1;b}DlQVks*W+h~#c{ z8_BhjVNP!Tz?6~;fqGwXWzj`f|B)a&ne7pkdi;4GQ#B2s-ye&?yWN&st^{?K$sb9rBu2Qyl31v%HRZ&DuGEAdz10pwW12 z*Z1RxcpYeV@t{Jn@_HzvPR~8l1xS4U3|RkD?*0jkudQXio>O+wN`MYe zB_D+^^}@Qp&YW+w#cfYr2pF&GepaUh(JV~BXEjtCrY^NP3M#hXg%s~JNe3hh27LYG zNMr9s4B+TBZ*CLs9Wb|Za&S`{+uDU2d`jN$N2D~dFwI*5FXi1#QN=GK z6KLblhnyUe~G2sTb}+J5_|5d zEz_&jcw?a-Nqf<)4`8HMqAoICy~vloXcH$CV4^1%@OVx{ z)je`vS8c}y=Z4YxEG-+t(foi2N>%OX(Piw@MsE0tb#MH6&dYdZ|E02);bLBGt%&^rW;7kS_Ay&vNqy1Ik zVRTXVSP<*oM%=IwGmwzV&ff7SziBc`n6`FiJfBWlIM#0n)^5evwhb{w0QNQjcixZb zhD)l3P3;#Ogp=-j3V0Qkab7A(t&GIC^d};l7@~e|sWtqX#~LUdSL#?A*E_^)hzU{) zJ?<=r>&xzI-`p6ej0`TS?eJ6v%3e@Ii?Nma@=%Ez`1$*|9Hn2+HR0oC1Mqkwlr2t^ zMp|dngwup?oXT+-2U}N)x@DD@X}K3=>_m+VpqYGL@h>rS0e^;~G-y9e2V|A=9+O-2 zm_*dp`jlbFI5L2iuJJPTO{htHYEPg)RPUf0+>U-}V_{mWCARn{j&Y-`@l>rUz)spf@)m zm$6BTnT_{7OX!P++fOPUq26sYO-YvLQnqI53XQ2eihEIRbK|{~10C&KD145{$Q0>g zTLTKujcJ2^}Bx-Fjp;PKiZgeB7xK6p8ws{qGmhBK7{epV;a(#JNK=ev+aN)Q;K z5a>5*cwTehXjZC&z5Ud*@btnlsn_2v7oTc*#nZ7E^_?Lsph%ime<8n9E`ZR1-^Cej z+)|11UVpSu--DhCq`N38CuE5DOwU~dn^V)LrZ0)3P>rggN!;=8mch)I9zhZ6FtyX? zpjg>M)^h(1CtZF0Y|a(!&9+;gH$y%XQE*GN22`{Q(@Zt#FQ7b}N`xN1X*D#=o3Le^ zo=OqLG!Dm+hEszWoK<8hqyQt8E0Ov_3I zJToIZ(qf{laRr5|U5U4gL7Q7@DBkmmVbv00Bi+{i$4U8F2UVEQd;40Zs<)>Ce6=L} z3Ef?fEH#CP0sek`(f<+U3<(0kr>l7mJGn*UP1mNuF35)a4_m!(Wm-x5FwaR1_CBvO zm#R|0aO*F+xK=j~x&j6@{ZE;agMgxWym$KztpDqG{KP4vS&+@6g-3NGAFh1(07Q`8 znp59>2L@j6CZJb!_7seG zy2Y)wdBc1&8~?uMfc-FOUD>Gx0LLnB!76|NxBcR$;z-B8257xvS{xjlp>^#eMq6ne z1p(xOnxC+#J^`b9pTv0axZn|#;~TK?SpbVG%AfC*lYOJ~lJivmlh{7geXL+yp>0%h zF_oukdLvn)%I~?gg>uT6Qp%W(!;NRW+pO@jXG2%ojuok?TUTkt_O`|kwASzDX+ns| zei=R&p_wDxgoN4Ll{SfSYir+Z{ZIRZTc*zSQa9cc-3BLV?yrn%-C#nkNiej;%O-t7CBpyY8Qp2Tc+30Z74K zeix`aIV_ON!Jt}3Jc5|#p!tt5baoW~*jnKmuia36`QK2zN-o$J%r%xUbAY9VK3-a>MZ^;? zkGP!(d$h9T)A}j&uJq%f1&i8I2eNcn9LYI}p+kI0Y;qSR*ka~;Bx+yI+Vx7v~(w6W@~V zHANos1@7UM4ueC{TYjdDT%F&p7T*@u8A}IrH?HPh25JFro^X$R8UAz?S{K2>{y_yk zdxx>e?_38EBmrQbdrE2qg3CbNxegLu`{w_k);*k|x_+VvG{*FT`ebMV)EbwsPlm#>-q z42qch5g8E*66KzLqs~&<8K~U!;-_oy5A?{LW95x+dD4KI86V$3&SC0a{j9ssSkGR| zqk3XYg7hMB?zMiWZ}tPf%fHh}O&j<)-r6!Lu%e2RQ|uqbVSb}Fl1 zg7lh`0YOM@?E)bH`e#k=(_kgSa$RR#l8vbL`qA%wB_mgY-~G0nBBF{g5Mm;ZQ=yr~ zKUr?(>17G&1MBBXr8HkoiDzb;_+kqoK@m4BENyIDUxK=^V?SLsjF|8!g8EJa1=lFD z>2-$zDrz|a+8^7=4$?(~TYeoNA7454OXr~N4tRo=1DPs5Z*M;j-*d(;hO;OE_SyzC zMv3>^cZ*7)3x=on${lFz7|vtRgfKfz)%<@}H%V%e4yr1s^ZpQ&cT>!k@H< zIc|97%(IOZT_si>4qe`x#uf5Mi~r z*D?m3nP_D8x;WIh>%RP4Kyss*86zNt(AH-4CGQ&*WBzIruobs6m$U`T2>rgHa_ph-{uzAZDt-!piCMO`WLfz zj97sm5XW7@Hf83rvJX?G6d23ZA&o#fEpxT)QO)E(>C_2m;OvG{By3Ezg%GA^-f=Ou z>r<+Boat2tT>ak12mPJl`oA4_>n-ax8JGmuR2!QzuwA%JySYJb-0h>rp=~lV<4Z$~ z%i1{+>{0k7V!F)Bxnn_%yC>`dBksHl2NCjTH@3ZGJ_%$O#>vxur}lh; z_APx&!e%-;_~i=uHk|c>qk2bQr&|g!z2aQtHaUCXWX;7a3iiUA`861k=b`uS87h)V zTEog@4Im~xwi*P}wX$8+Tutc*avx_6?^QgA;ZZoqVK91j0 zw9pnt2u47Us7D@0j(f8E#&-Q5Pc*rBcb*2kF}eKE5-RWps|YSB8E2h4a=$ zJ>Mt#XT5C{~I?d`oaVhxRTPHqvYxs(BMlgjy&P_Q*PQ zDzh_P8bK$zIxnmaaq9m%;zr_ZqJ^(P9B|JnqR{q1vnEx&Cuhrmh4!JPS(@(dzWe78 zQ<*6Fk}9X88C*rdx#z!X1ryMcH%+g=?{hd~H3Lr*7jK&!3J1*An&lJi#czrhsk4Qu zfZig~mVhh!&L5HeJgcx7tfP3U($nIb%IL-oauG#9Qw`_%klKZOw`NrY(_wTUufo94 zj#Mh}+zGx&^8tHh&0F|sMZt2~_hx+VKZ5QW0v=069_gq7e8sTUp&EZ)mDo+&Z};Qt zYOAQ`>Va_)S%1E`v-gI~X6xW00M6j+sg$ljb6cFyH4Ru$jkJtg7+NMhF7hOPe$ZXI zw5f|kxjg4Ylro$ZrIt6^l&gMdd}^K!axFJo9o7qqV;@5|3cY6N$o;Ze_i?!bn2{2D zrBuQt^NdC)i57J3khAwqQlHds*K%vTZRB7YDaX`sx#I!_k15?O8rUFYAP3N+WL#OU z${$_zN1PX!vy-8>5$H^QV5* zdfeqYv;u862Bi^LUK80T;jsVBq-z#dOIHU4f#DH3%dLE2P4J7uR4sJvw=01Wq05_I z7FOl**kTmq+^Y(uAzk9|XNt_v_Ro>w4N+lexOk>Q&t?CP9MIbe`3r>j$WTi=+Q;zL zj~}zD$DaOsl|LU48{{U`JY|fe9zAgwy7z?~9x(=Mq5fg==hwiP&`Iz_8JP4IGA*j4 zBoPjHv|SbLG9I*;Jvs(=ojni~g#aQw?uTpCazU?Kz74F|zRkTsK?#I}9z<~1!uM|G z5eXI(E-a4nJaf}!C{id{(XS+^SIvtJM07d+&Kq?Z$epv zM&qIo@XR;wdvY}Ar%`&-`dS0$C8)n5|F^V{pXR{rqr*#YGcsSiR-n~IcXYWoSW5H8 zPVuM3DwN7ZQ=O#szN#y~T{HXwn1d++DctXlwxWY>;0^vFv_yIw3EblTkjnl&5POQl z6d?amInN!Z3Y)PrL7AnmDDact*hHnqocn{dA#!Iw!YfY5Y+R1pEi3?cHpdB-HY=*( z?tA?Se4)~6tou*ojSl~jYV(BF?M%>S+{Dq}um$0Z_D{`ktn5v-#)SS+Qe0sTEI!>P zpNU~A@nZLzOOdF1L33 zg9Ea3{pl9y}Er?)QoWcZE}$g90ck*g#__s|Wx-Qz_N!pZC4G2;7xmsr#4T zG5yS>QkzJQgVv%l)|h#-MgdzAuWnCwK;KnmwQhK83#Rl&qoN`sTbRi+3aVJ)2l+5$z8=+pwV@2jq)>jh`%A1_dpd9nmF1yIzJO(@ zD`~$lnUn%!EYcSqn%`A|rYZSwGK;IwW&aw8SdO#OPK9%@b&>vGFnNy4P-LLntMXUT zTB9}#$`-cKZB8$uZm0@bJCet%K7@9LwJgxUU(GV1M&`)3Q~AA-x@i3g0MN!(sp18? zgyYfMr===N5bO@dQauq)wzI>7n1^Vpp8pygYj=CyC!HD z@81*|8&|}C#$^cICa9lbmeVJEqQXY4ohss<-*Y7T->-dF>n(xPK{P&CO#xMVYB@SG z6nUh)xy*n4K_QxGh{`~%Uy;3RXRpv)Q#=+!+wU8a0|30$%u3Z$ZHZ@->Z)2p=Sszt zx1V&~L=;xIy9g>x7yxM6jB7=3Us3bS2-3v$~?`~fPqIZ$s z+H_X*L55q^0p<9&QyFl)`>L3u)rkExD&5!7x(x2<5HZ|_r`UAIbMH+n(yZp5^(SA19Sr$|af0tU71?&SIa2|%!?uhZ2iIxA z>pHKG7i9HXlV7}WH8~wf4s0Sy!54E>RjUTTVXnui>;rFhMBh7<$?m7)0On>szU#)8 KS1XM?;{F%Ygd7?G diff --git a/docs/build/wallet.rs/1.0-rc.6/static/img/logo/Logo_Swirl_Dark.png b/docs/build/wallet.rs/1.0-rc.6/static/img/logo/Logo_Swirl_Dark.png deleted file mode 100644 index b10c0e3102d008b561c674fbb07a4d315d243d1e..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 50898 zcmeEug;$ha^zKknN(hJ&0s;mS3IYPcfPzR#4jl?gmvl3N(jh5bN)06)Ln|pTARR+@ z%+SLy4BQvK-@R+yf8nm{S}d0@Gv_^LpPkQswxMcoLEsx8W%4UgP^tpyg0A;)O;w~2P8fX`T`gexszr+vON$|HE)mFbd_o&JH-ULgW# z3VRk22sHo3hg~PGvQY1_x>dcJpJC7+Wf3FCIT!z9(I(@vSMNyGJ`%eC>$46 z({(!UhwL?4cI6&J6b|<~(-Ck&5W`DpQeX$oDsKheCU43y_8Mr28zEJO4O%X&JvBjD zgk*pl0eR$)jhyZ6?G1SfH$Cq=K3ez$aZRu(&6%YIh1@1!1wP?0nqibgH(a!j|5p3$ zqYR#~1PwBkyIPyN%A&05&$9LHl5Nu5qQEdO9T5AytBv^}YAe}nBKVU}d{@=C8c2e2 zBdfPeC_u6SP%01z+Lvs?r~DJ{rJ7@DF(&}q04>T~E(ldVclug0^7-)Z#p#g56vt^gtEb4~!TsG8>Fo>gRL({s`` z*4U})NQu8ngdl?de)UQ!O|f2lvs*{gIcxG zCDRQ%0%+{j3tF`+Dsje#{&!{NN9poa{X!p~~2@Ljv7(uOPK#cvOjTw5o2c;o7M zPQ{p8P&;e)n|3K*&EIn++t zdU4qcI?zKJhRZ|qldoAQH~2MU=HAEuPH8Bu)6(SZDNLKonOuUBIL? zKpFLgM;t0hb15F4Wo0+zq-tXM)uMIatM{(H`X+@-%QyIs&d_vaW;HR0;!6JtLJI4# zOFSanx9=+5t|86(Pu^h@Q%vcCwAWH^#3U;};iZyRzY-fmc3}p?_0e~_EYXjlFR$JN zdzs69Tb%CwH0XaG@MKAP=gN6|8z+TPXWhQKJ)So^@$8Jv{dkMXJy*~-0YY&QNSdLb zhPYng=6eESY1DsiuQf>7wsf7{;p+F@$vkbeARg%Ds=)q0SL*J*_{_j|KQJyKJu)Coa8S}wE!9^Au7K83K0w|rUcPn9YT%vzT&q&qG?hP{g=yA zs?nl4qo5gqCB|rG0x02snq#^>acnj<6Wp&YvGw>x9*E+~@(V(aMtR?qQUtx$ysHZ8 z_)nojHu!fYeh>TZjtUO%5zq%+t;yk+0uSF{Z5vAFB?r-mTs;#`F{WdIxSQ>qe*Zt( zcpY-ck>y2|MSLYQo}4g0dMyM&{FVPvlhGQAhHi>MWB=1JMR$Hj{?oRk$@`B9fy zI_}{5oid7Ng_i`iWYO#y1mlk~;HEGxJ?O6T`=(lKiDJFeo?&s+<nTp4-6bnURp*xU2*1*ymGg1n&!{+RuE25@7l$-!%{+ zV4hHEAUsu#Z0Ce3D^M9zY_bxlJ=SzS=&H?(mUJ5bPG0!9T?`5Wl$rgBAGn@!RrG*j zwTzkgNJ(qtvsa<(n+It`Wb}Xn5(;Afc6chRz~Jwt_~kU=HJ>az6+k13$m5@tYb?^; zfJA7ZwiNK59ggj%U|4BEMqUclh!Sfa++wXYU*u@MXr&8q<4m-G^ajqX-?wXcvcIoN zzAIW;?|(4te{ykF>yKZ%-~m}Ls9u}~cY(1u|FgHaz@^SyubD+NG@HoS`9UqzcD(JQX}cZsLH@aRU~;i7#%tW8 zpD2U?IEdon?|Qhi4;P0}^0Y4eJXbakY^geMx}ak&5>xPOu8}Oqs3$6;QUx=|hVg2m z65W&js6Pu&nPTDF0hwM3^yUY<9r)?PKfTy3jcG{?yqbCI=5v4Jv+~zVKK`e8_2d05 zYwP2F^jInBg)oul{-}#emwn1D=bS%J)P+fD9s{;cUks)h$g$#Z9bK_V;d=0jm1Qju zdvdbgm}1PbA0V%zoM^hu4hkxigg<$Zr^6j)ljthz&Tl)Tw*iD#z#iB|rJhGdMpgqU z2U8UjZg)g$6#Yu;*11;ZM>aVT%@_wH27Z+S@NC9ye0_kjiQ1W2K#jSfKUj_y1VrVU zRY8X0)``aAz z^ho&M{9LZUThr4T{Q9$>#~bO#R14R?%#CrqGGi4&D))_%uYh1tP^$UXu)?I4RGhac zZOYQuM?R{1kVBg2+yjez2aMZWy1PJf_6zVT z+tbT^?O~zD@w>!E{l!|q=RQLYzeVR#S~&tA2{E|`+P&Kh8G=CBNSFqi@^UxgGFAPx zH)R)U)#EBPo+d`oV}z55z0WHQRx+rMJOSUl_)3~|_ieM6*z9d@jrC93!Se`hRhMOB zw+KB)*uSas3e)C1+d0qq=uAbYX#rDmU?a4EkvBrROFA4rdI|shhGP4@@K%T_(1gYc z;WrlBDCcP2=+E2P)%kLV9|-@n!0|kOJp7H#fWBv`;T{C}akX&Yc`W7l^5DkG% zFY=3Bv(${V-}ilw+a~}?e*_NWQ`Ulhkx{egYc0ZLmg}o>Ut`0!$HH%KE1HYc{yk^! zkG~X>en5=Uq5|}L?huo%69q16i0EA%F+2(m+KD*y<9)SyD@?zf-?o6lB8LbBeFenO z?my3-;?#H_HHI};j~4hyUq~;@3x2SU-Euie6HZn?M1-IC5x?%MOQk7*TjhVmWD}g*!7&Nos!F7_Agz9La3R^26oUcmScD zkWgIB{r+06b`@lsMqo=(P7j1D-s%osSIuM0V3AB}8Cd02$@IBOmqF5x$beUMc+DQF zKV$mwl~1w2()CsG$}nrzJp`9&UgGo`dQGlilCA||=rn&mvjpquS2e%o06-oOSqNAQ z%99YOQWOb`12DJuI|hY3)ltiBrgOKxxp0%>-$!}DL&l4}Bl~JCZr%O#fdvHW0Mb$6 zRh~~4xj}tg-#3?1Bcjp8N^;y*Z~0J6?$WCNT-F&5n;iMS{u}c!i&q4a#mfX%cnmxM z^YdXwBczNTF58%x7=3!rm#^qt-$320@5fs|SSq`X9T-r9-#^Q67Up~OaEoOJ1p?6r zL#akms(46F&z_pe1MRWHc4% zGCz}6$>mf)I@F|U(9Ert-e;H!w@;sg)9{H24n1TOQ27W6;*yA)IfQ-57LyWjQwP#a zAQhCh%T*~9;;Z4Y>all)t>+cRiu&&5{;{aT?W?>bU%Nw>njZ!%-+Z}zAvZXdX*d9L zXb))aCt3^0Jqz%LxF;qi3Jn@S&bD{59Pa+-!U0!VGf$03B7PzS-0 z&3Z6ld7m?4uFKc{NGgXG1Z4qS#Yk*e!mUByB&FBehR<+AnyEY$)p*xPv!-{9&(5T< z@2UI4=gI!$0lPP(8T_20=*B(nT>Q!+FE?lj*J3m~LMy@Q^QIPApM96rjjVZ8@(;-k z@X-0f)DesR?r$kV^#p=AKt^8y8I4TL?YQK28csa+{e17_8>$`KITgu1z=?@YDEwN* z)?~0Oi~D7%30xchy?hJz`n+jmUK;514_vpn{rM+Ag_Ql;5@ZO@AH5 zyI+)a=V^z>+h+|E>kv%xfC5LcS%dTYCHohUg|>U`8$b!2=6w&|#e?Ws98-9`tWons zEuxgTxRlcSp^o>l;=u}=gPk4tuYdVN+{ESN~iNEs_$Up4i{zYQsgFtfC zrN#f0mp>jZZEs<8JJSh)&Aa~DpEY$o4?b3+m=kUE4*efEGBPtVbGEm$W~Lgf=XpJO zPX25cwa*u-by*YyM|Kt(RVKpfH)HSm%irEPb^E~hyfWILX;##gTw8$8I_;)OC|$b8 zU*|JiSNGTbqcsVMxuD(K)fQmqOk6i7c|>wC*br_!ytML!*TS#*NjdH%;sK9yM%y7LoxI(BJxM4pxc{Ri5AILy zTW;!PzK3YzOH1x!pmj2ybx=O46!)o~kqj$=Up<#+_9z3@W-eDq{t-xth>ljRr^rXUSvD2+PeM@mcMbM#^c)L3;snG8;~!mi-&_R%9?=*(7demh)R0BoM)9bvpetRprW-dLl0*Xlu zIdDc1)XX{=h#08(*fp_D>xm84J&fbTA>GS|E1tv4dGUR!-F|g7J{m#q>ataIkm-HG zJevy}0t-mptH!Smm!psk5@1JppCjQ5QIBsoTl;p1F%Ihx5ZO|9d})9zyPcp6p(_!R_0n zu%THif_uV#wp{}JuDM+1g5Zb}j-AP`VwhlT&!Nhldl1Relo=QQ^Vlpczd94|)!rXa zgQ>Y(E34DxxQ)LDgdlDp(0L@F47+*EAqxi6lkQO=C1s^An0WGoQ;Rh}em%>WDnPI+$H<5O?w2pd~e~8ykvXw)uNe35wZj z;lDtNqU^jC!>pO_{+qexzgnGpDov4Ha#g}n?w~qO4W3i`w_wjLw;uRkM4#q^&$Br} zYEOXNo$X|p?V=v%fK;(x#tp#@rki?D{`l{F1Uy*<-!fbWCr}qv)+tpai#Q@3RA4s0-%cyRhewA&1PY-vj|J}|iHvviq z(;^KDyYuDzi|nmiLd^`z?QGvMZQb2qrH{X{cNzbA@)JCySp#mOOl`o_54>e-hfZ7K zH5gIwcAJGfl`n&>$FtTY%s~27bZWht9D?u-RtUrTo%1uXN0F`~D1PUFS8sbSFnm$T zl1eIXFV2frR0O#hcxUL(fDv7#K{aHnI_s0#5#y zfZw2ILlK5+&^k1^_=O?dPXWr5dgihaUs$8np);CVM(T#iYuN~RJ?`Jf8IQhGB?V5X z*g$Pu;ynS`y?JS=#tB|~&MI%mxE&kD9hJE3Lb>y`Y}={C3(iDv=w$G4k}NZ9qI= z>*cGi4DC%@5uGUCGXB1mvR)D?k?Bs-N)2QVEEDsq(>kgt8u$DorVe&yN%YsDzm(q! z%nBtudSv3hggT-N$hJc8o;uFPH^6jtf- zKu>}fi#Dvy7?I4Ujr0TJDZT#!%MybHt(aOJRR(ya9-W(C^w-pQgUx9jp1<6Pc&NvH z%h#APjAriVL}AvD!^nM>2LC>%v= zO@k{B|NX8O(B{(c%kCgKNWJuHu5w4uO3(!ofcj_OY23hx)W5H(X-GJ7aV^3u-hw<~ z_sQN-9~;r<-DEXVA^qJHld0W|oED><_SU$le&l!Rr$o4lIdyQrl4E7d5-0e!pHCDb-UNy{~o1PWKM3muncSg7hr+yVzpZY6fM=2FiUu2#A2)Wn*K8 zuQz+E+1X3>#?~`>Wi_ii$EbDwz)&x z`hIW`D3XGBeoC&x3)7dkSAG=Ymyc`7eRAMvA4kf0j9~{j(`mFX#nD1S|n2xVO zz3WdyqX95DXXGvUEN2>3;NI)sq~m#7Y2cupE5ECC36g=XXXdTkmHAk~^_=NOzBmhy z|NYa;TEmydz}xM8kL1SM&-+?&sT?m*(s!@cUO(+pP0+qfevPPe`lZZyUW2BBX-A`T zW%0giOxv>9#t1Gifj=C+t?IxXfuyBe)&j!l!E#34`6Tj!!lM2&vSeV~{M~#fM!{3u zz*fPeWyGlcd%{u7XQ09HsHov^$9LNv$gP%id9MEj;7-)?;UbAnSknW!au=&5l%kF! zmw`cKD6f|(I7K72xEi@B(TzaMJ0SdyRa(qQ3$6hI*Gh9BU}1Am*0r`kQm4W;9UAfK zFTf|&OOa2L)AW22Q(TZ`(=IJ}oS{;)bqAh0&{rP6+BXki=O6Y0hS7_} z8Q-xI3I}@#j5_hG2Xc-Uup2D01xA4w0C*T0)*JOkP^`>U)7;IlrDfdD9nx1@eeCeu zt{s_)z>XaB94_YJb{>CmW$6r}?C1Zfl)=%&Hc)1A^SV5YEe3(EL;M0zhx!`JT9!a75rYpJ{lNVYisdn=YA?9}_dd z27wNGN2k95AjI4FqMJLTrQ7~=4ah3HO9aK%rR%5W5L-fHa1-^iKC>jFx|-_hN{tR! zLzv{!x9TVLa+Bd_(~ZfwoX!1BoYH>^fcyJ$-{O|G@?p-Ge0b_q{hWVw<0INl>PhCz zif4G;Yx4iU z2z1;=M`{<7nJP|ZXZO`{MU6%OR7SEr+vjZHb9h{>1=vPG&JtFAJ4lpeEFmDNJANMd zFGiD4HUelY&7Xv=uCH4`NFpSOq_wa+n zUX@UJcc8`-tisoOGaR%@4V(pS6&g(gWg{0^FCrhDs_3$uvE1q&Z5f+Z{F0HRWCUk% z|1tG=sYxthmBp<|zjI?{XZe}iH%ZyaQ0Bi@5}ORls_wv_!6pTBd@uG$T?Q$Z{XWA# z?agh}W$KG2IKW1%w;dAss*~F5$8Dc=`Xp3*V;;vpKPdVd>Y{_L&({#bzzub>T@gJ8 zkeN)DBANBR9oKlid-|Kx?LVkV&&4FfDo={f=d*q>hXQA2OSE^$ed3VYd?=9O z(&Oaj(Geu^`DD`%DRJx6Pnp#fc+b-POY@IAK3v2qRx#tc9=xaZ7)6T zDu2{rb(|UgeT{_R%^DZR-`@_BJBnnpd*D&VmGJWJ1E9UPYwVZ3{a<@821t+}rcw9# zWuiRHwh@75?M{V*ja33C>V3F?N_<5}P;WLMwmg%Fn42HHF`AEd8a+mrSLf$wKMG0; z$o=|IhnrT)$ss=U_1GQVH+%F&m;_fLaT>rQo&!LAYPZ?`oe}S!H^25@b$p+KcWy9J zi{|AzGH{}#V8B{MMMoxxOz?mI{4RLGV3vF%wBpoZjQm6TH&1rp&+6ZT99+#Ydpq_nrhX7*Or>&E zOmFF4#fY!k+1oSn_hBENnQN0B%Vj_QEmP>hJpA8+-4Opw>>?~Pg=O$pwylZd`lxbC zNS0~BbB!)EId4N4inRUf^P}cDlyUk}T~2lfze^$4Q0+u1P(zrpox%%I^b;SY!*PC( z!tY$N2c+$NT3G;}_=!8{i9uDR^=bPL$D$3ZB1O7*Uj`$JMaG~CtDWqMnCXw`zh%rA zeV%7e;A`I8$F28ci^*oYCG$l@QN=E~?7gzSS+{_g=(JGu-TGKIzyUF)?eE~_!GX*i z=3`iV%p?biiWYwToojn-c9z!Vq4b?HH0(=Zx!H8Im9xK)@FSPK08TVjfaH1zBLMdf zek|z#nlw47q2`txk`fq09*@K#-*4Wcau?;4{-1uc$;cN;y!>8W&&VQc_Rbu^wZZVL ziB&os$Uv_{zAX5ts&OD8<`k@!5cO2Xf9=OTSCzFwCErjc@%6oM5&ci>27NLxFKF9JK?`b3&zT z`4iTdnth)ayJ4mDJrw6Sr{$t`6s11HStQCZE&yUR^uPht6x2mA1nBDRFy4^{$H#kY z{2{1h8?hzs{OYgFweKmW(kpEY04; zBGPQyfVI+JM+e~cnytw|4O3Tn7C5?*KsNH-H2N;5PW*oXWb?@VWA#oQh%A4S&I zd~bOE{&dlx%^QnfgKWQ(@x81#^nK_msb7^{dpgRB&b^6le{F9>61;3OeQq$Cfzu#BdhI{Wl ze;s!ydY|q`%f@lv5d=~ZU8j)80VeB~h=ELPW^av+&xzi=MpL@DoWs(P?N6C{>nAdK z0kwjfgyK1`NmyI6M}BzCt~oT2$ZUbxmfThuTh8B5EIwWW(1YBb= zH?8G!*)Hw^WlZ@PH4esq@Y+-G_If(Cv|u>VAaW>T$GCWR)~K0Vc%i6A+%y4wt2;`| z8No>YmBE`yCgNtLE5W_jz%4!(F33Ow{VrAW(zJvCOBe&VC1J^-w}P?ns-vLhH?e6k z7F$-a3ENUNyRivCjV;Tss##*@hBKy6^;s_sWl)zb@ev-0X9InJ7vK**I^u>Wh&Kz6 zB1uj74sLT;UzTt5OP<5Q`LVaO<#dYNpu$C`gtAFKk8yzO?okiGGC#w~_%5hN7+u#Z z7@H+$te_sfx#c(4V1-^rkJ*pZnAQS)>gq5KWH3-mzI9|J^m~&zf-eAI(I`+109if% zr3*A3nCuvYpV(}p-5NCPjAXL!``14Q0?*oU!)W5gf!PZLvep`IeX5{>&-qc(?9dCp zK%du%Tx=oH5<188zi76<9ugvw5y>S$QL1M`ez5gakD)Op?}bQ6CIyIPaJg?$Mdx$T zT(fOleNL3>e#vi*AvqelbT1Fgfy0OH88h>n<&p4lXHV5*zMW=kez`}xuCd=QTdT>| zn#R62+~_JD(9S-?2I<(*cG=6ie$nQ;iH~QU8$OoU*4qC3WbB|EOldssIzB{4C>!+% z1)}=F?K%RsfM?AwkP<+g$xKr6<`kqFZdyIrT{~8!qM%;OaPZ7Dj!$}Z`i}ZBPM5kH zt-uDvAI9lIib-CA^4wsX1?p3?6r4d4FS!~4fC@dQX>nr1e$tj#n`y@VMukR7V=(m) z_9Y}dv#Y)dU*pF2G3iI<@p+{xqqSFhL2VNs(eK->I`l1bGl-iZ))XyyEO;!;emh;F z^)65j6HQK8k6`oQdLvSYo#i`WvzE)Et@7Nnl@7ta_GN4n=7lryu_tlVuWvT#jBJrC zOft7VAV8#bANS#w_Qn!bJ4KYTz`RkPE$4oCMNwR~VrhUVZ*A-1QuT;rmoEa+i0yTT zMsJ`7G1ZK(gMDf~`Li2NrbKq?+C`cDp~eoT?vSHYJ<*D4#Y;u2PuZfsN4y#IUZIpd zVo3m+{EpIN@l4F>e72wO#e9&1agQHZb#=Lmnx);_!DLc9TN(r9+*`uQaP+z4s@V&_ z8^1?0_h%&}Expl-g~dw`b}vzLRvfWk%i3I1C+t}2lcN?w{VAZ%q-L%X#yg}b8s9D> zSCO-A%(5Td3Y<#$S;IjA=}aS08UqvWxAccMrrPIEpchqIRP?e={90Z%=*<`?&+km}^?Gqt@Upvsw7K;rFi> zT2x)d1g!*?ZItv&Y{&L?l5DAQ69`#>0+J!>w_)2S+1WLCI7wCIq@cz-puRppy?Q}c zp&lX=?pYJvASp4YT)ek;g;0z@;M8^OQ~gup+>`Ooki{AaXTE2y4o>EuIwXw`G#;RQ zKQ7tNOw&U}f%8bW`ndjq$O$C(N`~r`6ZxF&y%PBsd;7ZQ!pn}l_V6`5;bEO)@^z0Q z8C}d=b7t4Pgn$$at6js|Ve~VFsC@G|(qjO#pj@2m`LFgkd25YoLvDRHeB&^>dRt5B z`z48|nl(WdD3V$wb>Yo-^&lq@zvo(?7YlQ6O>uu;!P{&R##WO`1or^|cHy_Sg>SC7 z5W_ck+X45~5?#3Yl*9v(RaHkz#jo`wEk~rZs&k~XK#!0G+R_Hp$t-h7mFVaQE`d2R z_u878%ufe;MCL}1+D^*ToedCO8E<-et;fekUCVcv5 zvwp2M=z7#cE?WYzJtMN6N$fC$YQvt^$+@Ujb6gTrKu##Wdo7S%>S^7=(T*t}gG2^$ z8?G_)<$7tm}xTpjb0N0;D}78fNkZpDo`k{#lHeCKHBD_A(f}UIry0cYcmHBIMXVPeCam{S7=>oy(RJ=1!ZlL zt+zs{SGt%Y4-$70suESF1mt(|+Id=)(rBRh4F173Q|98M`!vBp1m!cE5K{j&%pzNR zBkUb4mn6cLX7F%D>6YcXj|v9sRyM*DY`~%mKnQ0K>)I3&`6Uf;rYE>^JZ%V1o8XN~ z{M`a3f2oF|pP9uP+(?}P^0flWD7{xZShG+=sNZtHVWtt6Nl!a=Q13CWvOnXrrAV^L z!}#8ceZ^yU<$f71EB(#>&(!Hs^9mCUesi8=q8fgVv6f7O>>L1XAhR@JFj`ux2tykw z9aE9*jmNSXg{BEO(hR6SASkOQ!fw?5iXMP7cZPGj~I$sec?6=z{H%wl~GNaliYBZ~$%cLowl)jZ;{?$@YzM zI?9I>-h=8^rPi}m&zkaKbT_{P95X6chX#K`e5*tut&sPzqaC*E=C3y6-$kf@QV+!b z^88LL{d2Q#?kB*b`few5=QQ5zlJax~d64vqI}%C-3B+S>fWmxRJTjXwahI*W>j6Y$ z>jh8d{*{_zOeIN2NMFVszAWG~-bwx{Urv=SmgYn1b7OcppE92}rv8O}Bg}(SIHIel z#Y96qbW(As?d)TmP`E$UL5fAXEgLU1tC4=hKw~$?me_f|A6WRO%*X8-tA>V|8wHK93UL##lbwBwv^t{?;Orx5d zA>G4Zf_2*reX1svGlktcK3<}+e*$zOXIv4hT+i-11HF7AaTHbS-)s5P%B)BDMc>VR zKSCA~0@j43cI>|_yJ~U5>l^=@1Q=QUYJvUi@E9O=WyXi>d_{~H?rQBBNTr-l|Gn_T zGe7VYsrx*or63}#!ZvqdU0?INsiKST4mKu|O9fMRCg(N`z7R&@l?p~P-c8R`y9Y?- zO0yX2&qxYK^ftiV?5V^f#xl{{K1$Ur9-@TeJh`zzbp_>U0*rOkNG|c`X2ChfJwRrv zGcT2-okjPj?=CW`MF}&l;m2+4_Z|(k@QL53VRb>e|CcJ0yOxsDRBXG7h@X~o^?Wf{ zwmUYlI1cRaWH<_kBl<=J4(%JH&v#7R-5Q9U=HCG#k5H_xZuzR`1@yKV+o}@Ae}>Iw zdQr-nI(dES{W|1*GmHhc=GPfw@EqOihzy`-C(P%E6-~y8R~dw( zGG^Jmg2N((klG|A}|!*NiZ0ytE?(plpsTPOm`D zma~k%c_XhJ<$rx0*O1`dQ?@5HUd4QaMJ6;^ijAP+Uer9P@3Q#l4R?>cWeAdfc$2{N zJ4Dl(Za}h@J?7eIZyBd{2hG;4mu^AYSfa3HgI<-L*m$l~r?RGOmZDWmON|Ai&OwsE zq7>p1%#X9pW&}Y&5o9#wJtq7EaOio2j7X}z? zU9X=3&r8izprSy`QP30uy-e!V%f@Bh1LwUGRN>C~{sJ=fRlO9R?Ly#UBNO7(RCB@~ zSeSW+_di<&xb+WsHb77fbs71piZFSe(X@$X0f1NrLlA)*-ws=EuT{B(0-dw~+lyLn zDJ7YT-uj(^D?f3)?UD@#yH)O+XJy4S@JdZzc6*lYOiSBiD(VUiCGnU8?_8Rj{X4Uv? zq)7le0(|$-MrL3tYf+FSfws@Jt{2Ggg%jbqv2({AFDtsT&p97QUGCW3xc@_RrM1`$ zUbDa3;yAnuJxIJg4F&4Ek6Kr~>PM>ufp=kB+P+jZuBc1q#rzJ(Wi>$&%B+)Ihg02O$V5 z`kq>RF_vlcp!S!`axt+r(4VpPH)$wQ1oTo;B5%zp_$^Y6T)BAZWl-E~=s1 z*Pq^OeATiz97FcO4jo7UvAV~IL^>)3!9l|eNPUbD#1jRLdU*S{*Rh@KsLo?c^fek*P23nh^GmC8eH2R5`#6kp*r}SW7mv8^ zp4{=(wWY%jCRtgxT>G>>Asqu?g$7_BLOj9d!XgWTfTkBVfDD^{MyoJ_hamW6Y%{)Qn?j1BRIx6Hg%r zI&VkFpr@amqWz@sce=_6L+%0;#M>XIB%vX8m!vqQNY+QH->nwP_W5>pCOaUt`hJl1 zQDuN%TN46MV*%U%1pQ^{rP6C!!F7^By%t$MB#-(OYF1WjAj|%fDCEv%FOaxHX9%Kb zC6w=V9^2$t3j35!_3{nrW!FLN>8)P>+ud}PpyZ74kV?1I$vjob_4Px(d2eP#odW! zfLeDGIu8JdDf|*)xg@U9f4Ial*t(xu%bS}%W@)>|exHquhN!Z%CA_`a1yF_d;7i_? zReAY~D9k3TDD47OD@wLTB-N*HEt-2z>!>bwLlT3G3y8?%dm=7A#d7CP^0#OBZrP|U zo36=}$x7Qj#pP+PA&X0`AiEsjp$-1i?EKNCO{&144;W9nQsIDo zQrY}+eCY4#TAEIn!>9w$o&mb`#=FF`GB&x{R43PQ)_;w1!PAzLEaZ~3 zq2s5~LcNM|UAR?V%uV7*a_p)DX_14l-lno&rj0!A3xIzbOq^%k{B!{Dhb0a+0;o5@ zPLO{~g_ECzw>Isknl6qa(ZuKkRt0k}2<)x9>Ls^0hC=+RyCPbzr}gB5!zee0iiOo1 z@IVP4kc!^Jp@GSQ>txb=$cwN?+w!LR(M#RDd*L*!g*4zpJ0BkxDdZ6)@BNi>G0Zrk zz5`&UeE&||nyn@y|IEjgOXVM9xMQTSN*c)l=-C6mg*u3FbX-O=YyWt z6-eCHIOKlM`n(Z{XAk^hlsAFugMto;Zx2hEz3wU%ZK5Wu@IO?MiCS4`Qc^L+Y`Zui zao?PBjYa8;{n5LSWVUvdkCk&8R?%mRM&4fKcljDxX+ExHj6X{Aw*RDdPc-R{qr~z; zeKRM|P>lEF8pXRgvh|SOli((U0MX&}sSI@3FKn3S7(TXoa8*P;XT!chhkUcO?S${X z2Dtxt+XA57xe(!J))e269!Eo?3X024CC#+L{JX_339N*~e{@!lc~&)M#^PH@Tw6rx zS|#c!w&O>>>Ft-xKAf_`eQ~*ZV|1QYn2ALLkF+%4Q6}S4Bp;#c*!BYBGMrwKHL6Og z$`6q--p>J3Abe4o$|f0%AT&@axty+j*O2p9_;09*xP4Cc)HhgWJMvKUi%_^IK!-Wm z0SZm?Pdji-cn0KozOiuqor7b-EHYx3KcPIQa{x3)6LP%0Xl*GPQ>r0y(R0{N=db+> zbdr%GJGm-(-48mMY;tzW848^%UAiS%R5=LHjO*_bIRNAU+I`63ao@|XrjDAQorWau z@EoJg#5rsO+}#9rD082jry{4_NcxPZy|blE--ai9GO=l17|*>a*Nbu23*TXULzhBM zYMM-hyEk4;O91{uz=r`ZL7pB8{?YtsbjUU$5?i*B209@i6kp7hU>xbp_~P^D&Fr%c zqnqp?d{fN(D+d-W`Wju2&PXIny972t!v}&h{xu~UXgo!U3$IKci*d4^aOls_me^X? zkJgPM|8d{11FzO`iBy#$WNVhO$Oa z>Y5j>jpNURbmFJtxv&HHf-Ro!tc3;VH-5^w5>3v<`C%n6O!_g<6Xwyq*GqZcFV?si zMJx(c>PZp|nB5b<6IbV(cB#;mx(whS3+FbZESUkEC3%zu^!rF%IXUDh!1eIi!cNc? zj-3~~Z-gDc)s#e-+)CCnz8+tU8thyE z1Ee>IEls=Q8|p!g5IsL5o_yIa)1;=mK(+BM;C)j#6t5SZ-%ui%f zVuOZ_f)3#am_@ERFKZ!k{CXoW*_*HwSgfy~?B+gqD)*dCicJtm&OC1Frn-sHKRiiX zf@vWz^oDYoXDf?7A=5-!H>2JcF;|w3=*H&BXb(b)gTg;T^bSd)fE-S7zpE@1m5~@y zMC9l2&KkaEX~QPfGH%$PQLy>tOLr{`g7=z_lx-pMn%JPWdbH~;=0KunkM z>GS(3paWZ58aD&s?W0pKwq{kt<;SYYkbZ$irF0)V z+MvIDF;YQW0}LFSae=ROFgEzPTIs`Rk^|g7wy!snW>oCB9kOQHb37Vzyou!ZkeX{J3-MY*HZO<0n$cWM>@6smu^FbL_z^G)T)^gU z>_sNyE06@9L#4k{^!D@dJ_(7MN$mdU9cXb&$qq3$WvzAE`AJr|r71H}wpzGVK$pH+ zfNh0|ZBDPuBo*%Za^|%*Mw9-`HTbIx6dJ|kEnHwAPhrN&kUmGbT2;Bm8}Qi?w?f)g zozJLrUByb1hqtVEbbjU}Q8q8c7yEGT6y{AWxbY@EsZx|cIQ+eg_T!T7_hkph zgtAal#Wfadsn(H|_c!9fZVExYe4r#(fS=$6a0;uX#`4|(thCW7goWv2{$0uA-|0Us z3;mWg4ItRf$mM%>3h~s27bjx3Xp0cBNCQ(&SG{i=0I}^tgD^gds|zoE{m*ZKR#d}R z2F&@8a_n+0hGvVZd6;hn&!i4y)I@=9qW-HVeEynVwl0Tens$Zekm^+en2jF~%G~-N ztNPBFt2gecXkEu&Sfcq;w1oc;URnK3gJV^twi%lRj|2zSe%|lU(!z}DH;f{{+{i!! zwM@{R>(SuED#^;hJLiio9%uLRLBaFr8(m#p`MfH4w*u`P)a+oBLj+eKWn-?xneR@r z9OhzDt=-=GSS5D-el{x_Xa>!`qbXpcZuUi(q=8vjkKW@GZt((q$aBuoJ!n#blolU& z${HA<+ZP?xV5c*AUurL_)Bhl=>qUa+uO|x9Wkf1v^*mlmu#%#NgGdlAp27AKJh#J^ zCsHpoeD9*(C%sW4R?iDwgL6#*p$N?)n24USrO z5l$o?kcI8R7$AOR^v=XfH%du|r%o-vUNInb5Ny|;v!J+*WN2oNI=_CpWYeKM<9;ue zP;T>-$mp85&b4$3-|z-l7O)2>&e7w-6P^aRx@RYA-w6+@<0&>}v?{e(KsJQ$EP@=fd}8VTHI$w<`HBxrHdOUpHs1AG@trn3iq zj0~$}n-jkQVpM`4;6+JUg>$KZvA0FQuuj#L6?B4lnNR7<8;@67BFprFnC@|)YqnjO zSv`M?Y!!d6ZThY0`bA@Pg>Q$sDiZChfl?s-1izSGQNd*KD==7ze|RL#vinkhtF4GmoKL8t|W2j8|D3)bkoq?9CjAmNSvMU{3i~Jl$7y zDCw3W%OAA4%+(_};XzF`C8S3HWl`fk}P83aTyncmR?cyLD?;M0BjV?*34Bp6@tB2N<;mZ)<%t zpVRku-}hfVdh~c)htqX^uJ?Gop07DtPakt_X|N=uUF=UUV@wBKR}A{Oue?>Iw~vv*h_RWVsop|6w|6;`0YJS`~!0S^HUB2T}|hq zJ##s5z0ntHJI2QTZzOn? zE!h50v&A(4l5gy*wm5o-?X$LjJ!cJ+6GgzC(%O9FUu2KhbUL^7W;sUns%OU zSCkDo$Kg!)EDmSzC)AVj*wuVsah_^}iM>e{+^Br)(v?+ZRdu0c!$_CBpu1l}!zUUk zdOX*~dzwqDKKv449a5ogQfb8gJjPAO>JNRswkBkhIMwwk_P}fMkf*`5S!GQ&)#z#i z7i$~-|BMX(CQ2}Jd!>){U)L`|6{41FcIUIw2T{DtM*$PSsbty(ymWBC^m%zdE~HEh z&Ky-n)I%9kEH6>M{b;?>F6|;WWbO~MrU}-h&T;P{Y^WH>!*gzz@QSYR2mf=Q=0SoZ zcM*D#UhYkw#@~Ip&(rj2=TAT1xB`=Po&Yxo>r8O<)>d$3dm}Ylt#*9{aymjb119R^ zfnF84v<#EWK6m0vu^x%;MymGTg~ir2_J*aavk;t@{@OKMzPY_grzC>#{g@*itM5hX z50IDlou;c8y#3B5wx@b~X*!*i&hIli29cIw^bno(R>OOvBVnI!)Ajh7L*D9{ z5)_IwgqG*<7TqxMKelM@ga+D<0?V?9<3jn^?pPW)RAcvbA9i#wc0i%SOB@_s`~;)8 znFkn;{!>K+qW3g0ZR)b8fr3!J|J2;WnlC~^_3j68O05RVEM)?7anva&^DBM|pVO~F z7!f%!@=m9YcKR6M@Ekck9Wml?AZlp*dgym|LMuUW-T5_ox#8Xz5SF>qV+%%tigWRA zS9C{^I*@c<-+20HEa@LN<4vWvi@c!Qhq|GVi{px>Y)3GJpgg}^RDAxJcd!HRhtY4~ zW!4*T)DS3^O>8A;INDyJDbu^f?-w0UqQo3RHoE}Y2_5Mz z!jq9*{%2Evu|zn@-fsqzJYVS1sn1J^T`#=o;lX1@6lqQ553^yp9@K% z?DBb#&EtK2S_bN30ZwZf7Q3;KlWw0o3p0$YaN%-x{nr9!-5ePm^1Zobs=2af?PpGL z{v|VO=IyD6CMKV&O-e9dbUwsH2_ID42F_Laqo9*-zbA&zUE^aypa$NNVW{MYY~|d8045S{HsMqsR91%nMGw zIqBN)^+e`CQNlx9oxLUz%kisX|KlHNo~EsSt!Q??Q{pIUKC8(kT_ux7Idw2N-8K~*~IG9 zoo7(m0J1s6$g?5XU4lJ<6`&Z%b|u>hy5UKaDlk;{wXqs0eFCs3Y^=%RU3AnlL65Hs zpwCn4AF*ctSW`@pF}*HPvTazpy-d8N>UtMDgSx1h7#|;dZvDu?$5VZl$hCslEvV=$mJ`g<=i8{O^*CP zB=&J<$4?tWd#F^wamgU&)MfMnH}(zbxd~nvA?1$@7T%>cb#&F{U^~>JEz3W%(Pr+# z{{GqEBYh(q;^ur0@w4`O`jHmPVVc{GX6X)#_kU!r-_C7SkxdI)ccYNf&MDFSZgKN{ znw*QS@|yTq8GTK;Qwwl`7$6g0t8G3qyLat-(77PqVR3&n3305PT~O@z-SKZn|ILXf znhg-%XPJQj$;4CXE%rO9vLmM1#=h;x-iZQ`+9FGRs?x9zqduEa-NQ>E&bj$ zy@J)$6@qOQn0GU;*d|KUQ_DRGIQgE7ZXmBLGy!wTFDOr++Up{ddE8kL8&EOku<4Vn zmETJx7s$i7Jo%laE|3Bq*RmN#H#*h$Sk|U94@^t*-^_VhP(MuamwsTEdmR73KrqeF z4#|SMNhYssgATtx)$RD_gGnjciMXb;v;U|FBjQ2mOAGAkgnIWg&}71S{dZ>sbKSKY zI*Zo|DdmiOuqPA4IhU<2zu6(&TWo7EUfO2+UPEze%;coDd5mHLUNM%hJTjf z04*v}LaC3H>f!q`4KS&6ZpL@MdV|GAGAdrgHMo#XNrzr2A2TB}ZbC2peqkAQpv<8I zDWd`1{nHS!`C!uL+f5C68iLF~bK)m%B<{;3twwyK6l>A>T}?;ZiSeJFKr#9&U=U0T zt$fxMftqZ0N7i%8EB%(+Mo#(4it(^t6|T6|TLhW497sBUvsxpI&0Vd3K<|!1zzeoKJ>`o}Znia9ZGZ;#D-u0d$$cY*l<;TNIho&fUBG0HS z6b`_%Pf?LGC8u7hg;)OFLlQ28y#2Iwy3|hePTTuNZhms!LuBbr=KYHRh|m2k^{COE z!bt>>TuVxfF_^{O%2M8#WmtvdC%Qydu7bWIYawVwgDR*oFxTv-;U>3rzHcAuhJQW@ zoKi0t;|WOFEWn=xmYo0qXUy&U%t4*2o>`|D8{9Z9bl4vnZQ;eEaU$JX+vO3+vsk8A+LoVbLjWd^NRCquEIPfZjHs*4x@FF!Byx zUiu{W0#jl5x0dM*P#<7176Q5o<&bEjOJRjT<+3(pS$gRdqxUrA{wR`>scChMP=rfN zu>C8VNq-bC_7PhwPuIM8|A7%uk7mlOxy(yv{{H{3bn|gtsG}qH<}`$=609p=<>N^s z(fG|q<+UuD-le z{uD2?VYCo1*dZ-a{QJTW7@1ZO_rK_QJ^ICcmO36lY|T07#AV(8#`+1c_++Q97ocTb zFIL>*)@@bE%YI0wdYh6}aEUIN7kf_X6VZBFsupHl3^+URC_2_gBI2|pRC-^QKLwk0 zI_Y$hlcwg<(e^R3dlvrk_xc~5020&pM*D1c`uHTKRB{>H;<$C|R;fo~>)l1uYElZb z9t*BO#`X~yV6xS(@zl0x6z=5zlfz`i%z7sOkR;QtfeTjiKDxZQ-SdTEe-+FMx%Mq_mPr;!JBANRui{{hbf!Y*{5Y{?$J#fq(3e1Z0i-et{#qE%8AN7Q zkANxRzx^zGDDY@4tm>S82Io-$glivN?kw!5%-5?A{1b&teF`MeP7EF6dKnIXaB#gH zgJ7~vqdzBjp;r(5nu7p+84pE8$MDlsv2U7i!L8@zm}_kb5T;+|68){NDQUqU1Jcx` zy76^v4bIQ0uX~y>?n~J^h03?*R060U*N?3Ohm^8OXTRulz+bMB$3zE|sJTBB#r{lh zPV@2--?nmB!#EuDna}-|9dbEBIqdIv3P<7tTv@{ zhU%XmKHN#^I&G`oS|hqM2}I^H2FlrS-MhgHNkXK25i;vPuGhWCbp-j}WM+PS1v0N~ ze#`RaHT~4nc6}k@J4V3F5I$L^rwDa~t;OY3fZOzXq3X40G(+@teYyvbd8&#}jK%quU?Z51H4AbAys9gOjLb|GtD zBo}#5H6L|G_&9AU#H91QbN1diC+&%t+QB41v~mC3-aV_@2O1p-0btSj{mCuBO+jUQ z1~+%Vx@mJFn1V?GW;>W&K6zt1xXgJ5mx0rPxI%E7^~&%h4>0BacNWfHXqup|+n-n) z>u<~R1gCTrm>f(z>1{qiPI69I*9%;~8L~f&fj55VEqus_|2D{1-8R<%pe99$ zmUEVS@VcCGW6j&4>~pZJkU~E?@ky>o$K6V0t|NIm>QY)6p=9F>*cYi0W$1#9(mA-Y z>vTCFjuw~2HQUGP4Uw%KDiSkG5E>}(WTR<@{RrkQ5jrv#S^v|Ci2@(Q=z&%93vFps z+4&S`p{0ZT?fd&0$Hyl)$Qo(xPkW%I_lc{2ew2WOYFDox!3gAwPGSAUZE+6%GHAS4 z`=1~*;D^O|qOoKBuMCwPu%^1%T`Om_?zJ$^YQ#<8u0L{Ex-+ZR>VpFV@aVuRr{~WU zNCI)`Y3Xv!IKOTC4{as0T$49ngS$(7PA&9Mn)Pgqh(7HP9@;VVPYi;+530Lak@`CX zdc*!2Fut0Df3rOSaGmG^{t0@0o4vb`?cpPf4r6`twON#%i#lHqC7W&~4_BB+`G(Hy zCQx396Jz)A{EB;sjha)xMre?$Ii80ZdhY>nSZ>D`WhGv5AN|>V*^|C6`OI@yo9_9H zwamYDrSUALqc#qx<(ub&P9qkB8@xoSlP<85>XbyD^Qu+g2binif&}{WRTHK&K1kgK zYaOf03lHmLju29@JDNOs=xN3vUjz4f^!u5u7hJTNuJE}H{Ai0#9=xt35M`DYrlRkb z6aZ-R?0mm;P2p*htOz|rOiXmN7!u0ApGD;$0gsToHXm!kAgSi%eQ~*MQt%j^om%fM zmgw0n6KvvM<-chr7tbSX0&lL|7r0<~LqjO#dc)T2u>k66T)}rTf*-O@uSL&{#&z^L z5Ud)?guX;T;8-avwi$Cnnpfg07Akk~+kbbiVri1v(Jv!S^VnlUbGt5*5dY{KKAJuXs7wE*IaLR-g!h!V!>TM+ zr)Rj_1D@8BuVFav2e{4vgJ|&qr$3uF{sZxPZQ7$xEyw6B+a_A3oJc>_N=S+dSV`^?C2h}A zp9KOP+vcG}7!icx_BV&@M5oD!UxYmZfwQ}oVn)k?K! z!K5KfPby4yFf_vwF?aOws6B2mAxIFI`Ge$3dYOQkAs2troEr)k zNoyn*W?lNRkcxWl{=>G4oRaTLUIjw*m;z62WDwKbGM7X-ADZ7AWr0Ln-t(*SRTPV# zwT_5Y)8*?%E3VavvVq&lvh%XIKEI9uw+2w427Z1}JOxv0uT-mQAV4zWUk-t6egHRF z=2ilI4R*{4SZ7^__PHmrroeLtQ5gY)7@hbS62;WCV3)~2UV|Nw{yM()!$fHliZ zz-NaqEHLI3oPh0HqMkQXT{uL$%Bdzx9sQm-2+T+5frp`BY9b!dQq+>y2qu$c1QcE2 z?ixEzx%Z(T$D>>>i4A&TGKI*t3e%2yT3=)CX2-7^y;?%;*+=MsS3zF)lT|T8OOhb@ z_tGC}=6=6&NX}zv$ZfK7`K~Pp_j?8)I2;Bn@I1bK60?!b3*YqpmN}#n@U^XW8xbHL zLCf@C2>J4LeTP71-(QiU_%)~frAU)g&E0h9fCC=99sc2Lo<7aXUwX4_5~`NlUsF>f zzEvYv|37#u?TQPNSG(5S#cRK{sa!vxBjOTn;#2%mjOy~~)gNgjR4S8cTAx*Usg`R~ zT;>~~a2uHMB6;}_+|Tr$%b$Hsj|M{z^9jm*$dAV^bn!w} zrsIZQmKG&49qA>0)H0E#DBi^*e4?-XC!?N8Ff?pfZtTn>Tf-Iiy?gS0zPj(PUJuKs0`l0g250NsA zr1U#RHFq@a7feq(D)YI&*h5ve7me1V;BzN`K%?Q(fY|}Y)BW*|aK}G#NuN&P4XS0eyfZsyZ!%t(aReyth>h1pdAl(`rnmO=hTosiN-zjU-lH0DEKGTCDrma$ z{Hei8tK@%Lj`d!KzS`bZqIUu^-x~pRLXmW3bL5dGZqFvlk0t2b-ZDE&~Jy zdWb>`A~JXWN4%I4hw+*k@8^a+%0{H?qVd<@5B9~oG$Wo@KL=3sU#t&C6WEMYJl6;X zb|gxGPjyZeihMK&sO7O>_K;pr{Iwd`D)hayO$#qAsyDydDX4)JUAaVYJ^Q+Xz%gy- z#c;>P#>HkcwnhCrEE{uNw5N*)@m}m?pC9*|Ma+Od!h1olAcs5!K&78e8VJ>-$=~Bzr$PbEGJZ*{9VKmOtZXeKmNiP3p_eJ@fO*GLrSSD8GwPPseY`AK$ za=`Jk=uz}F`|LoD32Nb_fym#QT?;nR1D+tmSa-BhOfh#Q{`2*q*<;sp!1sP?}{4} z2wZg-4o~B|yGwBHlhFiKT{O2&+xk}MlH_Hi={(bP6L;MVy;Q~s-Yt1LPDmu&kK^qw zasI`^k}l;8^c5HB)Ty`}uA>N!#awJGfUn`{4SsD>;~DA}l)rH4(Obajmot&)YLDuuy`h}p>ZzG-+66ITP@uPP#}U~zpz(<{)3 zve5o*Hf7k!B()(oah?8Tu3sdnO3Fyk)H)OOcgWJkgIVvWb%Uq5ShO!KPq*zm@3Cxx zM#Z@w4670LiH-787BkcEw?{t|RvLe#dl{8J-yt2r;dj#1j6R%+RDJR-KLC~LkrV)N zmlvjm?#m>$xZ1A4qoV_y5CWr4LIJ~Ym_@i!jog5YY_NPYuYH4BK9h0^aAtWFGC%C< zv)ex(Z+XE;!uLmL*I3G1_?f*CJmAj@FaKI&tC~KTN+@FetzJK_Nz>ZtAlBigi3r7S z0hBWsv1{p$$Y+tR)9MYoHh)PfPCxJ6X?qEHs&Qu%$PirTMFy(C?BehFxHu`>onNU> z>A69Zq+0l7b<>zw33vQ8%W!GQ>_P1hM;g9O`aW}``5oxwbd3uJNrIGA;nw@g+W{{mw8Qytf)2^+Eixk0~G`4g8ZL zv%gkb97Imdl3AI=$l0?k3J_kJ>R!DLQG6^PGo#U=Gam)CzyH8*<-)oJyMz*PQPo0a zMXFa}v6cR7KcBFctB-%-@+`MnCtd$m>4etO-F*(&tN0P^*&wt03Mbvc@+*C?!Tk(# z1y$sr$TAIk(9J7r^@}&|ZTIMzt`IrY>T>%`3GQ0dl@D-`EcFI|IkZ&I1GzY5uFvw`Ovb#txfJzM735Ax zYRP-`zz1w4G_z6si1ro(G^(IO9)2XoulI? z+9V@=kq@AmaKwk@?*GBbST#EJjCB-HHof<(u4)pGe?JuKeQ;!4fEO;$o1m2i1tl{Skr4SR#)# z{4C2p_i0}4|F}Uk2OC`PF3}!z9(N_{J6+?W)AtPNpF57hqZ*0pb<0}C7HaM45HoJ{ zMA40Ft_G)AM&z|7ub`Gs;|FOIsv3_L6scU5;#*8JlJ&~cU}oK}B4(2>N0UMR1^M{Q z&N-h#lhozcX!RQ=B#MG^Q?ISEU){?s8RxwKd=(|3^-(X&(OfUtap4riUVi+U{ThR zDjp|qg$bQG`Vy?#ToLJ8SZ;q+Wh_(}?+{a~5qLC`CUgOP;Gb0JjfBIJzEAATT%10x zqMh0nVJ_Vzw7)p?)ePjw4PuEuU-rKG7V+dnTscgM{l*-LhqP0A3D%#l6sRTRU_sdw zWqSqx#H5cM+=oy$&(yMCh&k%{TXPkcCv3*q-GCB8Kw8-HW%Q@3~l;Mgxapfgvxs%+ok)2`m zou{A;9qk5R$I20_p%pY0Y_knro%y++-6JICsrOWY?9d=CXe{TlKWAIloQ<(hmJ{yku*r1FbTW_{r46ul)W>H2l;2UF7?p9T1?-_g0K zQxaHMH7*YuyVZ#A`l_H)wK;#ZjXJ8Jz}L27Ldf*!$XKmSM)DVBv?Kmi$;LO8$fvt? z$?vPtV*`~MY-6nyze}|Ekbe=nzy9!8y=9Phx&qdWU z*-)wUTa-*mu*}PI^|l{G#E2OP!EdVf0g}pr?*Ok1lv^hIP}J5u zDs9*yK3tm?EG#x-2swn#ZXe%6Hq2Q^C_CuufbxO!G? zAX4R~u%dzq7b^f>kNjCq9L66wz7cRDNsbbAe?LxW1^VKBXPE6b{?UhGbsB4QVWEL6 z61uOixZ8N%$+^dVm8*v@c<`zgBN64)E+K1%$RSgHMcBWIb3xZxHg;+cap9kfV;TXA@RhQ6x-qWDOjl4U{I zMfU5lxaaeprH{uu@qL#z`EiJ>py0doE|y-jE#yx zJ3Gs<`aI8H3ic=Y4JNd6r1va82AW%=eNUQ`5!MaZio{91X>Y8067aUaTZmf_TTFQ zKoZ_qHHmVYl?KAIz_fN)Zn(XMLudAfzhHqJ&lCiRb!EBDz#;x-L@w%*%BLcI$E`q= zDUIbj()GZ2ZnC#r^367b2EAr=GJDS+@!dzeEUP~hujBoxnoc;cfBjlGEVFoi)On() zIIX{ElBRavaDKe3v?PsX-7WE3-NophtydUgl5cog*oo+1{u@aXDM~XdkR=Bw<7e+- zLQWa$e^0D`zW=BJ7A?F4Ax(YUlwV@BxM;oLr_orPHYaG$>Y?kjJjerfD8%7kr0Mg3 zSciiIj2soZoqxD9Oe`y&zOk;_^@i$RyOYCXMzGsZpj0AQsdstd`$6TVetde!LEFCm zD_Q_APwl!g>aqMbkV4gNfecsqZvQ*Ma6LYKVO^W++Qwa%$}-3sd`qI&)V~TA7(gT9O-!|5U>5qQu%$=L$~9tSZ;+LWI6Q>-&6P5Ll6k81^~v z>Ezo;5>!*2S=$GuTvP1w^=e8Yh5g|CnyeVIJ?q~}Tb6|Z3C!Ml%NF*=>%AZpXk`?P zp?v1dg+eR(eowgzAlA+=`}lnq{>07t#kRMk;_yDa$287wjlbZZ?TsxsT2wdUnay0s z?P67|V=q`sDPzp0a$BQLjY*j0>UU($g z&UuX+T+lFMwhXuiI|RQ%iK|6qn=4Ut?H+QA!jut{4SI1ffsV&ETBPeLN0vLMzA*0q zU8fO&q4kU#Jx!V=K!a{(S;*Hd{~mT@rkBIL(s6sAGSvQ*zUVF9TL}+ysFBKkZ~;AT z`E!w}qY&V%fM-p68f4e;42-rR2O8%-S8P5y)y2GWD{#{c^%!ae3d}Vy6)H0g?Qf~! z>RVLW@4?4ufg%o@G>0j*_clYTvzIJgGy@r&N1vp+qI?X5cJ}O;F?|mH%P46dXGsjr0B^xC(8*Ba(a-rF>>rr!SVyQ8=EgPHo0ztj}j8V^CR1U4$Go zf1&bb?5#!M6dvCW(=qLIxn9cJgADqy!6*2JT@bv?Q@X{2G6piK;{N_cwg%^IdfPMK zkd*+E5_Q?cx6ZU}^>Y@ofYN>c%<{ZJK|9;bkb30t(!^1+vS-cJM3i1d=9Cf-r;hU{ zo~eGBmjPk#DF=iI?glFTUxQr*R^M$o5w^A0n(x>?RbmfwHu5oF}cF4pyX2_HOKIer zwUjOL3nm9I?LX&YpN(#tONwuAhWE+1XSdlu@;!_KjJs;E&yl67PkMv zNLTyaPwbbA$F;nC!E_ka6qNhI&HDy6rsbRSB`LI1R%r)8n^_E3+qg|+Nj&F#Uby^Ygel~pAZO_8tAsB3d5<+bs&ErFG4`Bev$7rTTEzijf(W3l z^VS{Kp4z!kj{OhlzT6dR3?D-f^`Yx!|F6~hZsUfAUbb3V0A@Th(|Oe7pkitGEab@5 z6Nwa0Jh(-ACR2+STN#ax!^M6!wPbP`|8Jymq6L``v~!D5{Z!gAI?k05zJ(ViqgIcd zqQyIq46XIzbp+)r&#zjPYC(6hLI7pmw_hM5!}h|eI*N5#vi8ugM~Fg{OJr*4gaksX z{2r#1n<2<}r*`1mZPIkq@lO@Ao6Th{^|T@732$A|09q3DdqQ6!|KvFaczHvQnzv?K zRvo{}6!XVo9Z%;jZbMv2i4NYq#4bJ|O;XHhXv;ePVI!V{V?!pg{}rD)4@;lCw7|&Z zGL|4;zc%CtJE}|qU!QR3d0ngJqlSD9O0?h{HBk%&2_#%uKITKVpaw0j&?zyHE}T95 zpiIu=yTe+L!Lthq(Q7S_UUSqEC(^5{_Vca9I`vBO$t|(3!kDG^PG%sR9|Bo!BGy&L zN;kiW=#OSQ1>i!;nY!3tiu<52r*GBo_9(S-CLR5?^|lq`>ks#A`N6|gWsY@BDHub% zSozK$t0R1c7eWyg$ifb;V#zzYuWFOXu>*=-6gB{7eh=P^lwN=f?S#3lvs&AFP?K4V z-WUmjqZ#B@6#;ADMadHVWyBl5MQn=QcYV9zXvhzCw;toXE0SRd-_t}xy;l672<#Ws zd%2ZLQ*n9r<2blDFxj6QR8@2U_0@{^69SpfjbFs^(EtuhJw1t)_V5WiUH5r<24uFy z7H$=928L?JxHCqe-xMz9s>2CJ<<_cCHsRk;DCg5{%y%@QqJn%3!&)xuhn)gl%8Nhr zSHmw6j^RTl2q?p054N0U%vN6p-ntc{+S2=pS8+bL-l(Bs6y{cpGL!qClmusV+uF7t zs9!G(fkVh0_-pA}O(N9)C`GrRF<@bhaBi5}$H#<~lLubn$WbYgkwyz5e`1=&HA1tyZHuOdermVz{3Rc?9fudw zTxOxoGL^3C;6%2%wQH+4z~72ip=aEOiKhq2Y9v>Du7?l_jlIKj}+VFL9LHQH%L5)A&_{!QC*d%*0GuQu|tt$_Qcl7=s=6I8Af$5zx zx+O-8%USd1CxD?ZIUpgTsQy(`WVMASk00#p1=(?NP#+w{ZqI5!a~sy|`UT6982%Rx zc9MDxVy-~kWc4pc&-?IM6HjA@oC56|WO{#gY2Rd}@Ke{hCBF6VUsyiE%^TAXV2Ct~ zrqpOdr>2%gR;_mUVp`9ys{B@=cd5s`J1hGgLts%NsmOfH=*-PmILn^t8tw4LUVd!E z(&Y$d-oJ@KdUFm6Szl!*Iyl{+EU36$YkPf&gML|irn6=^ac1mX?7P_8ctv8uDk;Uuw~Ei-D^5>CtbP_s zPMQn-C^L>)?Yu~b>Qo9@v)*qb z_J5+2ch3hgV$F9xM*g=_x=lT@g=+HjT0*UPD&>yZxs^va#UwP|jE$^{JssWpPdajT z78PtUDL2LdYnYQ6N8Dd%?v3HZhl%{+`G%?$tcY7@DKGjxVK-6Q#LXO$Xs@yxz`am4 zVNAVfZptKoFmgw4hn3i7Ws*nI(&I>0k0zxQeQhb z2+SEjuNGUA+9S~K%{mreZhNlfZ-_?MHoHp~h#%gc^20rQE}N%OC^Gx8I3P%NmX}dm zbjG7EM%83zvfntU5J1*9z^*2swTaY!w3=VB20FJO{qk&%D|VwrC=5AuE~O#xj$=Ns z0^Ezb!A%>2OzRm+Y-2U|zZ z9M4#)e_wY*)334^)^O`-UYr69mn^K~|4n7vy8~JzueQ+pH`aOtJ-WIX$rzdTFI0o8 z;>IRb{W(>grwu;Vfqv8B&hnf5!0_CY@;T_Wgr@N+ftMNNZtQJOvy$BlV5|fx51XHM z!Ype+?8GW=#q#WV>bGy-o{P0V&;(-|AASEC$D>SgLuAET@XJuro3D#Dj4*8ljjLMU z*J?fe?_j3&Yw-Kqy$rCR@vDd_mwDLpPCm+?t+4uM_wEKLV9E1yo9TP9X?pnczgEU* zme+it&&DSVxHPnMjZ$6yRK!_})b!@58&B?X@XmrMnI^v0-(|7qA4!w{EWG*3a3J%L zCE$HfzV}$@E-&WMYg;+{4gQOg)$`O1@&Xb#5zu zlmz~N21f^xBU)i1D>Bo;(-t|T!Ci5UZq3{TH<_{zL~_BEapiBme2jUs$HRorGXWt* zxUD4C``&p1YG%(o*kz1XNJ|(0x9f?Z8Gk-Pr?|Kq=`_&|nmLm5hZZ}T+Jh%0EBtb1 za`tD^s_{KdAzO-Y`5hhf`)H2L z_Sn2hjfGj<%Ut-?BxdM>|6-tiSy^$MOTpMh3K&D{RhM2Zzg1O}d|fLY*!=@;Ic?}K z{^MA@PPXlKVSW=f3tSfGeS`tNU zoB#?Gjp7CU-2uRkANHS@FdG4>hgh*fC#*~POixSmmo1xybZ?wW(3{>wLrE6B2#su; z99w$D@6X)DU3IAqbcLtz+i46UFA%+cAZsN@kV*lK$yG+`;*5-5ZuHw;4MMbg=pIcY= z-zS(%6#QbYZfEg?oB*sxb$PBv#Myl1$C!G1FhJmxU+VBan=dOP>X2e|v>*~SrIbK) zrG_RFg2c+EkFz%*@*uH}?bQmp@d%JE0O*6a3$zyN?0UD>g&#Hp7IZ9@hJ};KY>>I{ zp&SJ9d0}7iq2@tuLR;v;K@9|Q9}JV~Z|W(hQ9~;8+U;xXbsrT>CCHz=NR+br6mn2z zagX8ZKsy0ZP3PVvuUYu)Tu=@dRLXt}tm5*$rPv=9+&b{O)Jcx#ql;Yoa=$n(0aKrM z8cWneIJXA9sQr^(&=jv@)z}F8AV#(p{>thng>OX~jrF8NH^d$=0BeT42-Xma72jZ9g#&874%~F!%+JeDW8!nlGRfZtM+u}8s>5UTSCmhUb1r2kRS&M4q z_&kC>f%&0(9l15y8sJtmK`P2J4;gQYv4Q%cb4YL*QTxp0dioLk(MnfMj&d}To4;m1 zjusvtF(%sgtM540Ap20jE_mxk0oMzMtdn2m!7L>=Q}rXBX-bLUU%nX~#KS>|xAD$L6CyjS-ubEzT}-+#l#W4E8~2 zU9litzZ#X(;ZK7<)mI7r>jT2aXPbF&mS0w6iE49bK0BQUM=5!SWO^}lM@RuvU1!uB zwBhjKhd^`h#0jNw9E6kXDF!1bq4sO$VtQPOmYcJ|L-Vy0-@9LYn0i&s*RMsnD=w`P zicT;-m1hmY&;Fc2!_=RaY&b9*odyEv<(*HlTBRK9cN)#KEQow7Z+5m&IUVuro-jRC$pb$7e0!@oJ37-5EY%%LI5DsD*(_P}b-TfEH zI%zS+hOu$SlEjm05Yd99GgZQZTYc9v_2=i{xkevEji_^0!O+qjpQdB8@l)iZx1`*M zCqb>UatTX#>~1&dRoj{qpbAxR=#!x!ns126jdU&s(l_vt87E?xxM2HxJMMVCFtNV! zc;*xdZNjUwiN1QUH=75QgsNdx^-vkQu@8tW1~4D4DpR7#elpMZ?WKN6&cZg~MMPN_juiFIWyN zk14To-spag{v|;7X|`0R@>q{hrq4;dI=8Ez~B(r$4w&%aJ9i>$YmXXrWadn83qhx*397WTwAGg1$*+e8+ zKwO5wIZ87;O??%yX2bZMRp^@ILRdZ3kDuTtAo?sS3P1aQ>02{g2;N{^0j{Y4VA{IH zz1Du6;>un8Kz0GK7ru5=#)v-M#$ar)r%#^KRC)#Z_?+#(0d^QskmGiNc~H58NZZNu zo`bJ8XCw1YpZ64;%j~I5Lbf4QpYS7`)9eN=akJpzdzzYyUurIC_Au4IH>&;70_FgcGFK&vj z`T6_~7LlCAZ2`_imGn*AG)=gcmNdT%Tk=7vg)EW|3x5{7ah%1t(0qM1d}ixV%7$d7 z3B!(&d|J2mLN`ESV#L4s^aJL$r35%DAWT8!fh>+9eT^@Lp#xWjvGyH_69&M!2j?ve zX|j|}QH8(xPv#bOb1IUF`iL$uYX((LyR`IqKe((=vFGNXKD6UJ-y~y$G_V^y$q-k0 zFw)6yn{#4S9S?2b3i6%#UvSXXr%>@~k2WWN{B}Hf-=5kBSWwvX*{76qL=u@5)b}+jhPEj~>f^pXmQmb8iKRcTU?> zDpx@(A{WlqhO;%J);o7h>HdzCfi49MDDZf3pgMOi3}RstUmbLPFR7WFgPTPaEZe{9 zk5Eu;G1KO1sz}@qDx*dH9Ui_rMKB5?y&?0=eghREP00qd2lJj@jxa2Bd~Dkhek<3S z^?=)>ZRT?9MV2StGgN3L;R2=t4e*$KovV+ev=u1M%}Kq~*a*<@NdeCcrL=m^xV?QK4Y@avz*>FrEzr0RrsKAU_;$ldi$)gejlE zZ2uM|9Dcv)UX1IP$NA+o@A ze7M;gHE$6eKywUX?IYPM%2=EyBy|YQ;K3ue$<*RvbSlZ7IR;#?K50apJ{j`d2SLrX zUWO7^9E6|#2gz)Z+G!kD<=6?E>GEJQ=a#WJQ-vFtAW~7C9R{Gy7^IZjw4lXqlP%~D&d(g9B*T6Vy zUHVtx9^o6n5{5wfmsR5tmj;+v8Q(+Svb(2k8j%GeSmf|UHfLw1J@x#Srite;#0`H( zJGcyFJ>-e~m$bfekNyJ}6%bemD3nzw_#4w9> zp~7;EpLq$iE6dniGzkKk?t$9v6Oc}6lzoKhx)-F)9Ke(HGAy=%7Zt`=P+OVf?`gyn zr12)^Y{}p-VjidPbTt0jdq&n5tPZgv8Hhu?iM&H0l>1Pj?HMM$_WG27tO;8 z5CZd1%$ZgAN+r5_gS7=uiw1F8K1Fr7%s+K zFprjn2-(!}4HWj|;FWIZ^FE8@(1ZT})81SEMcI8(!xtqfjbIQWjf5znNC`+wcS=fw z#7GSxh+@#)NT+mzlpqb#jS54^fYbmpz$6eiHunMi?JiSWG*fs`Wf2{l^DZY`rD7 z@U6{Z0-4*Y=J?`oNACXFk_>`jLq#>I?%6c_&hB-q(j4@vFNYBO>Ityz*$_t~GmyJL2wB3q zz)Mq0#x}%A8M#;A55dAW{$x4Kg+s1(AlF4Ug8ub@ zphWGqe`Ic(e(@o}M-r{+nb*`5avA6cJGiNvvgU(H+pg*QeYd|g)%0nxM{abnvHdkZ zFWAvri?Q_QBKFG4^Sa=mZ`9Ldkvm7Y)m--DZ#pmpNorR`Qo5a33dj38a+*u@8PpOd z#;ti>k+#zlmL%e;3-?Dn?)0&8Iv&8GZYbTQqsFvcYi|>Qut!CvB{tZ6PLyX5)JuFOknnt3e zS*XEsl@OI^7u0;~-7d;?2H&`=6f!?u-eZIZqg4a2ueJskkmx4#s(r68lbCT9(MYlW z@#AE*P3q`kQHnsBF^8z{(QZUZA^P}ar#hE)s}bP+JrG$;ox~dWY}wku)_zV0sT4YwoX*r8bvJEr!tTA@10@b2 zwCr@WxZL5ifYxka<-yAKwoHK9QOsq1ch#Q^^KGv49Pe6pJ1;}uuguSOC79>E35oGG z$M^L;J-de`PuR^7(yG8wLImTCaCXSl7`jGB0^F>VmL&}>*3pjCFnkd=o!;+vrg>IqecOT@jE`v%{GZ=!l6~Avbe!j;KbNQ z+HGZe?|p^I}_;c_Q-i@eks4n_JXGaa1sHt|TnwkAY@aKArEmjxO#oe4iQ4 zhV#aBS!jz~A%Xo${x)uC|L^`UbwLeK>k2uM%W)HFsh@@S*d@&6c)!58I;B{xc;oj? z$*BhvYcYQwFV8ot)!yQw2XAAm*k5+iPJ<*`-=;cU4;$%(hC1~DlED&w4ORtjd+Hq#qO<%MCK12y(#iqhr|V9&L=KT#qP`P72W zk$KdD%cjpA0-6KoMCTr<*bzO^%WMYi{Pyq`@F7t22yTmMHPhsMraST^Y23L8zke`8 z;^d6JgF?(h^yMB1CoVTHj_)!<|r^#K}f`>$X(YRN#!LRlPCK*viu30oy=ev1#u1)NfVwT`RC2g4VgK(Js=LLb?k_m^|ybx8Gx^VRk z=ba69SkNQG%+{8jwy1gvaV679-6`Fv?P`_fDZ7Mc3pP2)*KGYl#1q~Y-z1VY0B-oo z`s#Xr0>z+ElG0kyW$XUy;IFhVB^JdS=(opoN6gn?xv6!}1~dx(G{3&-oc{5M1;6Xw zQFUGzU<{vq`B}R4`i!$$Mf5lRUG8DJ>vW{T5urt_iVQ zF>vohd?(Cj3DkT-WW=C_<<|ga&qpPtTAR_Bwnp=Zbg!cR0%_(dj*c%!LIl13_k*RZ zxBmV@dHEQ)xA!8=wht>rDijv8gE|gY7YN39$7PF!B+RZ$z*j`=m2nEgU_(UGk2`PC zk+Ix3Y78s3-ZiCETVG4kUOKRFnVoal?ipI2GNLVe_v3(+1}x7u#zT!(tFftYo3cM= z4yz|88#ScY=odJ1I3%8{4Ou7ac^|6SF{HJ-E-@odPsTqFIVwn6myQIiUYOhoKzlH1 zA)xF38NJ}}klDq9Sf{3&p2fQ-oA#o8p!jS#@P>+D;3QbTr1?tfbL!|G{WE6gauaG# z@>J`Z{QS%&Sc#N@`jNLioUf~pQ!rVgRC3|Gr~ zoD@jbF7*h^YNTrI*;ZtcVe!u0^MI)f#!M+PtpFGICB`dPE#g0yi;A>0z3Mh+1C7vm zk&~NMWC}buWo!79oFMz7O>*^G4v;*SJ2TjMR7YK3hnKwtJHqH9pokVQHW!0HJ`~L@xLApGBhOOAy3gQEGR+&Us~MdL8cT~bo{i0~0Vrcm+#=C_CzcdjmIZ)uDU?OK@|J9fP)xu)IrbpyRr6_ zzXz3!5?Wo{T$}2RKMuvuhXj)dXZc}`cxEF$mPvKLY1Lk z6nHc{P`?m7&_edsk8B5Q#1HubqVy+hYS!Vg_j$G`7>g?;Y_$VxJI!kq2kTy$;Zc%+ z$(7q!uzMdn`&QK`pP6&ZykRcXk7~Y^(+L??vJMNSnbfIr3a78=gIT9GLZUO*Hkerp zQ9maB*ueHI9fbtzmSzkXPo8-|MA%*vLDbtd)sc%^HP!S_wu*BG7BqKThl9RX1}5U% z8{1U4X}(Agea!}g3~?1%>I_k=laoyy9~ul%Oo$>-;DDrw z)y|#lJHkBZry}TwCG=$s7%G5{OgNFQ%IIeE^rG23zks%J>7!fFr*|X(AYrFA5JMHWjjOY_!gvad;BLk|=Q(B7;As6dEPldH zWdSr8qLyThw;e}fsKl2|D`vDg>P8!?6Ts^j0J#^+kHh4M{#-1^5o;@wT`V>8e%tJK zL2{oq%4)M>w;V~NL5&lBpbvTj$s*uwV#&2f8HX>(gDDV^B6_aiCNsb~LZ*n6utG#aXEp@pt`bBnba$C0&%U_(u$MuT9Sk90mW{) z#bEiTY7hyEyeewX_Q_XbBhjLCCJ#5{t(e`W={mOc zXNI-98_E6noTLz&9XyyvxBe2{TpM zcs8-@9_-kAzR;^WDb+Yrf>^$9=;BmvLI**tSl&c2EbXzHVqi&8a-O~Rc?%2=ou=B0DTt2X-@r)A}lEw!!Nm3-~=hGY+I~U1UeSB)}Y*x@TfAo@~H3h!Z zyBc6$uk35=#wCA#wt17I2@hh8CW2@`lw9!93!45`L`%g7CwDc)P=6$tKqD&tX0~LJ2rVgiq z^p;vDu5KkhWb+{vKGjkFb~p8S@fLW&74U))J#0aHCADV@^upZPAQ`eW8p1+|5XL6Poj~bu|C1p*6CC}V= z{VSJ;-S$pdF$7Tp_4uG{@o8dRUE-*xkM7NzKUDPm{RZ^X&;VM!`s-fCJbGKYR{2K2 z0B}JkVIZll*x=k)x#XvNpLw{1I>RAPNH1a*BINE14S*mwRq&Ov1^FH1brFA;O3Y#O z`~1#yhFsejzU*20pgB|!*x1O@-(4{cbBSzwTN1%E+Ik?$^BsFFB}hh~v?!y;D0sk; zNlxJthq4d4o-{rj?6wYh7biH-Dgbx5pc0aZ+i$i`RdmKw6aeK81!ZCP%EqE(_Q2g1 zp0QD*)2VWM9`=0OqW``QTFE1&PNtev&oj~DuB2yer}^(oG@$4D=c-+!wb;O|ILjLK%30|;ds*-Qto2Q~_7UlW zji(y51BBi0R26d{{EXaT$=^Y1J(>c&6jZJ8p9infa$n3hmpVUBU#pv-lMg#){uv>s0GcZkNb zzQ0RreMd>jD0_f?`ICj=;N+T44E=%xAtVRRB4=srYh>@d*D|rUIxy17F2KeHthTJ; zT3QsM6=n9N%v7SG?b2@Uc*P=vA|Th@&HrtB%VirVt3chL z$|5VuKfXy3H5Twy>FFQ;7CLcf<|2u^dBb ztq5Cfsq{(D25-Mn1W8+LdAvX1e`V^vT&g@`sO{Mv=Uju$9hygaFHC<%gG^GA7DIIj zYeo70iFkKcF?bC&d_NWb3MQPw%TT)+_U`XrtV>Tz*46du9OS^v>j!3_+w73&j7Ha7 ztZRp#Z8!gg9YE5vV65;52)%^Q7s5U$J;Y(g71Eb@Hdtp#g4?SJLVEAa=oGn*shc-T z=m}hPGEes-UR2%fiTfr=@(LS9 z8m(!^IvL4xnp$LvbqlB*I5gUO)K4~zNUVLr?%|cu&hLWjB(1Y%n$yvzKdq;x{KgYM z#r?V$TidF)?NDf*C>fVoti#`c$gxL_P2>iS`^)F_J9j>Uuvh}iBZQ>!;q7yUe4~K# zUXyst<}M1QjeD9ZuPI;eG)qBGdrLXkXi0m>Npj*@!r8)FvEp%6HA0XutTis;o!>%* zn?CcuZ4$yr7u!HrCQ&w5=Vc3y!zYv3f;uH>6TpV5yH=}UiPuZ=7IpTDFeXx zO|>-JMK64Tpj!u6&Ja1Rb%}V{jzm16*Y&bS*+|k>-@DyHabvnei-;Zxe@rRKt>7nxvc7=bBdC7gv7xkVo`8Ha)Z@_9jxz0( zE>xE|3H`{-ucq>)5(I@|8QKVpif1WK0C$C;~Wm~6&)T4J2g7f zS8da0QEs1P9_n5@~7z5miC$;*>SW;d<-v&w^YOiQK#cfUfDAPVj|Oo&r&YMy>H zG%Alh@QwAwuHh28MJ9sL_H?O_m!!G9;w@)|;?ewH3aEoU+E^3Wm}`a{-YHLZFCgSg zq%elaELN#6qZsG?oJIe=qoZAXh7beqbY^<-aU6>iFwbtP$R7Wp)*P@1rlxWWYBryA z`dWE}$-Dq>U?#&OHGGs0Mgp)&K+vk);zGg1#xQ|+OZxIO0AXmHskmtf zLVsU92mFIV6kiZy^?n4ejQ_ z4mf4Oe%wxvb_SS%A;7qo=w!t%@l?u*APcUi_|Tr7cJ+Hl_|<6idIMSf)Wu=1R5C_A z@Iv$wGt`d3i%ke-I^F0E{8dn=Phe_vzA1&lcx5foiGwX8ZXubKsqg=E#dboQ^_Ccu5vEcXlQum@Yx0 zi`M~)P+xJc=;_lKAFOJ*IkheNvBO*( z`~+SSe1`P?)UgloNl#NIi&@bJg2@zfHaJom6_n4@6IF51Uty9Z@Zf$3B3n?70=n`J zSf`l^irR&`=MsW|PZ1iutO3450vca!^iL%Isb)A69!pk747H(P%s z@M|c~*=;Xd@{?kpO5V_7p+(aoP(SiPd^9HnuK4-$XI&hK3?BsftUyCIcu0H4w_Ymr zz=GViIP`EyNVn}7xxHMx3s7XB1aZ4oYKmb>Lf;knkC7hFl9QzB ztOT3csjBWa-UjK>4G`9>>-lh13Tt>$k)cZ;buuIdO zZSvG2Zww(0WspApF;^ZsM<1cgqnJDpNW4(M=}* zf{&9bsBzX;~@W3eo~{kDtdG9txkED9au6Gm{SlwB=k) zZ~cvH9S1Ae27x3Nj5Fa{;{P^9in7x%tN;tjIMc9+1yTmWw^?y@Q}zU(W*bMYahiVN zGDKHR`KOkzXkZhf5Lh)cnIvfj#kwT^`^~ZtNd+CStv7;@G0u>O>c_DG54(-h%cshP z^Xs2vH<-rrLhAQnx$L-Y@vQ(wm?!igw(^ydVdUceXN=lu?3OlWm9{p{D3LN^a=wJU zS$(DLO3(-*UUi7SoUS1Lyst^-e80?pkNqDp9H(a&;gN=E)#R>aF$XHkhEm91_nepM zTcQJ*>_PIxu7L%l9-3YE`?(hJmlX|O3d;Sm}g!dRk#5iud_4?HIkQ$ zd4K{@4w?c#e7wP<^|~MD(D#`pe1|PN6;iB|V%Yf;uB!&R(Ef8Ya@din!5|H>?5uLX zPKlP~&KUilV@cfmhBUVny`<ip%3>nZ`!-sxFG9sudG<^!4^Wgg-&tqha(>+&phg zZv?kp)R&rLzcS89kM5R{<_9P@&AcWO_B9l#`cm=0qVCg;RlICo6>S%X;Eq(4a(J}7(1%wUHKHj$h5hD8<0<$%l2I%F-*$SW=b;uL*Nywgb=G(eQjrbi^99kWq7{c(|J~lIgsYDv6+3zHF6tH-|$YA6#kXjK!?XlA72_9 zXR<8okJPbYv&S2JO?&7{t&U2kvI+?rXF_cmWTi!h?3PEOBe-xy8o68*rf%D2LJ7$L ziFxV7l8jUO^`cNkV>^O}sGpt+%7YV0GH$pwPF^tP-D-^t*(TXl7vd$E3O8m(A{wxL zH-(gC5KJUIBFdlL&FzjUT_B`w-E*^A(@G}y6{>X0kX7|xYvFlS;=h<g!gXUEjf_-`SD)E$b^}8Lc<&ERl;RDOGFw!dXgad23h) z#&Q??z}G+DcpAGpm1g8=o!Rmz_0gP0^6jbNhaIjYmWcn=9X~)sS*$yIUg_E-=%_p? zLXv&J>%@j@^?kBUb3L6ks_0-hoYpT)30Mq5>nT{cS%@457{&fWwp99J1m}9+q4W2weXb$`|}CGfI^Y%|-N`$YCBjWN;w!_X}s zikZi-v0$L&h_gb8d4KTjTYq?43O^p%me1OfZi_d{r~ue<-XmXp8%K|V*49hR!B>#n zA3P_E#supq{Bh#?F=sxRyzuO(g&v4MNzy}M1pxn!Ia_$5TZQ6(%W*J1P5-HmzbP=j zc;m0?h=A%J31;+^T)&3!)-9Ij7W)XCoAU`F;R;ek0Tq)?H?{^Nu-NSr>0RRces$Ax zmr-e$A-Kwj4c_tYwDgkVe>BiyT6r3UK$D+ z?&PpOK=7kmpQA*JYfAO$Z!O8+{2E7%1Hy?s^#l@DIX@x+_ay+4fUO3SSOGmG{+B6J z7}xGBkuJImJW1u>5Vg13EsN0sT3i%{1u2rgJpu9~1EY=}MtQ4z?wQQ{JI@TNOr z%jY>6@@zonC-J(#*wT_;O(WjFyil$}vbkaB;(LjbXW<*V$;R1%%#@Ogl)jonb)JMW zP5~#0x-QANdGuRZiLB8j5GSxAc7GZf*I7AujZ`RXz%9_F1HWVt8LseY*j9DV{p78h zVzrFlSzOCoEaRTb4qF%R%L>Kagv4d97pXr8B%>Y;4*6L`0cns_);6Kjr*4-Ig_M*B z0x(x;U&c0Jq{OWw;E6ov!g5jIHbTpDE>cY!by@R4-x7pyrbi17A#e*90u2jbeA4z4 zh&B^?6@JAP%vPyFDsLkGTOCjdgC7w4CsL2u|D4n|3nGXk0?f!g$qUPlbXCG;@BaJM zjGYfH6JQKkAXE}KxrIj{57O5(#Q@~XqqRUSH!OLgYK-Wim?nv$K=_pfyy?8{07r*q zRZIZTk(O5WCj{;Op8f`8nkG$-PCxifSA0s9bP`bUoaTrW8k|{jJPu7sJOPc`pu9ZM;(rEGNd2 zkhVGYC4WLa)BAFN!TWhDx9mDhujJ#R$8(k-UgA=VYoS+9w}9}z8r1C+=8jZ zL@6A>kiXRDcmB*?T)_KrWfKbl-4E%8;p~x<8k^*bs443Bt$TXQd2O1;&VzDAo#i z;z^Mn;){{JdTkVDp1k*)FH45vv!wJl3PFg%i(@K998bFO8_Ehg>BJBEkFzY@LA|D^ zwT#!F!1^N_MgM{3nL_cbQJ?FN93znChp07n4O#KMO_R?JMsdl6VoiWC3ltcCZdeNT zk-*M)s;pPQv1nKxHTKxtYh?|~-tHpTM|ub?pQq{Atdtfd-<4`#JM%2XJ>KS2bN%>WMBH@N3Y7 z9t*2;B|lSXUW(0G{;Sjc=uh+J61L{*ZnO_wI?`sotX(`kxs=n^_%`9eFyq0P4b8bp zgyV)jm)k4+Lo7P<-}C zN4g%(>>Xr>IXe19kWsAv>Y=^dpEaz3(JS{D`EO{N?y7ts?ki^Rb5&lI;N*T z``$KbIVA{Bh}bfG;_FT|O86RBG}a?3XBlrUBxulyC(queGtF9S zO){t!VJJ1ki{Pe$q$e=aV#3Xww>{$L)G_5R$>J#x@s(pcQC*Edm7`p)G6RN_<%aR1 zlrcY*<-yTV1Y`5oz|N@Ix%Z2HdL9K}l}h!R?YYs%JKIK#2e@NPY4*fc);!_$HPp*DI(xr z1PZinlXH+7Eln{Uq+2kL+a-j!%tw+=E&`;84PW{;*w0y>q)#2Qa5}ZeM%*3Uk`%*2 z37WOF?ZNNL&UftIj|HaP77X~SGiqL}_P@7|GFm4r)@9d9U>C&?5C!Ec1Yp{fzfyd< zsdUJs&-KRDzeUZfex&NIRqG86(B~F<`=KJEm#NraJ~83DdZ~CDnM=<%o$*mq2AldsYBHIlOXRdz zKAJUV_c48H!pp*!^sQ1&+CwE;M!sQss8t~l86Sp4I1vYRVnZOEDkC!S5sD#djwX}= zyw7T_0d~Q0A$j&HuQToS?S0g!X_PgcffO5{D*j=5lr$>J-U7ysI*f5w|uRa2ap&btT*WBhT61==u_2O+8*103d@DU*u;h6DNPq zUFj~&U>>ZB)`FYT$t!}ZSNCuK$A2nUtX1t@rGlg&%i)ea(2KPKL-MRI1@O(| zOXT=~B7vx87R%zALY$tYqLtFNJy~=J2*FRIHYK}$KI_vRNhFY_#6CQ%l!tx2BrU{h zpeF5rlswW4-ZjxEsz!Hy0%~P%1KoRRGNE&6XKy*O{Tfq3m)MP z4Pg=e@}`O-#*XKC3(JI^*wZUn-4mh2C*dn0t8A#zaCLd@WEVm8-xte558*kveLWccy!QD>rx&uTJ6t0tt{WvcQWY%dvAcP9R$|@ zLUhXDT+_1-rJ|JvfMIA_8B1$|*irIrmG4eCC^r~s^1zV|vx)|Y40G|XYCiMq!-}&K%bLA_{k%)x1J#aDEB10Lok4Dwh;{C-=D%%ZM zo3cvdO)-0kYiV*|0NzB?nM-!G++Pe(VO=AS*ndrQr4z>;J5+KyF)z&Hm2Kdi#*Y;{q$`~YGH#D7pDk4mbk!U`@gS;?3x4AtG|F z+t|Ie@MW==@K*DN&WPVP^-DXAg=WKU?T&%EM<(n9mS1L0`*hqqU6Fecp^q&BOYbys3;ZE`olBoD@xL;RxfvWR zU;ox1z}ww#Pe2UKv+OcdEh=KWwSWJfm$f3SL{+VyxIvC2 z%Go!Qc43zu;rgVL-8{^o)T&r$v$Ga`W30FZ{ZM%4&0j|PZ`zme{|k{rOCg}{Mh*#z zH95=5<~za#1`-aG1~=Y=3Jbq{A-!GHr{(QH;)71VUcdGU~IaiN$U9}r40O{!X4rJBYm!VeACN`41&lgfz2qhc1Izn z$?sJLxT)^suju|)*b51=fPvzQex~S}dDU{a)@A@(mQH+yBha7Lg46T41|VU{7_gUr zs}};bmnt%^4dAaVc6{dM!sR}W_z?o?^(&Tq&I-jaxl5h&hph^8(+*Hj+(?}!ekwa& zlvAzuVe27e!GMK+*%2sA#K+UkMcwPv=E5WY$gr1$O%TSR4ODRE);Oil5<)@G89+Et z6mTHW?sJS~U)KL)UkV>{<1HjE+1rg=%)2;V+Ffo3Ucio3>ANpamoHBOrOy7UW6U+w z`Z?(q+c(qzu zM0-Vh0SEdj9sr0cf6Q3qWk2JNg7AY+ZsZUbEm&ND4||*ooBFG!vVuwXP&+Ol0^O8Y zl>kb+5_JQnHyulL&^4h&oKUt~dt8);2RJm49Y8C6k9cREx`x$pE_PpI0{kSXOd$F9 z^iOw5UXj@&9jwz5-2nb_=S_s0y@@hffC2YTFO>_(T=fj{; zdhJZUj7qt6UC+6&BjQb7#|T4@`lFv5bb#Y81Vaa9?f$P^75x9Znak)Wh52BP0^8d& qwYUkP|M&O*M&SR4Bd`&DNfGcM?RL9m!5Q}Rl;oeul|Qiv`Tqc*iG@u7 diff --git a/docs/build/wallet.rs/1.0-rc.6/static/img/logo/favicon.ico b/docs/build/wallet.rs/1.0-rc.6/static/img/logo/favicon.ico deleted file mode 100644 index 8599d21378918697334f621d540a4e139bec165e..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 15086 zcmdU#3zSt=8OJZ8BEAOEcnQoP$SV~TLPTH&1OYWALe#<#OaX;JFcnP(!Wc}GQt}Co zVhK{Fk&2Q^sX?^lp-~nFqmD79>420oBg342zdLucPIujb86Cy`YyI4hv(Mh&{=RST zbD3o#(IC+<(Y`$sg zb+MoRdnD_&gTwaI`ZX=vfCqRmF%X*9FsK{-Pr_FCIXM3FqC5N zV%$mHeP>b^I==;zp;M*-_1t$m^99=~sgFvV-@N&KY>Z=9KqE+(N8>dJ^KGKuBYjXk zx4+GNRp6SX&>s$fqkz+x^z&TGFlHC^t09x_p)=SX$_1GQ)>S2HY&ky-cTE3=`l8XaVL&IM43&F$i{t@@Molg!)uJCi^vbCcWmA>#Hjv_}YBB z*v^zf&X1sNZu}FLKr2vF!FPh~)+a%IN?$C4u*Mx}lV1~i=9uwm&%Z!>ecG67Q)99y z&9%R#xQWv9Q=ig@KLl;l&odyd_B5V>cj0kp4RN)j@fL*rTRLBm{xP?tzVjxm(VWUv za0N60&#HBEyd~&I@4?`^kniT0_f8=M`~O9K7dG|jJ96J;~Ek85$|42LaTREH?d*T@g{#;5uZqMDZXCF}S5Bp2wSolLIfxa;# zPNKdX^mDx5A@@Mo+fM3v5Z3`T!nY#c|7p}4GwDD$74)(B{3YlK=9ACUbqXD;pa^aT zzZ-FR7q5fi&<32(-yHQVeKZ?pz~QOMJ$LVbcgGf^4rfZnM|FQ*K-VO{CFC1Ag2`YOnzu5_La#!bAJ=7Blro^FL( zK)=<8{9W)M+zb9@P?od6d!-pD?RWyhzHYQLO~%1*Lj{}(epBod?1*G2|J_oZj$HtkgE0+jQBA6p|N2fG*U6+YbQ)*(;GMAu9)NI1n7`kFabS!x$@}SN z;Cg?Bwh(0e?SCK4!MOCg!o)ZJ^aS{HT6S56@qyg_OOMzF;lMPzQb7if}GbF zn?LGoFc05?j<7dr=Oy47$pY61c2Z5=#XqKe4!&v!ngGH6r>VO?)eMaJ^RN{1Kso1p z*aS~OZ`hlRx3TyQ#C=M$M)l;$3$Ovsi;cRJda(6n>P^5Lodx$pxG$(C<=%}|{Jxt` zJIrBh^u>`-lgycHXi?LE4E;Z#FT{O0bS1 z*uygF2g3=l8n(j|&>EDsxgXDQkU8o%O&tdhz)T3adl+?nJqDUWy4-6Hc%ICSW56>X zZ1S5>lUzgpJPx-)J5aMByl;NFPc;Qzf&0L-V;(Jmm!J>mH{W|3j)%D1M}IJ{^-+*> zzX{vm+hE++Lsgj4gM>d4JK_A!`G?hwt-}rd$yid2L`gc(dhanJh!#sD+MerR6 z{->IZ*8<89p%k27HGw}sSj+jH!+31~_hF8u%lm3G>;UiCP7s&p=0~swW`enD?0*Zc z^)Bdd_p}21Mw|sI?uY80>fF%3!OpeRy(f%`cSh*{BlU1M7+*=B&;0fM@Q&pzkS=r4 zJ0X4+zexKU7zRF9Szye=IP>OwaGfBZuY<7WGU|;|56!8k;WuDR_a*oD7YK7%-k*9& zf9S^%;NEL1??mrA^V8@j|FQ1@P!+Q>U(9#n$sc)rgCH5<(5-S8kZ z2GtTy0`o{|uQ}Js2AT}|WD;BmOTqEAmA)DPJwYGrOXl9ipuJ~+vG**+V{E>5NU@sI zb9WnY z%M0K>zX4TX-`~J9>)E#LeR2kPE@nVCP(5HJoNXheT*@Nwy`6A1C}U<{;P2Es!^cru zUNR=$g~1lf*T6e-G3Yn#dlYU3;}&Fob%LR=2`+-5d#D5(Eq(5t=04*6@6tXI>Z%63 zU_N(+kmq3zb7U}>r$L?p^F)PmB6ag@8fcqig6^Oaw{s(H$GG0Bsb`)^_jw4^RfBlJ zd;C4P3l0ZmE}BR2Ty}q9k6)thdA$TY7n@-$q^l<#uYfk{Rfo2f*JIy`Hp>__O0w3p$@>)ijJNi7> z{|NhUlACpsU$6f|KU>WGoc#LR%rZUGLhTnm))RxY$1+>-sJqOH#m*Ed^ zGAQGx4{DOny2Dg(&)yTChRhH1KGPXrg3rM?@33IEWf@%XIk2m?CNyWD{(c=c!8H(m8&dth zkmn#9{KnVmo{f?sfKjw2B6?9Ye@=CoHD`NuyWov{`|mDImX+m|Q|&LmuDrS|FV9Vm zi^}sY%hueMe1B&_R&}|dx@6*2J}>PTEwL==9lc#$R#sX@l~oHZx8;`<7V;0oZPQDN zviV3x#nH}Hlpp4o7ne|0<(Egr_LoGJlFAvSC_#eyZ(wKSDW>2YdcM zttK=+nf(4Ak~W3ki(W7qTBJRz&!%U`-z`tVsj-RO>T9qY?t=Jl6m!?19zNT4gIp@)E6ZkuBC|nI!fj*xJ%V8L_ zhVY&C&e1OMw-gy$XX&@c;9+P6`gAya1Z6M;l)q=rhb`c@rxUn;PE&II6_ib(uJYe$ zoY3Uok=mtR_BY{r@b|0nSLWej2>TstC-QgeS3$qjRp!!hpkGe|_hgP;1o}mPcsHI4 z$HFMs3huuvd{PZ!0`q5LYNBzJ?(b=61p0gt*k^niLmLS3r}~N1leeD*_oX^OJ`Aye zT>pM>{YSv>g)-0kfOo|~@Nr~3UFXYS-TTEe)CH9P2GB0sUx920GSBaW>F|BfFUGPi z(ss|3`*NSxfw2htdY<}jFt>tS3B;_63ZBpd;kgZ3New_qh0Bh?n>gSm1R=nMB_ zUaSTCy?gEfZSuXa*Z)vAf5o#MS8p2Tk^6rH27&%^@4X;h*V0i5K3A^$H@LtCa!vEa z^J{J^?=jc*J@0d+t-)`erNh9y>Hy>5DQE%d>Osd%U_6e51L0V3{b|qy?f}=D4a)oV zdT{>3LHjns&%t-obsingp^cfOy}tV#v;o`B_Yn++_Anl@Azj-0I0S!ai@9<Z`&tN&HIF-i`Jz32!93UuL*W--pVAkzU?tdR zTz?DBGaoJlee^H{8J8D9zfBCCl%Cr;FbJ|>DZB*Q@=eGG=l5BNK@Rmd!1d-qV=%5C zfq7?4+^abrG@QyV@SP{Xx%9QZFb9H;pc2nL*EYv)2ji@KSG%5sKA>8`>EQdBWUjjI z>u@og1b)l)^#Cw;#=>!+?V~}T-3yCApN9BTP3DK=f=|9ceF9tr`XiIf@sOjZQGXxG z;2f9<`o{Qa-)@)=#>yN$1TKXxphm#U@DOOn9Ps@Q!Dsu@!3;PT9P1v2!gDYR+JI|! z24(x}ppD(2AuI>iGv?0o{Z!i+e+~AfuP|U4_^vX}M?(Y9f7+J=m%%q+1q9zwODhhW*6qhBid zRppT4Xe)ni$&IQms~QrORt~9(woa)WmLFBEWv!?(Kk`pH$uf#eY!fL5_WYef>uaZ; z4D)VO7sJiqSvUwz0>2A2$#GY}ozNeyfyLlG(F=;fJFX^O&V%uw4Sr`j!cbTXXTmMu zy^u-XQxo6}mwBME34SZ~ChwKe;N9&0y%W9*elwcFVDMhh51FK0+Bgvm!4KgC z@IDy{&gu8eyZ3NVSAlo3a?is-d&7A1OrP|FOW>?n>Am=5&=4Afzez5G^T4_Cz%`Wla20q zb%F1J`(6cVHh7-1VHjxV1)yz%AQzg$gOCU2k9%@m<@595MkoN+9|h*oSkPzg>mta5 z8DO5oxk> zInVLX6nrnJ50zrLB6QTTY|r?I!2Rt}w2B`*EBHg&Ym^Zedp>nb$lc9{k+O_m8il2l L_G7`jmbB%+YeIq9 diff --git a/docs/build/wallet.rs/1.0-rc.6/static/img/logo/wallet_light.png b/docs/build/wallet.rs/1.0-rc.6/static/img/logo/wallet_light.png deleted file mode 100644 index a5fb5757ae68f9f4483d0f0fddfef66568d30ddc..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1223 zcmV;&1UUPNP)EX>4Tx04R}tkv&MmKp2MKrfO9x4t5Z6$WWauh>AFB6^c+H)C#RSm|Xe?O&XFE z7e~Rh;NZ_<)xpJCR|i)?5c~mgb8}L3krKa43N2#1l(TvK>GUg;H3E%N`j{x8AVm!;g?$6Pu<}3yTMB-Uym^SeS@${x` zaNZ}5u%fIIpA(OnbV1@rt}7nDaW1$l@XUyrPR$cXh{Zx1D{ah*rbawP991=)@`a4Y zD(5ZETDi)a_v9}O=k%3juG1Pu0*hFJ1Q80VD4`4+G1_%fETrf>?&BYF{Svtpa+Scy zv49FR$gUs!4}SO7%1=&sN#Quq`QkVqBS2^uXw)3%``B?BCqVESxYAqxN*$Q_B)!(s zqDMggHgIv>(v&^mat9cEGGtSBr64UKp9kL0=$o>@z%9_b=Jl<4j?)JqO}$Fq00)P_ zXo0fVecs*O-nV~in*I9$5rT4n-ho7x00006VoOIv00000008+zyMF)x010qNS#tmY z4c7nw4c7reD4Tcy000McNlirunu~K~#9!?VCMMR6!JmA86Uw zSqLkUL?~$7O0d8ND2$3!QlNi81xtPhTH$JAX{XUxiSj38Eg&W$6h;zYOjwXbQQ3{-%sv31}XFqLO8BfuI^Kf^u& z!+C>q9oTIGPQ!MAi9BUaD{vb26S$lQK&x%QY1mpG7UX(|Ht93qUeAE$96aN0H)l}A zK?bdNGoS+pfDU{H+~eRGgTNi&CU6NT0(}|1fM38C@D+Fqyav8yl??;H3UK5gE7G!K z;FWoCUN!4zy7;nvV8$1m$L7t{BeP>*(MRUQ2h-($cN6O$Bg*|pDkL1&cboCcW3Qd)PP#OJIfWI5f5;p2DFNw%05a!)A;-J5#=r>-Fy83mPo#Z_q1qT zwTnr2XG^H1$4G1Nm^|_i~@zDqXNipuY1hgrP--`gyyfD7u(#a#__Low?a7w1gJuUVJE*)LO-au6f6pqwD zb%^5zDuCyf16Pft4`)2%g}VS;GqKbx@vfxde88;yu{Uw<(b?x)t8Nf>XMHnmz_-&* z<3-|aBwz3~*JmP|ZhOEj-wWb-k|xf>z_aFMCu@$2YP`t5ze5d~-&yTsRkO8kl60}Y lF~3zRl}e>jsZ=Vr`U@HXWlkUXN(cY|002ovPDHLkV1gK%HSqud diff --git a/docs/build/wallet.rs/1.0-rc.6/static/img/overview/iota_layers_overview.svg b/docs/build/wallet.rs/1.0-rc.6/static/img/overview/iota_layers_overview.svg deleted file mode 100644 index f6a65cb36de..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/static/img/overview/iota_layers_overview.svg +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/build/wallet.rs/1.0-rc.6/static/img/specs/erdIOTA.svg b/docs/build/wallet.rs/1.0-rc.6/static/img/specs/erdIOTA.svg deleted file mode 100644 index 2a17a6a32ee..00000000000 --- a/docs/build/wallet.rs/1.0-rc.6/static/img/specs/erdIOTA.svg +++ /dev/null @@ -1,485 +0,0 @@ - - - - - - - erdIOTA - - - A - A - cc - cc - ou - ou - n - n - t - t - - A - A - cc - cc - ou - ou - n - n - tID: - tID: - v - v - a - a - r - r - char(255) - char(255) - P - r - o - vide - r - : - v - a - r - char(255) - I - nd - e - x: i - n - t - A - lias: - v - a - r - char(255) - P - o - w - : - v - a - r - char(255) - Q - uorumSi - z - e: i - n - t - Q - ue - r - o - m - T - h - r - eshold: i - n - t - Ne - t - w - o - r - k - : - v - a - r - char(255) - T - ype: - v - a - r - char(255) - C - r - e - a - t - ed - A - t: D - a - t - e - Upd - a - t - ed - A - t: D - a - t - e - - - A - A - cc - cc - ou - ou - n - n - t_ - t_ - T - T - r - r - ansa - ansa - c - c - tions - tions - - - - A - A - cc - cc - ou - ou - n - n - t_Nodes - t_Nodes - - - - A - A - dd - dd - r - r - ess - ess - - A - A - dd - dd - r - r - ess: - ess: - v - v - a - a - r - r - char(255) - char(255) - I - nd - e - x: i - n - t - Checksum: - v - a - r - char(255) - Balan - c - e: i - n - t - - - Node - Node - - NodeId: - NodeId: - v - v - a - a - r - r - char(255) - char(255) - U - r - l: - v - a - r - char(255) - P - o - w - : - v - a - r - char(255) - U - se - r - name: - v - a - r - char(255) - P - ass - w - o - r - d: : - v - a - r - char(255) - Ne - t - w - o - r - k - : : - v - a - r - char(255) - - - T - T - r - r - ansa - ansa - c - c - tion - tion - - Hash: - Hash: - v - v - a - a - r - r - char(255) - char(255) - Si - g - n - a - tu - r - e - M - essage - F - r - a - g - me - n - t: - v - a - r - char(255) - A - dd - r - ess: - v - a - r - char(255) - V - alue: i - n - t - T - ag: - v - a - r - char(255) - T - imestamp: D - a - t - e - C - u - r - r - e - n - t - I - nd - e - x: i - n - t - Last - I - nd - e - x: i - n - t - BundleHash: - v - a - r - char(255) - T - run - k - T - r - ansa - c - tion: - v - a - r - char(255) - B - r - anc - h - T - r - ansa - c - tion: - v - a - r - char(255) - Non - c - e: - v - a - r - char(255) - C - onfi - r - med: boolean - B - r - oadcas - t - ed: boolean - - - - - - - - - - - - - - - - - - - - - - - - - - A - cc - ou - n - tID: i - n - t - A - cc - ou - n - tID: - v - a - r - char(255) - NodeID: - v - a - r - char(255) - A - cc - ou - n - tID: - v - a - r - char(255) - Hash: - v - a - r - char(255) - - diff --git a/docs/community/contribute-to-wiki/reference/style/form.md b/docs/community/contribute-to-wiki/reference/style/form.md index 37f562003b0..5c2a76ce376 100644 --- a/docs/community/contribute-to-wiki/reference/style/form.md +++ b/docs/community/contribute-to-wiki/reference/style/form.md @@ -145,7 +145,7 @@ If you have a long string of qualifiers, break it up into phrases instead. Use consistent [terminology](/learn/glossary) within a paragraph, article, project, and the whole Wiki. Avoid synonyms for technical terms unless you have mentioned that term beforehand and the relation is clear. -If you refer to an object by its name, provide a qualifying noun: "the `sidebar.js` file", "the iota.rs library". +If you refer to an object by its name, provide a qualifying noun: "the `sidebar.js` file", "the identity.rs library". #### Prefabricated Phrases diff --git a/docs/community/contribute-to-wiki/reference/style/mechanics.md b/docs/community/contribute-to-wiki/reference/style/mechanics.md index 73bd434b8b6..9516d8e290f 100644 --- a/docs/community/contribute-to-wiki/reference/style/mechanics.md +++ b/docs/community/contribute-to-wiki/reference/style/mechanics.md @@ -39,15 +39,15 @@ This case overrides other guidelines. ### IOTA Products -Refer to IOTA libraries by their filenames: iota.rs, wallet.rs, etc. Always use the lower-case notation. Note that it is harder to spot a sentence if it starts in lower case. Consider using the following clause instead: "The iota.rs library". +Refer to IOTA libraries by their filenames: idenity.rs, iota.go, etc. Always use the lower-case notation. Note that it is harder to spot a sentence if it starts in lower case. Consider using the following clause instead: "The identity.rs library". Other IOTA products have an actual name. Always capitalize it: "A Hornet node. Hornet and Identity." -Note that there are no determiners (the) when you refer to something by its name: "the iota.rs library" as in "the library named iota.rs", but simply "iota.rs". +Note that there are no determiners (the) when you refer to something by its name: "the identity.rs library" as in "the library named identity.rs", but simply "identity.rs". Good: -> The iota.rs library connects to a node. A node could be a Hornet node, but iota.rs handles both the same way. +> The identity.rs library connects to a node. A node could be a Hornet node, but identity.rs handles both the same way. This case overrides other guidelines. diff --git a/docs/get-started/faq.md b/docs/get-started/faq.md index 68476e84a8a..56ed973fdde 100644 --- a/docs/get-started/faq.md +++ b/docs/get-started/faq.md @@ -3,6 +3,5 @@ title: FAQ's description: Questions and answers collections. Clear outlined information for the most common questions around IOTA. --- -- [Mainnet FAQ](/introduction/explanations/faq/) - [Firefly wallet FAQ](/use/wallets/firefly/faq-and-troubleshooting) - [Identity FAQ](/identity.rs/faq/) diff --git a/docs/learn/protocols/chrysalis/core-concepts/EdDSA-support.md b/docs/learn/protocols/chrysalis/core-concepts/EdDSA-support.md deleted file mode 100644 index 9381ea626a2..00000000000 --- a/docs/learn/protocols/chrysalis/core-concepts/EdDSA-support.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -description: This article provides an overview of EdDSA and Ed25519 signature schemes, along with the benefits they bring to users, such as reusable addresses and reduced transaction size. -keywords: - [ - 'EdDSA', - 'Ed25519', - 'Reusable addresses', - 'Reduced transaction size', - 'Signature scheme', - 'Private keys', - ] ---- - -# EdDSA Support - -## What is EdDSA? - -The [EdDSA (Edwards-curve Digital Signature Algorithm)](https://en.wikipedia.org/wiki/EdDSA) is a modern and secure -signature scheme that uses operations on an Edwards curve, a special type of elliptic curve, -to provide robust cryptographic security. - -### Ed25519 Signatures - -Ed25519 is a specific instance of the EdDSA designed to offer a careful balance of performance, security, and practical -considerations. -Named after its use of a 255-bit Edwards curve, Ed25519 is one of the most popular choices for ensuring -message security in modern networking and storage applications. - -### Reusable Addresses - -One of the major benefits of supporting Ed25519 in a protocol is the introduction of _reusable addresses_. Unlike some -cryptographic systems that mandate a new address for every transaction, Ed25519 allows for re-using private keys. -This means that users can use the same address across multiple transactions, greatly simplifying the process of managing -transactions. - -### Reduced Transaction Size - -Additionally, Ed25519 helps in reducing the transaction size. Compared to other signature schemes, Ed25519 signatures -require significantly less data. This smaller transaction size translates directly into savings in network bandwidth -and faster processing times. This efficiency makes IOTA more scalable and accessible, -benefiting users who have network usage constraints or wish to minimize data transmission. - -:::tip Learn More - -You can learn more about the [Ed25519 signature in IOTA](/tips/tips/TIP-0014) in the [TIPS section](../tips.md). - -::: diff --git a/docs/learn/protocols/chrysalis/core-concepts/binary-transaction-layout.md b/docs/learn/protocols/chrysalis/core-concepts/binary-transaction-layout.md deleted file mode 100644 index 27511d98ac5..00000000000 --- a/docs/learn/protocols/chrysalis/core-concepts/binary-transaction-layout.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -description: This article explains the benefits of using binary transaction payloads over trinary ones, including improvements in computational efficiency, compatibility, and ease of integration. -keywords: - [ - 'Binary Transaction Payloads', - 'Trinary Transaction Payloads', - 'Computational Efficiency', - 'Compatibility', - 'Integration', - ] ---- - -# Binary Transaction Layout - -## Binary vs. Trinary - -In the past, IOTA used trinary data formats. -The decision was based on the fact that trinary logic systems can theoretically store and process information more -efficiently than binary systems. -However, in practice, the digital world is built upon binary logic, leading to trinary _data structure_ challenges, such as transaction payloads. - -Binary transaction payloads, on the other hand, align more closely with conventional technology standards, offering -several benefits over their trinary counterparts. - -## Computational Efficiency - -Most modern hardware, programming languages, and communication protocols are designed to operate on binary data. -Thus, when dealing with binary transaction payloads, these systems can process the data directly, -resulting in a smoother and more efficient computational process. -On the other hand, trinary payloads require conversion to binary before most systems can process them, leading to -additional computational overhead. - -## Compatibility and Interoperability - -Binary transaction payloads enhance compatibility and _interoperability_ with existing systems. -As most technologies used today are based on binary logic, -adopting binary payloads simplifies integration efforts and reduces the likelihood of compatibility issues. -This advantage makes it easier for developers and platforms to adopt and interact with IOTA using binary payloads. - -## Ease of Integration and Development - -The prevalence of binary systems also extends to development tools and libraries. -Developers have a wealth of resources and tools optimized for binary data, -which eases integration, boosts development speed, and reduces the chances of errors. -When using trinary payloads, the pool of available resources is significantly reduced, -potentially slowing development and increasing complexity. - -:::tip Learn More - -You can learn more about the [Binary to ternary conversion](/tips/tips/TIP-0005/), -[transaction payloads](/tips/tips/TIP-0007/), -and [Tangle messages](/tips/tips/TIP-0006/) in the [TIPS section](../tips.md). - -::: diff --git a/docs/learn/protocols/chrysalis/core-concepts/switch-to-UTXO.md b/docs/learn/protocols/chrysalis/core-concepts/switch-to-UTXO.md deleted file mode 100644 index 1bfe96a806b..00000000000 --- a/docs/learn/protocols/chrysalis/core-concepts/switch-to-UTXO.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -description: Learn about the switch from account balance models to Unspent Transaction Output (UTXO) in IOTA. -keywords: - [ - 'IOTA', - 'UTXO', - 'Balance Models', - 'Conflicts', - 'Reattachments', - 'Colored Coins', - ] ---- - -# Switch to UTXO - -UTXO means "unspent transaction output". -This means that instead of tracking the balances of addresses, you also keep track of where balances came from and -where they go when they are spent. - -## The Problem with the Balance Mode - -Before Chrysalis, IOTA used an account model to track balances. -This meant every address had a single value associated with it, its current balance. -This meant the ledger tracked **Address1**, which was associated with **Balance1**, **Address2** was associated with **Balance2**, and so on. - -### Double-spends - -The main problem with this model was dealing with double-spends, also known as conflicts. -It took a lot of work to determine which of multiple transactions performed a double spend and which used legitimate funds. - -## The UTXO Solution - -Since Chrysalis, IOTA switched to the UTXO model to keep track of balances. -This switch significantly improved how we identify conflicts and, therefore, also stops malicious actors from spending -newly received funds by reattaching an old transaction. - -### Parallel Validation of Transactions - -The UTXO model allows for parallel validation of transactions because it treats each -transaction output as an independent entity. -Instead of tracking account balances, the UTXO model monitors which outputs have been spent and which remain unspent. - -### Easier Double-Spend Detection - -The UTXO model ensures that each transaction output is used only once by requiring transactions to reference specific -unspent outputs. -If a transaction tries to use an output that's already been spent, it's immediately identifiable as a double-spend -attempt. - -### Replay Transactions - -With UTXO, if a transaction is replayed in an attempt to reattach it, the protocol will recognize it as a previously applied transaction, and it will have no further effects. - -### Support for Ed25519 - -An additional benefit is that the UTXO model supports [Ed25519 addresses](EdDSA-support.md), -meaning that addresses in Chrysalis are reusable and can be safely used to send funds more than once. - -:::tip Learn More - -You can learn more about the [switch to UTXO](/tips/tips/TIP-0007) and -[Ed25519](/tips/tips/TIP-0017/) in the [TIPS section](../tips.md). - -::: diff --git a/docs/learn/protocols/chrysalis/core-concepts/white-flag-consensus.md b/docs/learn/protocols/chrysalis/core-concepts/white-flag-consensus.md deleted file mode 100644 index fecfc40f618..00000000000 --- a/docs/learn/protocols/chrysalis/core-concepts/white-flag-consensus.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -description: This article provides an overview of the White Flag Consensus approach and its benefits in optimizing transaction confirmation and handling double spends. -keywords: - [ - 'White Flag Consensus', - 'Blockchain', - 'Transaction Confirmation', - 'Double Spends', - 'Conflict Resolution', - ] ---- - -# White Flag Consensus - -The White Flag Consensus is a novel approach to handling conflicts within a blockchain network, particularly for -transaction _confirmation_ and double-spend handling. - -In many blockchain systems, the threat of double spends - attempts to spend the same digital tokens more than once - -pose significant security concerns. White Flag Consensus offers an innovative solution to efficiently and -deterministically resolve these conflicts. - -## Key Aspects of White Flag Consensus - -Unlike traditional _consensus_ mechanisms that often require complex and resource-intensive calculations to decide which -of the _conflicting transactions_ to approve, White Flag Consensus simplifies this process. - -Under the White Flag approach, transactions are confirmed without any voting or other _consensus mechanism_ to decide -between conflicting transactions. Instead, it uses a deterministic method that decides the confirmation order of -transactions based on their appearance in the past milestone. In essence, it retroactively determines the -order of transactions, removing the need for decision-making during the _transaction confirmation_ phase. - -## Handling Double Spends - -In the case of double spends, White Flag Consensus chooses to approve the first transaction that does not conflict with -the transactions approved in the past. -Any conflicting transactions that appear later are automatically ignored and left unconfirmed. -This deterministic approach means that every node will reach the same state without communicating or coordinating. - -## Benefits of White Flag Consensus - -The White Flag Consensus approach offers several key benefits: - -1. **Efficiency**: By removing the need for _consensus_ voting, it can confirm transactions more quickly and with fewer - computational resources. - -2. **Predictability**: Its deterministic nature makes the __confirmation_ process_ predictable, as the state of the ledger - after confirming a milestone does not depend on the order in which transactions are processed. - -3. **Security**: It provides a robust mechanism for handling double spends, enhancing the network's security. - -:::tip Learn More - -You can learn more about the [White Flag Consensus in IOTA](/tips/tips/TIP-0002) in the -[TIPS section](../tips.md). - -::: diff --git a/docs/learn/protocols/chrysalis/introduction.md b/docs/learn/protocols/chrysalis/introduction.md deleted file mode 100644 index ea1610cd3f8..00000000000 --- a/docs/learn/protocols/chrysalis/introduction.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -description: This article introduces the IOTA Chrysalis protocol, including an overview of its functionality, purpose, and potential impact on the IOTA network. -keywords: ['IOTA', 'Chrysalis', 'Protocol', 'Network', 'Blockchain'] ---- - -# Introduction - -Blockchain technology is constantly evolving, seeking to address scalability, speed, and efficiency issues. In line -with these advancements, the IOTA Foundation has introduced a significant upgrade known as the Chrysalis protocol. - -## What is the IOTA Chrysalis Protocol? - -Chrysalis represents a significant update in the transition to IOTA 2.0, or Coordicide. -It incorporates many changes to improve network performance, security, and ease of use. - -Chrysalis is designed to address several existing limitations within the IOTA protocol and prepare the network for the -future removal of the Coordinator, a unique node currently providing network security. - -Chrysalis aims to make the network more robust and efficient, suitable for more extensive enterprise use and adoption. -It will also create a more user-friendly environment for developers to create applications on the IOTA network. - -## Key Features of Chrysalis - -**Efficiency**: The [transition from a ternary to a binary system](core-concepts/binary-transaction-layout.md) through -Chrysalis enhances computational efficiency and increases compatibility with standard hardware and software systems. - -**Security**: Chrysalis introduces [EdDSA signatures](core-concepts/EdDSA-support.md), -and [White Flag Consensus](core-concepts/white-flag-consensus.md) enhancing transaction security -and enabling the reusability of private keys and addresses. - -**Scalability**: Chrysalis allows IOTA to [switch to a UTXO model](core-concepts/switch-to-UTXO.md), ] -enhancing the network's ability to identify and resolve conflicts and improve scalability. - -**Ease of use**: The protocol upgrade will set the foundation for new tools, libraries, and software, making it -easier to build on the IOTA network. diff --git a/docs/learn/protocols/chrysalis/tips.md b/docs/learn/protocols/chrysalis/tips.md deleted file mode 100644 index 3bced98a613..00000000000 --- a/docs/learn/protocols/chrysalis/tips.md +++ /dev/null @@ -1,22 +0,0 @@ -# IOTA TIPs - -The following Tangle Improvement Proposals (TIPs) are currently implemented in the IOTA protocol. - -| # | Title | Description | Type | Layer | Status | Initial Target | -| --- | --------------------------------------------------- | -------------------------------------------------------------------------------- | --------- | --------- | ------ | -------------- | -| 1 | [TIP Process](/tips/tips/TIP-0001) | Purpose and guidelines of the contribution framework | Process | - | Active | - | -| 2 | [White Flag Ordering](/tips/tips/TIP-0002) | Mitigate conflict spamming by ignoring conflicts | Standards | Core | Active | Chrysalis | -| 3 | [Uniform Random Tip Selection](/tips/tips/TIP-0003) | Perform fast tip-selection to increase message throughput | Standards | Core | Active | Chrysalis | -| 4 | [Milestone Merkle Validation](/tips/tips/TIP-0004) | Add Merkle tree hash to milestone for local ledger state verification | Standards | Core | Active | Chrysalis | -| 5 | [Binary To Ternary Encoding](/tips/tips/TIP-0005) | Define the conversion between binary and ternary data | Standards | Core | Active | Chrysalis | -| 6 | [Tangle Message](/tips/tips/TIP-0006) | Generalization of the Tangle transaction concept | Standards | Core | Active | Chrysalis | -| 7 | [Transaction Payload](/tips/tips/TIP-0007) | UTXO-based transaction structure | Standards | Core | Active | Chrysalis | -| 8 | [Milestone Payload](/tips/tips/TIP-0008) | Coordinator issued milestone structure with Ed25519 authentication | Standards | Core | Active | Chrysalis | -| 9 | [Local Snapshot File Format](/tips/tips/TIP-0009) | File format to export/import ledger state | Standards | Interface | Active | Chrysalis | -| 11 | [Bech32 Address Format](/tips/tips/TIP-0011) | Extendable address format supporting various signature schemes and address types | Standards | Interface | Active | Chrysalis | -| 12 | [Message PoW](/tips/tips/TIP-0012) | Define message proof-of-work as a means to rate-limit the network | Standards | Core | Active | Chrysalis | -| 13 | [REST API](/tips/tips/TIP-0013) | Node REST API routes and objects in OpenAPI Specification | Standards | Interface | Active | Chrysalis | -| 14 | [Ed25519 Validation](/tips/tips/TIP-0014) | Explicitly define Ed25519 validation criteria | Standards | Core | Active | Chrysalis | -| 15 | [Dust Protection](/tips/tips/TIP-0015) | Prevent bloating the ledger size with to dust outputs | Standards | Core | Active | Chrysalis | -| 16 | [Event API](/tips/tips/TIP-0016) | Node event API definitions in AsyncAPI Specification | Standards | Interface | Active | Chrysalis | -| 17 | [Wotsicide](/tips/tips/TIP-0017) | Define migration from legacy WOTS addresses to post-Chrysalis Phase 2 network | Standards | Core | Active | Chrysalis | diff --git a/docs/learn/protocols/coordinator.md b/docs/learn/protocols/coordinator.md index 11bc1ab6c2e..87f92056224 100644 --- a/docs/learn/protocols/coordinator.md +++ b/docs/learn/protocols/coordinator.md @@ -17,7 +17,7 @@ and will be removed with the upcoming IOTA 2.0 update. The Coordinator is a [node plugin](https://github.com/iotaledger/inx-tendercoo) that sends signed blocks called milestones that nodes trust and use to confirm blocks and reach _consensus_. Blocks that are directly or indirectly referenced by a milestone block -are automatically deemed confirmed, though whether they mutate the ledger depends on the [White-Flag consensus](/learn/protocols/chrysalis/core-concepts/white-flag-consensus) +are automatically deemed confirmed, though whether they mutate the ledger depends on the [White-Flag consensus](/tips/tips/TIP-0002) approach. The current Coordinator is based on the Tendermint Core BFT consensus, which enables a committee of validators to operate as a distributed Coordinator. diff --git a/docs/learn/protocols/introduction.md b/docs/learn/protocols/introduction.md index b78a61d4fa7..b5e3423071b 100644 --- a/docs/learn/protocols/introduction.md +++ b/docs/learn/protocols/introduction.md @@ -20,7 +20,7 @@ This page provides an overview of the different IOTA protocol versions. | Name | Release Date | Description | Consensus | Features | Networks | | ------------------------------------------------------------ | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Legacy Trinary | 2016 | Based on a [probabilistic consensus algorithm using random walks on a DAG](https://assets.ctfassets.net/r1dr6vzfxhev/2t4uxvsIqk0EUau6g2sw0g/45eae33637ca92f85dd9f4a3a218e1ec/iota1_4_3.pdf), the original version of the IOTA protocol | [PoA - Coordinator](/learn/protocols/coordinator) | Bundles, trinary | - | -| [Chrysalis Phase 1](/learn/protocols/chrysalis/introduction) | August 2020 (IOTA Mainnet) | Replaced the heavy probabilistic consensus algorithm to use the [White-Flag approach](/learn/protocols/chrysalis/core-concepts/white-flag-consensus) instead | [PoA - Coordinator](/learn/protocols/coordinator) | White-Flag Confirmation | [Legacy IOTA Mainnet](/build/networks-endpoints#legacy) | -| [Chrysalis Phase 2](/learn/protocols/chrysalis/introduction) | April 2021 (IOTA Mainnet) | Switched from trinary to binary for data representation, changed from an account model to UTXO, removed Winternitz One Time Signatures (WOTS) and introduced EdDSA, _dust protection_ and a complete overhaul of all APIs | [PoA - Coordinator](/learn/protocols/coordinator) | Binary, EdDSA, UTXO, Removal of WOTS | [DevNet](/build/networks-endpoints#devnet) | +| _Chrysalis_ Phase 1 | August 2020 (IOTA Mainnet) | Replaced the heavy probabilistic consensus algorithm to use the [White-Flag approach](/tips/tips/TIP-0002) instead | [PoA - Coordinator](/learn/protocols/coordinator) | White-Flag Confirmation | [Legacy IOTA Mainnet](/build/networks-endpoints#legacy) | +| _Chrysalis_ Phase 2 | April 2021 (IOTA Mainnet) | Switched from trinary to binary for data representation, changed from an account model to UTXO, removed Winternitz One Time Signatures (WOTS) and introduced EdDSA, _dust protection_ and a complete overhaul of all APIs | [PoA - Coordinator](/learn/protocols/coordinator) | Binary, EdDSA, UTXO, Removal of WOTS | [DevNet](/build/networks-endpoints#devnet) | | [Stardust](/learn/protocols/stardust/introduction) | September 2022 (Shimmer), October 2023 (IOTA Mainnet) | Upgraded the ledger to support multiple assets instead of just the base token, switched the dust protection to a more granular one based on exact byte costs, renamed vertices from "messages" to "blocks", introduced concepts such as `FoundryOutput`, `AliasOutput` and `NFTOutput`. Also added the foundation for ISC anchoring via `AliasOutput`s. | [PoA - Coordinator](/learn/protocols/coordinator) | Multi-Asset Ledger, ISC support, Byte Cost Based Dust Protection, Blocks as vertices, Bech32 addresses | [IOTA Mainnet](/build/networks-endpoints#iota-mainnet), [Shimmer](/build/networks-endpoints#shimmer), [Public Testnet](/build/networks-endpoints#public-testnet) | | IOTA 2.0 | - | The upcoming version of IOTA running under a dPoS scheme with a leaderless consensus algorithm called On-Tangle-Voting. Introduces the concept of mana, which is a resource used to pay for network utilisation. | PoS - OTV | Mana, Staking, PoS, AccountOutput, ICCA | - | diff --git a/docs/learn/protocols/iota2.0/core-concepts/consensus/preliminaries.md b/docs/learn/protocols/iota2.0/core-concepts/consensus/preliminaries.md index 2f903cec59a..b6711205d24 100644 --- a/docs/learn/protocols/iota2.0/core-concepts/consensus/preliminaries.md +++ b/docs/learn/protocols/iota2.0/core-concepts/consensus/preliminaries.md @@ -210,7 +210,7 @@ then the node generates the commitment of the required slot. ### Reality-based UTXO ledger -As [Chrysalis](../../../chrysalis/introduction.md) and [Stardust](../../../stardust/introduction.md), IOTA 2.0 uses the Unspent Transaction Output (UTXO) model for transactions. Its _parallel processing_ capability allows independent transactions to be added to the ledger in any order, thus enhancing its scalability potential. +As _Chrysalis_ and [Stardust](../../../stardust/introduction.md), IOTA 2.0 uses the Unspent Transaction Output (UTXO) model for transactions. Its _parallel processing_ capability allows independent transactions to be added to the ledger in any order, thus enhancing its scalability potential. However, the append-only nature of the UTXO ledger can compromise this benefit when _conflicting transactions_ arise. To address this issue, IOTA 2.0 uses an enhanced UTXO ledger model, called the [reality-based UTXO ledger](preliminaries.md#reality-based-utxo-ledger), that optimistically updates the ledger and maintains a record of the dependencies of possible conflicts. diff --git a/docs/learn/protocols/stardust/core-concepts/output-unlock-conditions.md b/docs/learn/protocols/stardust/core-concepts/output-unlock-conditions.md index e6955045bb5..34a30102aac 100644 --- a/docs/learn/protocols/stardust/core-concepts/output-unlock-conditions.md +++ b/docs/learn/protocols/stardust/core-concepts/output-unlock-conditions.md @@ -19,7 +19,7 @@ they have to satisfy all unlock conditions that are defined on them. ## Address -Outputs are locked under addresses that can be unlocked via a signature. [Chrysalis](../../chrysalis/introduction.md) supports only this kind of output unlocking. +Outputs are locked under addresses that can be unlocked via a signature. ## Storage Deposit Return diff --git a/docs/learn/protocols/stardust/introduction.md b/docs/learn/protocols/stardust/introduction.md index 4aa229f16c9..905ac1fad89 100644 --- a/docs/learn/protocols/stardust/introduction.md +++ b/docs/learn/protocols/stardust/introduction.md @@ -15,7 +15,7 @@ keywords: # Introduction Stardust represents the next phase in the IOTA protocol. -While [Chrysalis](../chrysalis/introduction.md) focused on token transfers, Stardust introduced +While _Chrysalis_ focused on token transfers, Stardust introduced advanced functionalities to the ledger, broadening IOTA's utility and scope. ## Multi Asset Ledger diff --git a/docs/learn/protocols/stardust/tips.md b/docs/learn/protocols/stardust/tips.md index aa3a22cfcc0..c1cacd6162b 100644 --- a/docs/learn/protocols/stardust/tips.md +++ b/docs/learn/protocols/stardust/tips.md @@ -3,7 +3,7 @@ The following Tangle Improvement Proposals (TIPs) are currently implemented in the Stardust protocol. The _Status_ of a TIP reflects its current state with respect to its progression to being supported on -the [IOTA](../chrysalis/introduction.md) mainnet. +the [IOTA](../stardust/introduction.md) mainnet. - `Draft` TIPs are work in progress. They may or may not have a working implementation on a testnet. - `Proposed` TIPs are demonstrated to have a working implementation. These TIPs are supported on Shimmer, the staging diff --git a/docs/learn/sidebars.ts b/docs/learn/sidebars.ts index 8560b796872..398eb0bc609 100644 --- a/docs/learn/sidebars.ts +++ b/docs/learn/sidebars.ts @@ -15,25 +15,6 @@ module.exports = { label: 'The Coordinator', id: 'protocols/coordinator', }, - { - type: 'category', - label: 'Chrysalis', - collapsed: true, - items: [ - 'protocols/chrysalis/introduction', - { - type: 'category', - label: 'Core Concepts', - items: [ - 'protocols/chrysalis/core-concepts/white-flag-consensus', - 'protocols/chrysalis/core-concepts/switch-to-UTXO', - 'protocols/chrysalis/core-concepts/EdDSA-support', - 'protocols/chrysalis/core-concepts/binary-transaction-layout', - ], - }, - 'protocols/chrysalis/tips', - ], - }, { type: 'category', label: 'Stardust', diff --git a/docs/maintain/chronicle/0.3/docs/config_reference.md b/docs/maintain/chronicle/0.3/docs/config_reference.md deleted file mode 100644 index 40097c5ac84..00000000000 --- a/docs/maintain/chronicle/0.3/docs/config_reference.md +++ /dev/null @@ -1,96 +0,0 @@ -# Config Reference - -## `storage_config` - -### `keyspaces: Vec` - -Multiple keyspaces can be configured in order to filter incoming messages. If the `filter` feature is not used, _only the first configured keyspace will be considered_ or the default (`chronicle`) if none is provided. - -In addition to the keyspace name, each requires a map of datacenters (name -> replication factor). See [here](https://university.scylladb.com/courses/scylla-essentials-overview/lessons/architecture/topic/datacenter/) for more information about datacenters in ScyllaDB. - -### `listen_address: String` - -The scylla.rs dashboard listen address, where it accepts requests to manage the Scylla cluster. - -### `thread_count: Enum` - -The number of threads Scylla will use. Can be one of `Count(usize)` (a simple scalar count) or `CoreMultiple(usize)` (a multiple of the number of cores the system has). - -### `reporter_count: u8` - -The number of reporters Scylla will spawn. - -### `local_datacenter: String` - -The Scylla local datacenter. - -### `partition_config` - -Specifies the number of partitions to use in the database, as well as the number of milestones to use as chunks. - -NOTICE: You can't change `partition_config` in future without migration. - -## `api_config` - -Nothing at the moment, please refer to [.env](https://github.com/iotaledger/chronicle.rs/blob/main/.env). - -## `broker_config` - -### `websocket_address: String` - -The Broker dashboard listen address, where it accepts requests to manage the broker topology. - -### `mqtt_brokers: Vec` - -- Messages: mqtt topic used to receive incoming IOTA messages; -- MessagesReferenced: mqtt topic used to receive incoming metadata; - -NOTICE: You should at least have one of each. - -### `api_endpoints: Vec` - -IOTA node-endpoints used by chronicle to fill gaps. - -### `retries_per_endpoint: u8` - -Max number of retries to retrieve something from `api_endpoints`. - -### `retries_per_query: usize` - -Max number of retries to fetch/insert something from/to`scylla`, before declaring an outage, which will force the broker application to pause and await for scylla cluster to recover. - -### `collector_count: u8` - -The number of concurrent collectors which collect data from feed sources also it's used as solidifier_count. - -### `requester_count: u8` - -The number of concurrent requesters per collector. - -NOTE: requesters are used by collector to fetch missing data from `api_endpoint` - -### `request_timeout_secs: u64` - -The `api_endpoint` request timeout. - -### `parallelism: u8` - -The max number of concurrent solidify requests. - -### `sync_range: Option` - -Identiy the milestone data sync range from/to. - -### `complete_gaps_interval_secs: u64` - -Interval used by syncer to check if there are some gaps to fill/complete. - -### `logs_dir: Option` - -If provided, it will archive the milestone data in ordered fashion. - -### `max_log_size: Option` - -The upper limit of the log_file_size. - -NOTE: Ensure to use a limit within your filesystem range. diff --git a/docs/maintain/chronicle/0.3/docs/contribute.md b/docs/maintain/chronicle/0.3/docs/contribute.md deleted file mode 100644 index a154b8d6db2..00000000000 --- a/docs/maintain/chronicle/0.3/docs/contribute.md +++ /dev/null @@ -1,3 +0,0 @@ -# Contribute - -If you want to contribute to Chronicle, consider posting a [bug report](https://github.com/iotaledger/chronicle.rs/issues/new?template=bug-report-for-chronicle.md), [feature request](https://github.com/iotaledger/chronicle.rs/issues/new?template=feature-request-for-chronicle.md) or a [pull request](https://github.com/iotaledger/chronicle.rs/pulls). Please read our [contributing guidelines](https://github.com/iotaledger/documentation/blob/develop/.github/CONTRIBUTING.md) first. diff --git a/docs/maintain/chronicle/0.3/docs/getting_started.md b/docs/maintain/chronicle/0.3/docs/getting_started.md deleted file mode 100644 index 1bae6d1eedc..00000000000 --- a/docs/maintain/chronicle/0.3/docs/getting_started.md +++ /dev/null @@ -1,79 +0,0 @@ -# Getting Started - -## Prerequisites - -To run Chronicle, you need the following: - -- A Linux LTS operating system such as [Ubuntu](https://ubuntu.com/download#download) - -- 4 GB RAM - -- At least 32 GB of disk space - -- 64-bit processor - -- Preferred a 10 Gbps network connection - -- At least 2 CPU cores (recommended) - -- [Rust](https://www.rust-lang.org/tools/install) - -- At least one Scylla node (version 4 or greater) running on a different device in the same private network as Chronicle. See the [Scylla documentation](https://docs.scylladb.com/getting-started/) for a tutorial on setting one up. For information about securing your Scylla nodes, see the [Scylla security documentation](https://docs.scylladb.com/operating-scylla/security/). - -- The `build-essentials` packages - - You can install these packages for Debian based distros, using the following command: - - ```bash - sudo apt-get install build-essential gcc make cmake cmake-gui cmake-curses-gui pkg-config openssl libssl-dev - ``` - - For other Linux distros, please refer to your package manager to install the build-essential pkgs - -- (Optional) An IDE that supports Rust autocompletion. We recommend [Visual Studio Code](https://code.visualstudio.com/Download) with the [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=matklad.rust-analyzer) extension - -- If you want to load historical transactions into your permanode, you can download the files from the [IOTA Foundation's archive](https://dbfiles.iota.org/?prefix=mainnet/history/). - -We also recommend updating Rust to the latest stable version: - -```bash -rustup update stable -``` - -## Installation - -Either download the provided executable (you should only do this if you do not wish to use the filtering functionality), or build it yourself. - -### Building Chronicle - -Clone this repository: - -```bash -git clone https://github.com/iotaledger/chronicle.rs -``` - -```bash -cargo build --release -``` - -If you wish to use the filter functionality, enable the `filter` feature in [chronicle](https://github.com/iotaledger/chronicle.rs/blob/main/chronicle/Cargo.toml) - -```bash -cargo build --release --features filter -``` - -### Configuring Chronicle - -Chronicle uses a [RON](https://github.com/ron-rs/ron) file to store configuration parameters, called `config.ron`. An example is provided as [config.example.ron](https://github.com/iotaledger/chronicle.rs/blob/main/config.example.ron) with default values. See Config Reference for more details about the config file. - -### Running Chronicle - -See [Building Chronicle](#building-chronicle). - -```bash -cd target/release && cp /path/to/your/config.ron ./ -``` - -```bash -cargo run --release -``` diff --git a/docs/maintain/chronicle/0.3/docs/welcome.md b/docs/maintain/chronicle/0.3/docs/welcome.md deleted file mode 100644 index ca3a46eef77..00000000000 --- a/docs/maintain/chronicle/0.3/docs/welcome.md +++ /dev/null @@ -1,28 +0,0 @@ -# Welcome - -Chronicle provides tools for managing and accessing permanode solutions using the IOTA actor framework [backstage](https://github.com/iotaledger/backstage). With Chronicle, you can: - -- Store IOTA messages in real time, using one or more [Scylla](https://www.scylladb.com/) clusters -- Explore stored messages using an HTTP API -- Store the data you want by modifying incoming messages -- Filter data to store it how and where you want (work in progress) - -:::note - -This is alpha software, so there may be performance and stability issues. Please report any issues in our [issue tracker](https://github.com/iotaledger/chronicle.rs/issues/new). - -::: - -## Project Structure - -Chronicle includes the following crates: - -- Chronicle: The entry point for the Chronicle application -- API: API that allows you to access stored messages -- Broker: Allows subscribing to incoming messages from IOTA nodes -- Storage: Implements storage related functionality from [scylla.rs](https://github.com/iotaledger/scylla.rs) -- Filter: A simple container for user modified code - -## Join the Discussion - -If you want to get involved in the community, need help with getting set up, have any issues related to Chronicle, or just want to discuss IOTA, Distributed Registry Technology (DRT) and IoT with other people, feel free to join our [Discord](https://discord.iota.org/). diff --git a/docs/maintain/chronicle/0.3/sidebars.js b/docs/maintain/chronicle/0.3/sidebars.js deleted file mode 100644 index 6e101b8e6bc..00000000000 --- a/docs/maintain/chronicle/0.3/sidebars.js +++ /dev/null @@ -1,35 +0,0 @@ -/** - * Creating a sidebar enables you to: - - create an ordered group of docs - - render a sidebar for each doc of that group - - provide next/previous navigation - - The sidebars can be generated from the filesystem, or explicitly defined here. - - Create as many sidebars as you want. - */ - -module.exports = { - docs: [ - { - type: 'doc', - id: 'welcome', - label: 'Welcome', - }, - { - type: 'doc', - id: 'getting_started', - label: 'Getting Started', - }, - { - type: 'doc', - id: 'config_reference', - label: 'Config Reference', - }, - { - type: 'doc', - id: 'contribute', - label: 'Contribute', - }, - ], -}; diff --git a/docusaurus.config.js b/docusaurus.config.js index 772087e4b4d..54475f71726 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -53,11 +53,7 @@ module.exports = async () => { '^(/[^/]+)?/build/.*|' + '^(/[^/]+)?/iota-sdk/.*|' + '^(/[^/]+)?/identity.rs/.*|' + - '^(/[^/]+)?/iota.rs/.*|' + - '^(/[^/]+)?/iota.js/.*|' + - '^(/[^/]+)?/wallet.rs/.*|' + '^(/[^/]+)?/stronghold.rs/.*|' + - '^(/[^/]+)?/streams/.*|' + '^(/[^/]+)?/wasp-cli/.*|' + '^(/[^/]+)?/wasp-wasm/.*|' + '^(/[^/]+)?/wasp-evm/.*', @@ -69,8 +65,7 @@ module.exports = async () => { '^(/[^/]+)?/maintain/.*|' + '^(/[^/]+)?/hornet/.*|' + '^(/[^/]+)?/wasp/.*|' + - '^(/[^/]+)?/chronicle/.*|' + - '^(/[^/]+)?/goshimmer/.*', + '^(/[^/]+)?/chronicle/.*', }, ]; @@ -254,17 +249,6 @@ module.exports = async () => { id: 'openapi', docsPluginId: 'apis', // e.g. "classic" or the plugin-content-docs id config: { - coreApiChrysalis: { - specPath: - 'https://raw.githubusercontent.com/iotaledger/tips/main/tips/TIP-0013/rest-api.yaml', - outputDir: path.resolve( - __dirname, - 'docs/build/apis/docs/core/v1', - ), - sidebarOptions: { - groupPathsBy: 'tag', - }, - }, coreApiShimmer: { specPath: 'https://raw.githubusercontent.com/iotaledger/tips/main/tips/TIP-0025/core-rest-api.yaml', @@ -338,10 +322,6 @@ module.exports = async () => { // Version redirects are only used to asign paths with the actual version to the "current" version ...buildMainVersionRedirects, ...maintainMainVersionRedirects, - { - from: '/develop/nodes/rest-api', - to: '/apis/core/v1', - }, { from: '/shimmer/chronicle', to: '/chronicle/1.0-rc.1', @@ -358,10 +338,6 @@ module.exports = async () => { from: '/shimmer/develop/nodes/core-rest-api', to: '/apis/core/v2', }, - { - from: '/shimmer/goshimmer', - to: '/goshimmer', - }, { from: '/shimmer/hornet', to: '/hornet', @@ -380,11 +356,11 @@ module.exports = async () => { }, { from: '/shimmer/iota.js', - to: '/iota.js', + to: '/iota-sdk', }, { from: '/shimmer/iota.rs', - to: '/iota.rs/2.0-rc.7', + to: '/iota-sdk', }, { from: '/shimmer/smart-contracts/guide/chains_and_nodes', @@ -424,7 +400,7 @@ module.exports = async () => { }, { from: '/shimmer/wallet.rs', - to: '/wallet.rs/1.0-rc.6', + to: '/iota-sdk', }, { from: '/shimmer/learn/governance/', diff --git a/src/components/HomeLayout/AppLibrariesSection.tsx b/src/components/HomeLayout/AppLibrariesSection.tsx index 5030f8457e0..8184ac5e19d 100644 --- a/src/components/HomeLayout/AppLibrariesSection.tsx +++ b/src/components/HomeLayout/AppLibrariesSection.tsx @@ -1,8 +1,11 @@ +import AppLibImg from '@site/static/img/homepage/section_application_libraries.png'; +import AppLibImgDark from '@site/static/img/homepage/section_application_libraries_dark.png'; +import ThemedImage from '@theme/ThemedImage'; import React, { FC } from 'react'; import Link from '@docusaurus/Link'; import icons from '@site/src/icons'; -const { Identity, SmartContracts, Streams, Stronghold } = icons; +const { Identity, SmartContracts, Stronghold } = icons; interface LanguagesProps { languages?: { [key: string]: string }; @@ -59,31 +62,14 @@ const LibrariesSection: FC = () => (
-
-
-
-
- -
- -
-

Streams

-

- The IOTA Streams framework provides a secure protocol for message - verification and protection using the Channels protocol for flexible - structuring of channels, publishers and subscribers. -

- - Try out Streams - -
+
+
diff --git a/static/img/libraries/accounts_addresses.svg b/static/img/libraries/accounts_addresses.svg deleted file mode 100644 index 961455d5653..00000000000 --- a/static/img/libraries/accounts_addresses.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/static/img/libraries/address_generation.svg b/static/img/libraries/address_generation.svg deleted file mode 100644 index 164b844d4bb..00000000000 --- a/static/img/libraries/address_generation.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
Generating IOTA/Shimmer addresses using derivation path
Generating IOTA/Shimmer addresses using derivation path

Master Node

Master Node

Root (seed-based)

Root (seed-based)
ADDRESS LEVEL [0...n]
ADDRESS LEVEL [0...n]
CHAIN LEVEL [0,1]
CHAIN LEVEL [0,1]
ACCOUNT LEVEL [0...n]
ACCOUNT LEVEL [0...n]
HMAC-SHA512
HMAC-SHA512
Child Key Derivation Function
BIP32 hardened
Child Key Derivation Function...
Child Key
Derivation Function
Child Key...
Independent address/key pool
Independent address/key pool
Independent address/key pool
Independent address/key pool
Independent address/key pool
Independent address/key pool
ACCOUNT 0
ACCOUNT 0
CHAIN = 0
CHAIN = 0
CHAIN = 1
CHAIN = 1
Adr 0
Adr 0
Adr 1
Adr 1
Adr ...n
Adr ...n
Adr 0
Adr 0
Adr 1
Adr 1
Adr ...n
Adr ...n
Independent address/key pool
Independent address/key pool
Independent address/key pool
Independent address/key pool
Independent address/key pool
Independent address/key pool
ACCOUNT  ...n
ACCOUNT  ...n
CHAIN = 0
CHAIN = 0
CHAIN = 1
CHAIN = 1
Adr 0
Adr 0
Adr 1
Adr 1
Adr ...n
Adr ...n
Adr 0
Adr 0
Adr 1
Adr 1
Adr ...n
Adr ...n
Source: BIP32, simplified by author
Source: BIP32, simplified by authorText is not SVG - cannot display \ No newline at end of file diff --git a/static/img/libraries/layered_overview.svg b/static/img/libraries/layered_overview.svg deleted file mode 100644 index 36bcbb564fa..00000000000 --- a/static/img/libraries/layered_overview.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -

TITLE

TITLE
IOTA NETWORK
IOTA NETWORK
APPLICATIONS
APPLICATIONS
iota.rs
[official client library]
iota.rs...
communication layer
[network]
communication layer...
Node software
[Hornet | Bee]
Node software...
Mainnet
Mainnet
Devnet
Devnet
python
binding
python...
node.js
binding
node.js...
java
binding
javabinding
wasm
binding
wasm...Text is not SVG - cannot display \ No newline at end of file diff --git a/static/img/libraries/messages_in_tangle.svg b/static/img/libraries/messages_in_tangle.svg deleted file mode 100644 index 9956c1df552..00000000000 --- a/static/img/libraries/messages_in_tangle.svg +++ /dev/null @@ -1,530 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Layer 1 - - - - - Message - - - Payloads - - id - - Nonce (POW) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - inclusion state - - parents - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Messages in Tangle - - - \ No newline at end of file diff --git a/static/img/libraries/screenshot_faucet.png b/static/img/libraries/screenshot_faucet.png deleted file mode 100644 index c1790c34a1fe778cc34f23be0d6594243c2e191e..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 32652 zcmeFZXH-+$7cYv(!ch)z6cGgh6~O}>K&45If{2QM)X*a$H54fUNr0#*s0gSCNbjA5 z5+D#rBA_5O)Pzt4q=Y2&1PCO#@&E3BjQ8b@_ddMw#<*|X4;gFkwa40XuDRx#<+tX} z+lOYxf+xgJ@bU2p-n)C-l8^5&n2+z!z@Nu>J%B5l!o22Cu%)p9AF}^Eg?Dqr^Oor? zKE9enfdkj0y!+!%@7f3R@d>s6{vGNJD1E}m2fujl_ATpYF7&D6k4`Vl?rcaOzjyb- z>|Z}F=3e+i;f+IUd2W5Sk_*BHJnFN6@YI8rj-K%bk2Xjl92n+QKY=+@(a+GI7B{ty zoc!a+pTG;RZmuT1+6m82yBDe%cDL=_OrkPDH+YTqL=~@#B81vC_>!d#@p$3OzaOg? z1NiIr<(pI2qK^OP;?gVi|Fj1GU$vmU>V{u&ANXU*A8YQ^Xn>|;!=>r zjZUf66=8kOr^jw?+o*d>)E=92<0|x@nJZFqp6E$y3|IroP9y(=sY$v$AuU=Wk zYU>R0X*;-&BXn-WJWD5RD6sQp-{AYuI^ED8$ zuUnb?IR#vU6%48jlPFBC@y<9V{p>kt>-6a}71757#SVTchsFI$D|ru@r*AHCcQySR z!>U%HiytSPe!!OBraGBSF#uWwQ?R@Q5y>7k^xypm3-ArK%TNu=b9qL=cXv-OB$oBX z5PLOZhSfWFpm?a=YFAkU+9TXnUnVNa?i2)R1rN+uY~`B z^jhP62@TICV&)buIA89(ri13x-kW|F(~gwSIC!rGJx~Dv?+1Od?-XLJP4pCf7X6^s3+6+);!U!jsX&tr26)G{uc*m02nEfkr;ehzRNFIGbKHcvGwSXjqsVFb;DyTW7lLt#_x5O0uzzid%M?^ zX{S>^%WGB*M0(Ia!g1xngv#T8mFYEmPY%jBQ!~^z2U?N-I!ctY64Z|R&r`*Ic_`j| zZ!nfqXfad~@e$u2O|#`&PF}T$mk^3SF>K|Po6`qWj`u{eV{YAcyuXvl7-5yXmW4uF zCx~l(lb(oRhU*>>NY)lLjx*N?u$x?K#6-1ChAQef&wBFR)bZMxxBy581v}2YG*Wcl z4POaBuOLA#tBJ`mg6DpA`%Q$|qO;@mec!A$?is&Jq%Ipg{Mu0Md@wu%?#{{C=q%N? zrU_K_vl=l*^d-_kZdYDUe^`&YSmUg_B9T&$_VEWyiqW?I^bfC_rRf6BPdLiZm)3ct z`RWj%!e9Vy`7cuV8$X-o<(7aww<2|_1{J-dXA`OO(?*kR4?LjhBkYoAF?6&uYi%s8 zqi%gfHZv|x?X2S&i<#m6*;&n-&SawRhnlRn zcB{eOGdFq#HIoH>nJ8Z(juSDKDSW1BsKIC4765}So{ZxEhe^Eqn<>AFsdfkaVJK$p zVe?jsiL-#^*Xi+H@+URD-ESt-Z-k;wip)Ed50L@}iu$L zm$^#LvVR^e(>l1>H7KkOeAZRvIAyQ{Ts35 z6ck;j#mvIM@tC=KYhP`Z;{f!xP0jVAp{6fLKcg9u4$nzTLt94)yTqE+=3yLc%*+ydmB1xY*rL=lk6OIDV!+CG_t(hniyyNc)!l1kkk)tcBV?$%6c$(RftP zZhYeMZ=J8piabT6A>Q4(P%W7-Mkpq)nZo9qnjxI9&gP92_U7W(+(VI0-T?)Fy(Dj` z^abXvW#geQ2&|r&67YD%nhkuF&Z_7qeH%^~cE+=6D$ug~_FB}8PPH{==iOF%QY&jb z$xmIt-w075^Kt7SkZJoP2B#y$qx^N+8(rk}&E z=9-j$_Lnc|Q#EM4Y4*>pD1?9P`4LdosX6t>V>f}Ix{&&5_R|`d2=?KfJq?Kyp7`dQ zB$sfckWNT-MhW88vDB1?@}rntbkJ(t)zcwTj~xeAR?dH)K5;H&-N0Ce$H2`A@6>7! z9nS7v02i6c-O6ib1ctd6$z^j)`*xR{S)6ajIZjghO;wxkrjVM(Fo6O;NJS471-M2n z8>%22xGZHs@+HEymt8T7ou17?cYV>^odX6a-RF`ShZ(r$zu%-e@wzLoxQzgFZlkLDvdN!gVS6X|Tu7Dogm0vtNu3kjPW zOX=ShgRh;2m{KZr{4uw$By6=22~q57B$jb8IeGMm#)QR>4kde}=DqztPoGX{bo|$( zyW5%F+UePta5p<@S3^?&;DRO+adg%v;P8V1lf@6MF2*wS)?-y#(olp?JmkaUXzz8= z!>vHk-!u1ert?&9saxuR4Po^-la`lAoUhW3?J>2lbE<;S`evNrVdz|1n*YHLPR9js zW9f9chpCX_jCrSPTb*Xer=J9=RH zLPk{Q1)hiZ3Z$m{*$8Owdadr%(FG@FO{xh17N-o!v%DNcNho~BrYf1o(^pQVbDP7@ z>RCwGX5hYQ>au}I_pxo0(JW2Sine48E!9Ihtk)H@Q^mDpCOB#KhjwvGW;oVh)$0rr z7e7kB6WQnae5p69ET#QQ=ds{nMDIps+_K%?)ThCkLkOH!R(zR?CGE z@S;x1BM%)y>Pu4YT0YmZDXZ zZ;D?L3VUaqfF`Fj))>bR1i%B+_A@6EGM%s+Om3a7AGSkU(?L?F1LHm(C#W^U#NQa7 zmKvK>Noc?-9+Qk1`-w(l?`zmBr#|9W@-RL5$_jT`;`gFNTAU=(=+V*qQa@w-_$I2g zDlkd$ipu)!^-QNtY(O*gXQ@T(G9k8>#p6r4QH^#gdRj(e*|1swaKD*V z`*u{x49{Y7)wRBjeck?s;s&-Gzt?TNhrZO1!onSCzSaQzkt+fJpG2K`M3whjy^%2Z zL=hf)bh8W3xgRL0Q=b1AedjNU!Wqt7kS4wDo>d4bCx@B3IYvZ%89U3~$^&60b9Nn9HTv(sP&Q#9XnRs1;F>_j5EdePtiJ#^sLL0 zd9%GqefO@KS(Q37su&RU3)eedJGDP^kYNmAs7ODBP=~)OCW9VU9*wj0VT_w{>?n0f z34v&Xah36eGyKA&*n=k; zoM%!WY0A~baUVJJi1IOAtY6hvL~TntM-851&F+;nLP?*Mk>{ZUd_V`W%*apso8SrR zeDy_s%sO*9sVa>R_=|AT+4m=O8luUN3j2l=RR2iujP6;w*6;n zV{AeF5>Nbp7V{=`xw>;bcBibnTY*&b{U(Th&5%I**kDMX!hW*a{qo$@|e5}q3=rp9D4wY*LqyadDeLu?oU|bY`$Mqa+-}X zmeRJ{F>mS+{2lv#1zK2#Ts`GIb!@GBT`z0 z&5_{zP@o74-`~k-EdzYQ&2&m21c$U#?s-QS+RUWttG1V<1=fF|G#eD-w}R#EAYUYh zg1PF62oD#O>3+!@6JfRepmeo=zh`{EHf+l^hyDtt(66Hi9wVC2yPBC7Om)9yd_R#L z*IV~qu@E`E>=Q0+5-s-S5Ng#Xsc_nU$em!KitTc3%SMlWZLwt>m`(zD8c2hC*&9}@ z=-s}qWh(8zwPJ=*>y&nS6mvK{qc5WP;Kgw_Sl^MldxU#{i8+4tp3j7|r<%+hk9{3* zM_)w8d)13nEx>_YP8uZ@>q>O}!$HYoJlLD_^eYlp1DLdRsIB7B7z_BDIDmPuE*{Wd z?k;D4WcG18)JoGmK$RmXQvOGUX?1Of^h)xfiJ%6>?Ttvd!C@CxV)&P*!R5!}Dv&#= zsta-KzT2uC;hbk%3w=pZu5D&(w^iwv;JA#w>m?>Ln)^FLr&N9#vEuEO3DONTs1$Nt z@uXbB21#P`Pp}Q@0oxuvuAqvCES1e}p+i7CD^?A^P?I*yhmyRcdBx z2H0zyPk_9%|1$@e^oJe*bi+uLzhClpzI=lEJaoeGa^Lz($YKs-2=E{<^oeEM9p?vE zCA`c{k=b?y!Gr1xCorkx>G^$>0321S}xu|zbNEV}JFdj>OCARfv))aYq$`ptoh>zc%zB2T4Z+hKkz7Qb2CYTy2 zC;4cfs@Wl}jE%x*`l>Tv#7ktC)9`Gcm+8mV8;pNAJZOY2ouEj_JtbGGE`f%GSN6_N z?sVR@!Y>H&&!BACS)N87?BK#r(WZ7=hC?P+eW9jg+M2z-FKDue%SR29Grb&kooekCNok8_PM#)AsHm7a{}QM?9E35pa9Pf zE=*VP;+>z0uO}`Hu5>GyE|0t9)ds2hN=s~7yHLz4jmb=R=eU7Q6@QCsx5XpBJ~J zEhT#As{lp_DtKqB>7GiQO)d7bpG$F=K2!0c27U*i)V1Mwx&~BT#pu=a0LQ>uD#B7c z(EEG5)xl-|2_7ri9QIftX_^oBo`>I7x+fmo_As780fM`R1;VCFU=!-qHeU4n@N`F@ zfJ6WFKId#IaD5b*M@#08R;^_f>rBpTvDw22g#rdIg|0iSkBYHPYsha0+eWMH z?dd?eT2JQK_c)hzMuq1{9Sl|RLxo0@fjJ0i)3Zf~oDTwR!?SH8SUh}p)4lKRR_D=E z#>=Z^=;fC`{BD=`5_Q734kQB7n=SsdRWO}{DoA!9EY0}HKhWG~^XoN^R2kpZVpw8B zjj0i~l}u0KidKr3jNBK(ZghXd(`ZoY9hbnkY;2G8UAwH^CDF1l>I-702 zwj5`G_ZJkeGA=&2ISWnKg00W@@{k=nwCcTR;Rne5@Woqo5x8m>KaFi>Kr@}MPr)GyG`$EnYg8iE<0cj7pB#j%3O-S~xpx*ATFV-rU-%Uvd zzoloI9TL;=>gd5^#Ispp?VZ5~_~|#_PGY!ej%tB71zbdUUg+3UiOb_TP0KSax_T`W z`_YMmlvqu@Qv2i49Tb{XyUGV(1jZo4(2?q3&+H~_n|TdTGYnH}2?Ie!TPyw;E4-q{G-v?Wa~kR7gvS&WJKl}N$gcWl46>i#gO&AtjROe#YIrg9HT zm({CzW>vp}%1xQxmQocMR$usN?=Te8s`(*D!x691>Jz1^AJF(@r5zK-jM2_Eud!|6 zG|HL!T`qb(-f}nWfa2a)g*N6Lk3Nr#u8v^>Q%dM3#X5MWSU$JbpmLWP^pZnSeO=@{ zT3Z8UvOOwrM`GDgHZYs~$FT;}O%O4mE#Gd@NyK;G&SY753mYP1XhlDmPu zq7JAt|4XFBgQKJSWZdzT%HDTDD18ABX7IyDD?5=ReIl3q&7BUAE)J)0))k7AxoK7) z;^Zm(s)<%;%PNj*i)Hp^LFrwNAzV?JUa8pft3BAfrjwFQpZ&g+-~qVny5G`Bi`^5w z!I2wltTtWJPIk+!B!Unq0~Z0@>9<>qrQRr#ifmZrd^bvu*pk;qRAm%6v{}rDWMnM@ zRyhl3^;!w^P2LtE8rvD}E2`Mux*ca~5HXeG=JUY7(&-x_>3g?IKwPzLUSCfCuufiH z{@OoTYX3Gan-4uNNF<)cFIL)@3fpRI#o;Dyl8GUG0#t~qnFt()^4H;d#nZqEun3^w zIXxHB!JLnC@Ebs!Rps{{bb~kb5%XOb<3JZbC-Ib-45eo)LRtf5)HXlliEBlCmNUZ` z4VRpklp1SL8Ip)I#OGq{6c=$7VFm=mbU_GrLv87w=F^xYN^)LGe@MV0j*P zqR0!X+21?larMyt3en3Co~cp;AhK!cTvrTez~3-ih~l0_qd`rqWddta$SZY`%G zmcBe}PVr|Q;=8&1o6EGT$$tl4%g##jG{Fqgj=Nh$dYV3<@gS#G@A zWCL$uJ;<6?aa3L1uTOZ>61n+J0z$4^Px+eCB4=uAUuY`PhEBb{`sGdbIm3{1dEjDw z#3;8SJR+#GF`bnAD0WCj+dPf?^Vc{*^;yJPVBeq3l4v_H`iv$!IFh&B{oeC7SL%p~ zq0n}0Bv{k4A@^vB9a*9wW=DbCoFhaV>Q(|bNbH8k8DMhJn`%3tL@G;XO(0x17q)ae zWG5T-AV5VBYZDM4IArd>@e&xBxF4WzC?gZlqu4c~lW0!d5Ci1q0Q5nsOZAKT^$)|d zHP+T+BM-Ae!L6QRdhW7hx$XVrGYa4&M=xG3;1I)OM{LH_F!ps=heg9P?=8n%nqNRp zOl-lclhJAy$W?VIFGC{NZ_(E#9rh{rv0E;?ZmUB-kpC!7?)LR9Q>sUkJ;AFZ{17$@ z!pI(rQRs23#zsz97#j#gU*aj1;{{%jaChi~oAGP7ihcieJ%A4O90Dvlt{ae&4O#(4 ziX=$pjo9J@ufrA$`kdy04!OS5x=IPl_0@U{RS`g8v$*BanxzZQK@1}d*Bt#!PkFp^ zqyn<#1&4|xCtHueDxTN}20p9sEF8PcSX~v~uSGA_>ptwbA}>3~91j#Ttz50I+2|}{ z4Gyx?8P4$EYw)%@Ci2q4&-svBcAn>%&8X~QK&l2}=k|orzFXp*5aXGBuPkR^=Q&ux zb#q01`_el&V~pzpC4J9(Q6EFEw#!IW89squJXhEyJXzkAnw9tV%9jCOm{VP%wRdo| zxtf{0v-W;FuJ?gEX%8D3+Dw_vioMM<=@l*QuF7_~j7db15ZiGA}O7Rr;G)9dKD_$Qz(5 z+X697gVI<4ukOqk+yjgO*~D{Yi3BJ+H^H{R9Z$_HJ09t{r-8{#hI;xx6F(O`mE~}D zsLKe^$qy&W%pAur=WwSD5Pq>LUywz$2766LQQtKmeTcao^Qrr>Qktq_etZ0%HG%i( zBt_l7CaSL30d*dw`ni;fd8loEAE{v~9=`JmZa&R4fs`=gfcvb>(i7+$%yB^A!>gOJ8jy!FBQZ2`OK1K;8)hN@~%= z$9V-UUedg{T$LFY8-Tk!*Yh?RAtqvaNt z(H$#tQsI=@ZnnREu$SUY8_!6aa7)nb4eEDGq$kYfqY!2rW#X!?*1KUZm7EKkBvyQ1 z`Z&rxDhi475}eRAClIdPy0Y8f`00U&lN6DWsBsGE+cW+l@8lsJ^F-4qyTm?I(qh|* z{Jza@5i652HPIu=6C@$^|u_YI44x9>mJ2j9Bq4DV^4ReI%o zXPGuIamFv~pd`X^{-8Xm`9YY|9=~b0+ecg9`p%hGB*7lF`N4fP%IkGU!_Lgm%sZi5 ziZ8~V6)}Z`8^{41#~pnwE0vb(j;hmFg+=~xMKR)k z(*sByRMdaqJ^$*kBx>i0(|9#8c89mrSsRtv}E=9vs%!T~T z%|7vrl*-q4Ta}$?mH^ua)?bhF4{gG)1S6_N436l7rx8s@xgMCv%=f&jYQQ*yY z-F6@Q^3t_#FZ*`fsQU-y-G!{he4UoCAI106u38MQ`8|FJF0Sp1Q&UwdJtxwUSUxY1 zK^+J#HPgO$kkTT$rZn;{ay_d@UdC*&ekpd%Bu-Xn=$qmdA1B4oxlh_GUv^;k4Z#hn z>9x(5ii}QyOE1$!Cv4o5cgt1-`nTvB21!>y)}9YhmWldSfVaC5vOKE><5{&C6I#hI zG9!OSs_Aa(d;iDF*Ik#pXQs>Tt#CkY>OX6u`%^vw?RZC}s8TbqPrwT~wfDMFAS&{=(BBG&l4x9+$(Fpv(h+NptiamrL@2KWdA5B2kK1WmsY)hPWOI^ zr0B`ENio-qy#`XR*i7&TGi~HKkl@2lWqZM?-hMwMv*isFh~5Pm({4q2DZv18E^W$1 zPd_h1NC)?}^ZF;f2Jjh5mazWtoM1Q--687C@7?z1miEf4jr3=e4~tR)1|}1MJ}5k4 z18cmzJ%4O8vQnV0Wvy?RKTgBTFDCrk&hVGR`)Lr#lHuM!@xP@5D|O`3_+XhG+rAf^ zGUjpNdj{C8X@g)|Trze@cLx`(RvVxq8M>_*GJZqktGI){rE76Y#6jNl7f+(qmlD|= zG4JQcCk^@2wkVDBYOWz${RIbz#V<;lg!Puj~3bVU3;$R_b#>!_R-t-y(?TXLH7wDX6Du zF66US8%x5#I3X}%Nm7yk29c@r-hQA8Z|NnI!~E2IH_W~a0+ZnPI>@$?Gzl^4mJgFT zJyDhvBSfv(Fl6S8ix7UT|+|!Z?6|lJOmQ$|yeaJSc4N8e??9;lo1WI}Q8AOKZup(9Hrw z`L=O=;^O&?$D$+QvuEWyot~saa3709xR*i#7S60PV;w+_$Yv$F!g#alLIta3qI+73 zuvlhIY_oyNB5of)%)hc3+zTUX$!upG8e+Lq)%{!((n^{W06p*-or^|Y9uI1dznI>4 zF}7Hq?-)K zz$vfyI|UkGSazRgFMb`=cxQ2<$sPsh8!Vnv2=3@C_rzOgK_7r*GrIg?;Tz(UZiyQ7 z(uX-84M#l?Qsvj!a|e`*C(zWSqZ4(P2)$z$?@U2u?~-M^8HujL34I!C zjWBSClZky8UN+CzQ&#khykbYg`R#`eUWx`kz*aca-J{ICFN}oq>JK}GS9}#9EybMc zp%U{aXrMJii1u`m?ruGcr$9;wHv)kZ8g`CKlMQ<%=I&|2M-9re#DAN@318=T+Osk&WXM}vKR z>FcL(t-YpZ#Z71%nHj{hE8g}KpO8ypr@u(&b6A6o19D~e-TS$g0UjM*ytP*Fz1 z*aCQ#R_|ar*hRA{yWV3k4e}|o_8%ATv-gW)()SCdW)APK=olAu>*yW0p}TbSYwo>W z5wXheZTpFBb&O(`p9-7q=*aL3RUj1~2)Xp6uRv9<66#ys#=a7~Mc`-n_>>HL#F=k1 zU!IMeFSJPCrdu;A6h=R(XmmN9dfhW!DXe-wIb{8zskUcn!acPuB?sv!c+Kqr61E^ zqI0pi{@sem2m#Z9gMUFs-^y#x-xe96ec$5tZYY}!p=lc$ORhmt3DcR)7T-CSK7}ix z+|;HU(#N*y^6##xjQvacvneWWnovG+%a}Yr0_3L)rJZSOP)l5MjitS=vriOg;((op z?#)O0t#uRM?--)#WozL&MGFcPNUkz~`!uoyUU{On_j?1pUxVGUm7G%c710Ae?(=N# zO)zBck)%(*%|yqDwUXYI75(h^mK0e>wTTvf-|L5HI*WRbhPtrHPS!5e`f`(g;^X8m zZt#KJA31D026d|Iz%h>@0mcT8Ht0E0JUr*DVCnPVp~OhIJr!#_QtOIv0a@gC>mLp& z3fJpjl`g1!{{Xv00I{=G+s;dGjpq!bE$uH>fx}ti=oVIZ59sN$%%H7`gEIBD83A#v z7(sTX#)ju1zJcq!&|GASwKMqhbnwaa>o*OX(@(xGs#hL3td*fbO|p^IUOp0ha$_pb z=dI+bUW<;^vx0gd)zEZs;aF6(dUJwvfj*;zg6S#4TL5-VPPLLXjdrZ?8#?A+69lx&Hi z?6!tNYwt*ne|Pdo0gsNq5om#sSwl`Bh{S-o3_b8I6?v@y)96?(J~ZMc@`g^faWp?`5y?NG3dSFaN3 zAki0G(DW4$_=Yu>>M8<>9|F828Bc(95FAx4e{MbsVrG>9JoU!aR@_Hw~b)tUI zw5Gi7njiLz|GVKa)dzpxaDPq?6**GHcoC^SGQ<2by@YB5-ft;C#41;OTyT7bBzi3b=YJ&CK7t@M(srJ=wjbNCS~#Q~em5WO zD-(K}^`cwn>MZ6P#6ZK}?>{aY6xCWQ4mEgnIQFQ~lMwX|(&Fh= zxg##VHr}J2CTa}PeY;|F8pGE;xtms-(3D&A;@UuciO|YpEdJA2IJZo zBIZ$rb(3>sgp;0Fxv0Wbl1(>ZP}P58@tO*VX;$eV_Ds}f^-O+YzsAX3XjnP-kH)f2 zIRnd*Bk-TQu(t1edon0Hy=Piz`h(6XL*bEghjru|3h$ce z&+w98><~9_ zw(*?#9%pZ^&nPZS zf3xu#ho2K|Y^c|@hc>W14Q7A(!<`r`Q0N@c;vCu3w7Y%h_IgQ}dHfjj%NqjfY~VEy z|KL9B(?Rt(Y+W|P!BkJ95BTuWaAg3nDeTtx;HvYdPjt|_=~I+gs9Aw@xF78-t#7Mz zem9jKcu`kNzHs3(G7bl^%YPi^P8B3wd?mRgxfUhkXX3RSrCyJ2>DONWa*{O|9!vcc zh*fX2N)94=C{E>!=l-l$MubCpLYsyED1+VQcsKE64e@!hcZV?Qzv3YbFWPaqv53LT z$u(?h4gLUAu>3TOn*E=70l-KAY8J{gwah2)F(fXn9Y$IghxaEhs_S??lBo&sLk{`f zK>Rb1q5LOe^i*ol{p6a4Q1hEdd(g{Cv=a<*pMYRB!n{P+MT9k{Mo~$)$q1SnYJG*A zAh(;*c4WkP)Er$~{JL5{o};U_olg5s_=7Lk;+6Vs#HI=szlp280jkl%RG909DXXi2 zHa{Rm}EZ8D}}>58f(%=G!3y~f!I)~8t6io~WL_BDeVT_X^ILdf$3@xQN#E>han zf+;}z^4_C8y|{lF08~o31-mz>If!wuxXGd7-+_0+Dd`lDkLz8jAR)8lE|Ko3%renE z5Ar)_huX^OX@TyTMAMc}^wF&2Hlw7ceGfl0nVR%|&sW&2f9#EG`se+yYrD`@E6b59 ze%YueY3iygm9&o1ks~ajAF!nbmyQitc$7eJ#?*D#*!UwFcLK#@7)m&EV+{s z(AG45$>ypU z#-_2m?{Lhg8-n7lcV7LqL&++fHZr0PMz-W}Ci zu%_g+ip4#)c7~srf*(6n$*#!|d|!Lz>+E3&>td+1+ei^yOci@Gr|QSZ%et)Y$_E2) zWca-&4}Aoxy%itOv@M$0s(ZGeq2!WP@$$3TedTGyDel>rRd9P}G0M_S;B$?vxd702 zxZ!MYrAYhEgjKmII4D^OWgffz@Dq1@nY+1`PHy%jY1=JgmFen65bb%im`Dnxi{Yr=q(h z1&bwVE0VB8fxd=ORT~lWvllX6%Zx@%za2lx!jRM2`g;m_Cg|kSa|zN|xI`cl*#!(l z--alcm+Av`7zvCWa^{taE$i%Y`>f4w8}chQn3h=z(G^}Tco7O;fho;fs;Sjmk{v_6 zXH%JHQ~p81UY7R~Y#)pfqD8}Xdux_S&e1!keGuV@rL>%q?-il{U>gf!;>9abcVf5} z7dF|gg}RX~b$5;Ar$SgikVr=N+j~RVG+*~$blbK=SW%2XmZd^6zTPgQAuagnsM$g& zJ>P{Fj%rf>gb@Ol4nh&i@j$#;b24ZZulePwdZQt3NHx@__1(WpGbao5yB3#-G~1P% z!IjpXuovW7ox7rC{zXydq1wrO1~{UdBlCRi`?zj;``B>Wh#A zNwMEZNOjeJ5s^TN%fCBrUv&6i93uJeg#NGE|3D}=D=Mygl2-3m{d#biFLyyZLhwHW%W0m&fBNu-3GeHWIIBmi;g>4&Y{>n$d64A(Y?w+l_xJqtR7{8{-1v!dK*m(gG}865P1dO(%bhN0PG51a_~MOxGWA9 zg&*0D|4)rjpMhOFu+1F~b1(t?DHXPIU=9Bx-wF6#mKDugY_BtI;se&nJt17)dmyM4 z?-O8O7RPtO*YrAp&2j(F8({I(F;$f>MOCONJ#tNsGKtuq!s)E=Y|T6({k3Adp|yLq zek4;^d*K1hWZ|+ivop=XVcGOuW@vX+31v9TqXjFu^_hRW^4!5L4wUXq@Gf)w3S8TM zjL2X#D(jGDh=yxE&TljR_Rp}N_T6gf1eW(&_YmneFsiUE+ z%g(#0d*hbg#pL*SoY1^-B(4(+ z_#mRVyFX{nKR#l|)0y$ZlsnRVYq=cwIz@lW(Ui4zVM=x0TPZT^9WH67R!;8*=%|O! zxSA@x=OlE*biZPi!p)PLQZx0|GrKmgJbK(CTg0D@A}rzg z?7kba8CPo`ryZ9Q@K|YEOMmpNyFOj5z;65tQnUerAlEWxn<)x9><5u0__B1r$fe8z z8zw&71)P;swj>A0^@KSU0^#s?tj=@`3DPp+(_>R^ykDN`eqfhcq_4rEqj%c$C1MyJ zfub!jd$rAP1b!edJrHTc_-wy5OkVE?KvoG-1ICe6#0t2!Vd$_rPXfm$uVvxV46d?b$OQ(>8GrsbB`b=W2%)Xf{XRHD z=DZ6&ujgoPzr(6r^-UkF&j7zrK<5mXn;ZC4<~dzwBz7)?04m*cYUmUY7~_D)Xd z$5l+wXX{TTwL$RO;jg+%)5t+YM$ANQ_o%K6zJy{Pp>hyv!JCuXIafiDX>4{Lte;+@ zg~!@p$kr;1w0E`knQ$&6DFWl*?sg5-iRwD#0Xp^R-9dJ8V zh}!t?O_t#Tz!l~>BPeE|^3p{!P4?4jf87r5DO9;HmOXZCD%-Y94JF;a4kF}Gg$NtDD?IsPK z^Kg^~Hb&}4KGB>C{+=hE{mZ-x*xvcL6(F|!OG%Ixuv~L}RKR?>s#E!VuG#bmi{3i` z;(kP2(Xf`6>7cExXG7Q1^TcVKU)H5X!$4|rxTwP;m!V^M7FMP(y#^X%_IvTV>t$A7KaYh4UGACgshNfhk8vhV8gFU>|( z_!b+qipGSW?;e(HCXq*tdc-~Lbb`;K+v!P5jh*pS_04;D$D&FV;!3V(-%)cMfZVM@ zYACnUgLK-70#*Q%uOFK`?@oLOOcWx{^r`PIN9#1l{qWODE*`q_1p33Mm1TpOJA>+@ zp7Fs5nq>f~o#x4H7P7^Vz{!7!@C`f&RS7FE;Qif7520N{qjjq?7pE|&V{e54o za=1y_ma+*tUo;16D^V}4S*o3W0B^Bthu>&>0Jt9zuS60RMhx>W&egk~Ttb{19?;il z;c7wID(5gzSUzXLr6LcbRCN2w4BArQ5}~L!#58;&ljQ2NX3~@FMcJwdnLIe_92rX{ z#TqYzj8}<%!U*Da?+^OwYwaB4o>6$edW1_o%}G5-HDpGTxfJqZ6*ZFp@>od}^&xFU zPhEpmgWmSTeCx0G7XBp?VeT?+k+im%xOA~-wcgo>P*W#}nFF|MZyKx}z!sJjrVi|$ za@3<-)R?%Db>7FF1olnmwJ^c+YlE?|^v?dCQ++U(%oyR?o`scYxbn!|VBI86(;%XZ zvEap;(V)(KU&IbdALbi;ULErf+Ng?9_Hg{<;>)&U)gKM(wq|kZG;>IhLf!oh@rdW3 zD#ANS=wr{yDCiKMmHZ&m*+#nra#mY~XB9JHdD^HV*J)_z`XLPqkQBtEm@>D(Ss+b`MgpK?-aYCel z5Z^m--o{al9etm@yM0KUy0(>Qde;fg_<6@sP+aGXV9(%7mENOs>;BqZ{$Y1L<5k^C zs=7AhNQy=!Gmn+$qI3+R=Y8ud5*{Q^Pg9(=l$~AjEA_jygP*6Jec+fReKG|M-fgn> zX@xD$1wGVsj(qSgO{%2TGb3&~)|gUw1pVyrrG7`%;=D-Tr`+KN%5>i~3?~Up>U7e%ncXY4l}Q`X?&;P}l36I)f>oXhm>mdO<(}`6GV@ zgRa&Z=J`Vdv)37HP}?v6?@--$xzj>`2U}9?7`a47KYlhgJ*U4s$bDfPqQO&u1Kh{} z?B{gmel})iO`M~J{8)irN?(HC7S8gAtD#Vg_s1;?2)bkVjC`e#VJ);&5o1Ph3dA?I z^C$StV+qI%ghP)vLABVvXuJ)1rwcZ<+rNaBAmqxR>zWr)dZM9W*wX|&2VV9z+=3Q!Rl~QV+B4||%F;q#+Nl~5D)DlxoZDWdv zAreC9q*}8GK?JR$5}}5~7|x@6|KIhVbw0f7tn=l3%36`Q?_BqFU)S%NeorVWGwMJ_ zM!*G#cp&AARs?d7{z6}km}u2>v)~ZEeyzk;2w1n z*aDoNMMBIM;8#7%T?vlHC`gP$S@pPSUlCjbC1i5*viqCBaVD-qbfxV$EC6$DO^y0nRh&SIaX9pS3-w_l4jPiCr`4M9XpPt~40@lx3X1KlF=3Ehh2c4# zl4TVJzSEo#iTY1N1w+CH`j5Zo`U+5HAH6BXV702c9~N}Lv98_(l{bmReC_l~Fq+O2 zPtTcgZi|5Kml|n%SnP$>lHi#2)_*-EktXy-GEn&*O~OuQxv3#H)D{vqzizEHu*G;a z9}`S`#bEQAhIq~E16}R4%T6MBwk&hb1ED&x8}+4qCTI5N@?1f0?6vLHwfSrP z-Wn{V-fIZ`8l&d}trsB?G_c~4I~_ds8k0Wl0+YNnW0a8Rm~?(drevb&03lNYT7-n& zLRVhgWV#HxV$ya5QRUItQM?H=t+Y>d&OP9u^r0b}JQTBiCZ`c3lY0_wxq)KIkz zjx%cuRdjk5Z(xT`dLm4@*e36!AC=1+3Vlh-)CR1qcl-Xn`sy&Jm7Bf zgZY=3EBm~|b|iy?+{QX`#alvdhi=+RaR}rDs%ukB;lYuMJ+3}$5@K>Yv*t=77t|?~ z(0N<5WLOS6U{2kXiG1zjWoqqi?^zHbM}k*IR*|3tO6XdVB}RU zCMcd&7Pwr~N#JefuwqVJi{H${5M{BK7nhL7cx)a+B`Chb}Y zLex54Cst6zf;sqe;@&^9ckKOEtaa5d6#4!~do?5HwN}O`Z#Tj98_7ic$_FEI9@The z#FH^&#oHt@LX(dN>9_oN9}-U|maDg%Hoi%pfrZH=(U09r47;)rkTwF<;p^oC!lb3S z)-;~iTK_Hi>1URGKWtyXEHfH@;C1(|Es0OFgwFmDY!g)4%RLRRm=7Zjv;-^@APT2Bkf19;ctca1&PS_ zJFi9+T(2(R)w9HWmjJx=1G4pTU~I;8c*7$&!%~t~vVp=^k6Q#wXjr!I*;o_`9^tw@ z6h0l}j-Rc&QGi>Or6;0?8=tSN#Y|sfs2NCPh%;Sxz71{(w=T|7;Wg28=fTG90OGxMk8QZI42JCc{$ zs~%ODS2X;*KowN}{-X||8%lq$(VcO~cRk1E*z1lK4JR;r{cn#4+X4BT@qxn+d&=~9 zTe)}6RBD0mnli0IgagPp6BuOKohGT0wl;Oy2}zhP7NbeHv+; ze6WU9_wM7?NpGwYOgcWCsXgOIMFMI$`ctft^~v%q>AgTv7isu%0(v$<1R>i?cGSIW zrf6ACIVu`G3tnk^!(3q{_uZB+jWF~UyA<%~#3|o81yKJ^4tmo}EVQSUpAj6m z)#UR%rc7udmXp6JLMEy&@+!wB!2pBS`RW;ul#R@w6|$0pV}WnC*k%(+WH3SQlL9Nz zX!*q8P!#9^cjO?Sdg1ZRms@CjnWLB5VBp&eb4Wc=W}m9L4QCV;7Ig$Wd?oPUTto6lJv*yu^>fogtB< zvv-z-o3<^Da%y^#OzDLf{fgeSncjVfa5Gv_muSDe&siSe*ccSD{z3@5sVR0pk|ef5D~>SKIj1Eo$8)}{aS z%`IKdM8sEQ5)L&HqbUcii@A`5Q*-?h@+5?q>l>bu)8jqdBW9nSSSJE$x^y+Bv(?3^ zO_SS~-a~!B_I&Wzm+R2gH@!C)@x%Q)kKSgff6f_POZf5R==8JUrv66V-Z8EZB!Z_e zdzAq9{#_78x!EP!K8o)Z?mmxIcif427+TrDCb~h~3lymRyhuNcF7brvK+^URHhcLZ zuI&<6&7ufr4A!lDm=}^So9B3|BfDVM_tFN`UZSf;DI(<{b)5A%6ZZ5vb)tGZ!Y-yy z<~A%1lDo|O9M5(ac~+jcF|nf>Y7D8EZ-Dr~5d7pzS{UO zIc(Njhhr67fw)M>r@iz0LB^_dMFc@{Y(4}2xkjO%87NJj+F9OG2sw`(Gwu1VBAPsg zuI>IU&^shA^y81>MZv)bPqsoC(I57Lx4wxls43_6bLtza8h)0ZfQ|W;jcSm%q#kvz zSe|Wog6j4Q^rKGYZ@IEV?oIOA_Z~NtZuvK=ws$5x8Ga->r{oSk%$PA5ok=r7I7bmp z2ZHIIr6g_x$}Ueu^O{U&PkF@r&Z0}$%cr`sk;kOFQW|*C7C&N&1UZ8@1x;}=FDuX2 zmbN$b)UI55mDs?iE)nNxyV9R^Sa%ymCaLzUiqI9jlB>zrf_^%!)huho#O5^^MNGH< z3=Y{7!TLJwVHZG+nXZ@dzM#hl?&<0Ee_`4*b|LD=n;_ZJ9tjHEHo1(H@o=G z*P2|4+${5FWKx}pd4ZNEqjH@-uiMX!bDd&3oZftu&lyFV^)$`2?9X*%-VU*jS$5q7 z0#Zw02F+8AH%ruVxOp=wBC+`Ur`fUEE8PPdZpat=%^143Rm>i%v_)A~77v#X3@!WI zZP{c!o4mcUVdCuKk&<=^SG;vE))JVCyVl*XzZ0SZqmzO4)#XnPVTsle8|f!nw8O5 zBrDlO1qkv<9^z^WMIRMu@pwEY14c(JXiDg6RZunPhdJBWGwLI}Kd1|D&d6VvOTtTt zG^ZDlW{LwPw^||6z89RHZ`%~|cT1MGS>k4J`HX{ux{iM-c#_Cyuj=j`nzbn7ZzE5J zdqd;w3PzAwmT#=RBf*teG7DMsTfG%t8yHn#-J?f)UfQQ$QxG=7TaUlU31Rn?zo)vvuhSrr5O$dHc>^A-YtCxZ zPYnIai3z<~Vw5*EzIXLT$%ULS&bxVsPa8B}^(EJhmwGp9n~%P3V>Hy=m_b5PKD={F z30L94Cb2Q0^O~Ek;>^#pjj+C>S3*5~9*GV_YF4F)SS+J-XC&e|;R}a(KM#f=80nQ! z%jA&Db6HyUaS=-8t91VbWn)Qyw}Plq_JgFCwt*W(Ia-zN`m&0g4?Q}}vD}BVMq!|Q zTr+L_LAh{CL1{nD8}ld|zPw-T8JIR_(K~^l_aL%YW6!k1l60?4H?<#QnBc(Fmb8${ z*kz`?MwP2*9>P)r?DQP>x)X|AqDzNH@axaTSn4}1Bje zl9b+_#ZSy+V}v##1vyW9-N$ZYex~GU)AqqPNnJ8SA6E&c>^f;a9|OVWBU0G1u9hPJ za}@P`=578>x&Qn6VQ;y1=ud!E)1YzUKP9r(pThin_u;JzZXP?vP5^<%F&03Ibszrj zKX23^8HrOBKqCiuXuJVmv1e2H0;Z4oP3Q0skWq(n!?3(OVUL~Gvl=7&Vnz7w6RueC zH=p>GvMn62&#r}rp&joP0}VL$2sD$Zj@P_rl0?0|?xO#xzm1mu+c^F|rEmX-znA_R z1R1&E))#mb(fbIBuf`Us_ePys2%aKkV>X(*C5GTy+qTbjgcZywi(Vx2ME73eKw z+sJqwH|)awUq#IJ?Svk+!G6E!N3Hmn%80Q;O`gnW`dvi_jPz&C&lZCrUN!#+?! z`Zg8ocr$OKYY!6@IHMSxNHtx_q*sc12lkbhcWZNiOwruUr1VS3va!ze{W6zaN&xQE z-)qeanlg$;PkF9LH>%wt{OEGLM`b^-)@~;19{?CPAh>T1LGpt|{Li;k__%U-fWD;8 zx$QKa#!50ypuBxYTG~>{355V-i=9B{s8;z}@7J6=ZPF+o2>w*p@0)vWvhHQL9ff{E z`E-qJ1RfnOR<7-QzDOxn0`Y=@s=Ai;@?LHbP-OJFQ_<~cXcm^IQrS51n81^=8P6;tQ?{Q0J zQ+Vl4RC9kLB*l~IRrT)%$p!jra3EaMA8?14WV5&$l>spIe z+EO>sd2S2qyW|^BuZ<>`M?p|=kofsuC;FeRZ?XW^GUk$y4=}Z z*d0aUBdu{`ehmIjU!<2`BdS8to?>_bsQUc#i`DtV$>|4z<%8wch%tc6R20;x4=1M|I8=u*L(?j>zCcn%FAn? z9_Tt;Wampa%eZ{EYBfT0`ER60MGYZPR5*Hyb)%38jBD^BWb-@-FEUH;&+l-qKZpA> zD)!dCYw!Fs;J`h%p1(NHu+(CaVTikeebs4q=j}Il7tNA0pKsDpb+@#e8`slVBgTTj zVLs|uLL&rO?fs34XM-|Pce1P+!gC$wR5q6we`w1V*_l&V4FS6)(oJ0;^45-&c~hG* ze>$ME_XT&^ovU^SYy*4uh2P#=#wmi1S5Usj+X!7X$$I8Rag0VZ-xymy>NAY8X|2Z9buWTbW&7XM?R@45^%}-s?OEfZi&Mz5QaG>i1yp+ zV`ShN-9(pVb1~S`(4MC$Y}^ZzFo(sBP>UEvlXY+-v~$8qIoU$0>3wQYb|1g2xg8{TdM z-4_l=CFq8Yn6)loxH_t;C4{};#kMWIH&Bp~4A79q=iqZZBXJzF2 z?D>n^89qj!wyc9p1LY5ZPi%KX|KlqNYJdFWX_Wll(g1oQ_WOr~_cqJs#sB3#Gk7O7 z=(;UzPFm{zX!480k^*LY>b`{@zpu-6ijXwuLIa8b~iF& zbelFnqn5glTb-+X-Q_jxCig z6F}!ZWHxA-l({;}^YhDzWP|eWL{+1Y@YD@ibI%P^@88o9;aU2745;mj^8Gp3OC$O2 z)bHYW11zcRCv*=0yC7Faba!58(zacs3*Go_-q2gF`|!WAZk;!yeek>nuhfSuoR0|- z2ex{j%f+m|DKpyN2&S|QvxxUdGhuS_Ga*Vg3A}r?rsTw@1vdG>xYA0 z`X9Khf3@r_?6P-Y2P^p!bhZbpzD%2IzP=HWeGW%inrZ0P@AX3R^JJdEy^-bV*nKMA6g@4j9mI|p{R5Vb`34gpY zH;fQ4z|gI&Dm3VDKS%2)`o&XEmqWlar-Z%9ki*%>Z@qB3>MS36n``@ zVc*ELVCRHQ*AWz0VEdR<|<#Y*IT z<)&-&D)*Pd!%o2h{8GUo>2oX<2*b5WSR-5uChYuI3?8Di0MHIc(>3iudJ`rnw5{EaCUl4nB;!^x>&1tRkv0j*$X%j(eIz@2FM zY7?W*^JSM+2mx=OSGSH>rY|~xVVgl#Bb+E0a=#;qpa#M@2f(g(0G6HY(E@c=n+iIS z*16LiS783Z?2Y?2c%$u*S`V@Fviz7joyq+PqVSyEVtRdMTPM4=o)p`h4Y=4Zdhr%6 z^o9DGF%k@Mg|TR}l*$k2fev(aP}FP04*x7=+s1Lz+q;&Lorvz3j_OAsnuk*iZQ}AA zPIYC=@g~%eS*7(NRM{V;n`5_z`)#3~^PC%{u{NZ*Mq5_73XbSpQZw7Vtc!NnYCbgtIK3 z5ka_ft?{_~HnRuCK0|UBWz~}w{Nt$mXSIBb)l+5&Ig7GY z7LvYkc|x`yw9Ps?!|4=Ai96vFw))EjX`k&cTCAP7=L?{NjiV3L)cofD2(0O+cP?v* zQKqvl4)KB@pzUxz_ZV(Rh5mSzg)q&Fv|w3#I!N5#GUlCBKj#Nb0{Z1;b}DlQVks*W+h~#c{ z8_BhjVNP!Tz?6~;fqGwXWzj`f|B)a&ne7pkdi;4GQ#B2s-ye&?yWN&st^{?K$sb9rBu2Qyl31v%HRZ&DuGEAdz10pwW12 z*Z1RxcpYeV@t{Jn@_HzvPR~8l1xS4U3|RkD?*0jkudQXio>O+wN`MYe zB_D+^^}@Qp&YW+w#cfYr2pF&GepaUh(JV~BXEjtCrY^NP3M#hXg%s~JNe3hh27LYG zNMr9s4B+TBZ*CLs9Wb|Za&S`{+uDU2d`jN$N2D~dFwI*5FXi1#QN=GK z6KLblhnyUe~G2sTb}+J5_|5d zEz_&jcw?a-Nqf<)4`8HMqAoICy~vloXcH$CV4^1%@OVx{ z)je`vS8c}y=Z4YxEG-+t(foi2N>%OX(Piw@MsE0tb#MH6&dYdZ|E02);bLBGt%&^rW;7kS_Ay&vNqy1Ik zVRTXVSP<*oM%=IwGmwzV&ff7SziBc`n6`FiJfBWlIM#0n)^5evwhb{w0QNQjcixZb zhD)l3P3;#Ogp=-j3V0Qkab7A(t&GIC^d};l7@~e|sWtqX#~LUdSL#?A*E_^)hzU{) zJ?<=r>&xzI-`p6ej0`TS?eJ6v%3e@Ii?Nma@=%Ez`1$*|9Hn2+HR0oC1Mqkwlr2t^ zMp|dngwup?oXT+-2U}N)x@DD@X}K3=>_m+VpqYGL@h>rS0e^;~G-y9e2V|A=9+O-2 zm_*dp`jlbFI5L2iuJJPTO{htHYEPg)RPUf0+>U-}V_{mWCARn{j&Y-`@l>rUz)spf@)m zm$6BTnT_{7OX!P++fOPUq26sYO-YvLQnqI53XQ2eihEIRbK|{~10C&KD145{$Q0>g zTLTKujcJ2^}Bx-Fjp;PKiZgeB7xK6p8ws{qGmhBK7{epV;a(#JNK=ev+aN)Q;K z5a>5*cwTehXjZC&z5Ud*@btnlsn_2v7oTc*#nZ7E^_?Lsph%ime<8n9E`ZR1-^Cej z+)|11UVpSu--DhCq`N38CuE5DOwU~dn^V)LrZ0)3P>rggN!;=8mch)I9zhZ6FtyX? zpjg>M)^h(1CtZF0Y|a(!&9+;gH$y%XQE*GN22`{Q(@Zt#FQ7b}N`xN1X*D#=o3Le^ zo=OqLG!Dm+hEszWoK<8hqyQt8E0Ov_3I zJToIZ(qf{laRr5|U5U4gL7Q7@DBkmmVbv00Bi+{i$4U8F2UVEQd;40Zs<)>Ce6=L} z3Ef?fEH#CP0sek`(f<+U3<(0kr>l7mJGn*UP1mNuF35)a4_m!(Wm-x5FwaR1_CBvO zm#R|0aO*F+xK=j~x&j6@{ZE;agMgxWym$KztpDqG{KP4vS&+@6g-3NGAFh1(07Q`8 znp59>2L@j6CZJb!_7seG zy2Y)wdBc1&8~?uMfc-FOUD>Gx0LLnB!76|NxBcR$;z-B8257xvS{xjlp>^#eMq6ne z1p(xOnxC+#J^`b9pTv0axZn|#;~TK?SpbVG%AfC*lYOJ~lJivmlh{7geXL+yp>0%h zF_oukdLvn)%I~?gg>uT6Qp%W(!;NRW+pO@jXG2%ojuok?TUTkt_O`|kwASzDX+ns| zei=R&p_wDxgoN4Ll{SfSYir+Z{ZIRZTc*zSQa9cc-3BLV?yrn%-C#nkNiej;%O-t7CBpyY8Qp2Tc+30Z74K zeix`aIV_ON!Jt}3Jc5|#p!tt5baoW~*jnKmuia36`QK2zN-o$J%r%xUbAY9VK3-a>MZ^;? zkGP!(d$h9T)A}j&uJq%f1&i8I2eNcn9LYI}p+kI0Y;qSR*ka~;Bx+yI+Vx7v~(w6W@~V zHANos1@7UM4ueC{TYjdDT%F&p7T*@u8A}IrH?HPh25JFro^X$R8UAz?S{K2>{y_yk zdxx>e?_38EBmrQbdrE2qg3CbNxegLu`{w_k);*k|x_+VvG{*FT`ebMV)EbwsPlm#>-q z42qch5g8E*66KzLqs~&<8K~U!;-_oy5A?{LW95x+dD4KI86V$3&SC0a{j9ssSkGR| zqk3XYg7hMB?zMiWZ}tPf%fHh}O&j<)-r6!Lu%e2RQ|uqbVSb}Fl1 zg7lh`0YOM@?E)bH`e#k=(_kgSa$RR#l8vbL`qA%wB_mgY-~G0nBBF{g5Mm;ZQ=yr~ zKUr?(>17G&1MBBXr8HkoiDzb;_+kqoK@m4BENyIDUxK=^V?SLsjF|8!g8EJa1=lFD z>2-$zDrz|a+8^7=4$?(~TYeoNA7454OXr~N4tRo=1DPs5Z*M;j-*d(;hO;OE_SyzC zMv3>^cZ*7)3x=on${lFz7|vtRgfKfz)%<@}H%V%e4yr1s^ZpQ&cT>!k@H< zIc|97%(IOZT_si>4qe`x#uf5Mi~r z*D?m3nP_D8x;WIh>%RP4Kyss*86zNt(AH-4CGQ&*WBzIruobs6m$U`T2>rgHa_ph-{uzAZDt-!piCMO`WLfz zj97sm5XW7@Hf83rvJX?G6d23ZA&o#fEpxT)QO)E(>C_2m;OvG{By3Ezg%GA^-f=Ou z>r<+Boat2tT>ak12mPJl`oA4_>n-ax8JGmuR2!QzuwA%JySYJb-0h>rp=~lV<4Z$~ z%i1{+>{0k7V!F)Bxnn_%yC>`dBksHl2NCjTH@3ZGJ_%$O#>vxur}lh; z_APx&!e%-;_~i=uHk|c>qk2bQr&|g!z2aQtHaUCXWX;7a3iiUA`861k=b`uS87h)V zTEog@4Im~xwi*P}wX$8+Tutc*avx_6?^QgA;ZZoqVK91j0 zw9pnt2u47Us7D@0j(f8E#&-Q5Pc*rBcb*2kF}eKE5-RWps|YSB8E2h4a=$ zJ>Mt#XT5C{~I?d`oaVhxRTPHqvYxs(BMlgjy&P_Q*PQ zDzh_P8bK$zIxnmaaq9m%;zr_ZqJ^(P9B|JnqR{q1vnEx&Cuhrmh4!JPS(@(dzWe78 zQ<*6Fk}9X88C*rdx#z!X1ryMcH%+g=?{hd~H3Lr*7jK&!3J1*An&lJi#czrhsk4Qu zfZig~mVhh!&L5HeJgcx7tfP3U($nIb%IL-oauG#9Qw`_%klKZOw`NrY(_wTUufo94 zj#Mh}+zGx&^8tHh&0F|sMZt2~_hx+VKZ5QW0v=069_gq7e8sTUp&EZ)mDo+&Z};Qt zYOAQ`>Va_)S%1E`v-gI~X6xW00M6j+sg$ljb6cFyH4Ru$jkJtg7+NMhF7hOPe$ZXI zw5f|kxjg4Ylro$ZrIt6^l&gMdd}^K!axFJo9o7qqV;@5|3cY6N$o;Ze_i?!bn2{2D zrBuQt^NdC)i57J3khAwqQlHds*K%vTZRB7YDaX`sx#I!_k15?O8rUFYAP3N+WL#OU z${$_zN1PX!vy-8>5$H^QV5* zdfeqYv;u862Bi^LUK80T;jsVBq-z#dOIHU4f#DH3%dLE2P4J7uR4sJvw=01Wq05_I z7FOl**kTmq+^Y(uAzk9|XNt_v_Ro>w4N+lexOk>Q&t?CP9MIbe`3r>j$WTi=+Q;zL zj~}zD$DaOsl|LU48{{U`JY|fe9zAgwy7z?~9x(=Mq5fg==hwiP&`Iz_8JP4IGA*j4 zBoPjHv|SbLG9I*;Jvs(=ojni~g#aQw?uTpCazU?Kz74F|zRkTsK?#I}9z<~1!uM|G z5eXI(E-a4nJaf}!C{id{(XS+^SIvtJM07d+&Kq?Z$epv zM&qIo@XR;wdvY}Ar%`&-`dS0$C8)n5|F^V{pXR{rqr*#YGcsSiR-n~IcXYWoSW5H8 zPVuM3DwN7ZQ=O#szN#y~T{HXwn1d++DctXlwxWY>;0^vFv_yIw3EblTkjnl&5POQl z6d?amInN!Z3Y)PrL7AnmDDact*hHnqocn{dA#!Iw!YfY5Y+R1pEi3?cHpdB-HY=*( z?tA?Se4)~6tou*ojSl~jYV(BF?M%>S+{Dq}um$0Z_D{`ktn5v-#)SS+Qe0sTEI!>P zpNU~A@nZLzOOdF1L33 zg9Ea3{pl9y}Er?)QoWcZE}$g90ck*g#__s|Wx-Qz_N!pZC4G2;7xmsr#4T zG5yS>QkzJQgVv%l)|h#-MgdzAuWnCwK;KnmwQhK83#Rl&qoN`sTbRi+3aVJ)2l+5$z8=+pwV@2jq)>jh`%A1_dpd9nmF1yIzJO(@ zD`~$lnUn%!EYcSqn%`A|rYZSwGK;IwW&aw8SdO#OPK9%@b&>vGFnNy4P-LLntMXUT zTB9}#$`-cKZB8$uZm0@bJCet%K7@9LwJgxUU(GV1M&`)3Q~AA-x@i3g0MN!(sp18? zgyYfMr===N5bO@dQauq)wzI>7n1^Vpp8pygYj=CyC!HD z@81*|8&|}C#$^cICa9lbmeVJEqQXY4ohss<-*Y7T->-dF>n(xPK{P&CO#xMVYB@SG z6nUh)xy*n4K_QxGh{`~%Uy;3RXRpv)Q#=+!+wU8a0|30$%u3Z$ZHZ@->Z)2p=Sszt zx1V&~L=;xIy9g>x7yxM6jB7=3Us3bS2-3v$~?`~fPqIZ$s z+H_X*L55q^0p<9&QyFl)`>L3u)rkExD&5!7x(x2<5HZ|_r`UAIbMH+n(yZp5^(SA19Sr$|af0tU71?&SIa2|%!?uhZ2iIxA z>pHKG7i9HXlV7}WH8~wf4s0Sy!54E>RjUTTVXnui>;rFhMBh7<$?m7)0On>szU#)8 KS1XM?;{F%Ygd7?G diff --git a/static/img/libraries/utxo.svg b/static/img/libraries/utxo.svg deleted file mode 100644 index 7eacef6b8cd..00000000000 --- a/static/img/libraries/utxo.svg +++ /dev/null @@ -1,2045 +0,0 @@ - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Alice’s address X1 - - Paul’s address X2 - - Linda’s address X3 - - Alice’s address X1TOTAL SUPPLY = 100iTOTAL SUPPLY = 100iLEDGER STATE: #1LEDGER STATE: #2LEDGER STATE: #nTOTAL SUPPLY = 100i - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/static/img/libraries/wallet-rs-layer.drawio.svg b/static/img/libraries/wallet-rs-layer.drawio.svg deleted file mode 100644 index df8bbf189b8..00000000000 --- a/static/img/libraries/wallet-rs-layer.drawio.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -

TITLE

TITLE
IOTA NETWORK
IOTA NETWORK
APPLICATIONS
APPLICATIONS
wallet.rs
[official wallet library]
wallet.rs...
a generic storage
[sqlite]
a generic storage...
stronghold.rs
[secure isolation and storage layer]
stronghold.rs...
iota.rs
[official client library]
iota.rs...
communication layer
[network]
communication layer...
Node software
[Hornet | Bee]
Node software...
Mainnet
Mainnet
Devnet
Devnet
python
binding
python...
node.js
binding
node.js...Text is not SVG - cannot display \ No newline at end of file diff --git a/static/robots.txt b/static/robots.txt index 9da3cfae1ac..67c7c04824f 100644 --- a/static/robots.txt +++ b/static/robots.txt @@ -1,10 +1,4 @@ User-agent: * -Disallow: /iota.rs/ -Disallow: /iota.js/ -Disallow: /wallet.rs/ -Disallow: /streams/ -Disallow: /hornet/1.2/ Disallow: /introduction/ Disallow: /identity.rs/0.6/ Disallow: /identity.rs/0.6/ -Disallow: /learn/protocols/chrysalis/ diff --git a/tutorials/docusaurus.config.js b/tutorials/docusaurus.config.js index 1198616502a..7bfdbdc8666 100644 --- a/tutorials/docusaurus.config.js +++ b/tutorials/docusaurus.config.js @@ -86,17 +86,6 @@ module.exports = { tags: ['video'], }, ], - [ - '@iota-wiki/plugin-tutorial', - { - title: 'Send Shimmer Tokens with wallet.rs', - description: - 'In this tutorial you will learn how to send Shimmer Tokens with wallet.rs.', - preview: '/send-shimmer-tokens-with-wallet-lib.png', - route: 'tutorials/send-shimmer-tokens-with-wallet-lib', - tags: ['text', 'wallet', 'getting-started', 'rust', 'shimmer'], - }, - ], [ '@iota-wiki/plugin-tutorial', { @@ -141,24 +130,6 @@ module.exports = { tags: ['text', 'getting-started', 'client', 'shimmer', 'js'], }, ], - [ - '@iota-wiki/plugin-tutorial', - { - title: 'Create a NFT with wallet.rs and IPFS', - description: - 'In this tutorial you will learn how to create a NFT on the Shimmer network with wallet.rs and IPFS.', - preview: '/create-nft-with-wallet-lib.png', - route: 'tutorials/create-nft-with-wallet-lib', - tags: [ - 'text', - 'getting-started', - 'node_js', - 'wallet', - 'ipfs', - 'shimmer', - ], - }, - ], [ '@iota-wiki/plugin-tutorial', { diff --git a/tutorials/pages/create-nft-with-wallet-lib.md b/tutorials/pages/create-nft-with-wallet-lib.md deleted file mode 100644 index dafac7722a8..00000000000 --- a/tutorials/pages/create-nft-with-wallet-lib.md +++ /dev/null @@ -1,200 +0,0 @@ -# Create an NFT with the Wallet Library and IPFS - -In this tutorial, you will upload your desired image to [IPFS](https://ipfs.tech/) and create an NFT from the unique IPFS URL on the Shimmer testnet. This tutorial will build on the tutorial "Setup testnet address and receive funds from the faucet" ([IOTA Wiki PR under review](https://wiki.iota.org/tutorials/wallet-setup)). If you haven't completed it, please do so, and afterward, come back here, or make sure you have a prefunded wallet. You will use the same folder and development environment as in the mentioned prerequired tutorial, allowing you to reuse the Stronghold account with funds on it. - -## Prerequisites - -- [Node.js](https://nodejs.org/en/). -- Finish the [Set up testnet address and receive funds from faucet](https://wiki.iota.org/tutorials/wallet-setup) tutorial. - -## Set Up - -### Prepare Your Development Environment - -Navigate to the folder you created when completing the [set up a testnet address and receive funds from the faucet tutorial](https://wiki.iota.org/tutorials/wallet-setup): - -```bash -cd wallet-setup -``` - -#### Install Packages - -Next to the existing dependencies of the wallet setup tutorial, you will only need to add two more packages by running the following commands: - -```bash -npm install @iota/client -npm install ipfs-core@0.10.8 -``` - -Afterward, your `package.json` file should contain the following dependencies: - -```json {6-12} -{ - "name": "wallet-setup", - "version": "1.0.0", - "description": "", - "main": "create-mnemonic.js", - "dependencies": { - "@iota/client": "^3.0.0-alpha.7", - "@iota/wallet": "^2.0.2-alpha.21", - "bip39": "^3.0.4", - "dotenv": "^16.0.1", - "ipfs-core": "^0.15.4" - }, - "scripts": { - "test": "echo \"Error: no test specified\" && exit 1" - }, - "author": "", - "license": "Apache-2.0" -} -``` - ---- - -### Prepare an Image for the NFT - -Add your desired `*.jpg` file to the `wallet-setup` folder you created and rename it to `nft-image.jpg`. - -For this tutorial we'll use the following image: - -![NFT Image](/nft-image.jpg) - ---- - -## Scripts - -### Create NFT - -Create a new file `create-nft.js` and add the following code: - -:::note - -We broke the code into separate snippets to help you understand it better. To make it work, copy all code snippets one after another into the file that you have just created. - -::: - -#### 1. Imports and parameters - -```javascript -// Libraries -const { utf8ToHex } = require('@iota/client'); -const { AccountManager } = require('@iota/wallet'); -const IPFS = require('ipfs-core'); -const fs = require('fs'); - -// Environment variables -require('dotenv').config({ path: './.env' }); -const password = process.env.SH_PASSWORD; -const accountName = process.env.ACCOUNT_NAME; - -// Network configuration -const { networkConfig } = require('./networkConfig.js'); -const explorerURL = networkConfig.explorer; - -// For better readability, some console output will be printed in a different color -const consoleColor = '\x1b[36m%s\x1b[0m'; -``` - -#### 2. Upload file to IPFS - -The function `uploadByPath()` starts a local IPFS node, reads the file from the provided path, uploads it to IPFS and returns the unique IPFS content identifer. - -```javascript -async function uploadByPath(filePath) { - try { - console.log('\n'); - console.log(consoleColor, `Start local IPFS node for upload:`); - - // Set up local IPFS node for upload - let node; - if (!node) { - node = await IPFS.create({ - repo: `ipfs_node`, - }); - } - - // Read file from path - const file = fs.readFileSync(filePath); - - // Upload file to IPFS - const fileAdded = await node.add(file); - const contentIdentifier = fileAdded.path; - - console.log('\n'); - console.log( - consoleColor, - `Your file was uploaded to IPFS with the following Content Identifier (CID):`, - ); - console.log(contentIdentifier, '\n'); - - console.log(consoleColor, `Check your file on IPFS:`); - console.log(`https://ipfs.io/ipfs/${contentIdentifier}`, '\n'); - - return contentIdentifier; - } catch (error) { - console.error('IPFS upload error', error); - } -} -``` - -#### 3. Prepare NFT metadata - -This part calls the `uploadByPath()` function described above and prepares the metadata of your NFT. Make sure to give your NFT a nice name here. - -```javascript -async function run() { - try { - const filePath = "nft-image.jpg"; - const ipfsCid = await uploadByPath(filePath); - - // Define NFT metadata - const metadataObject = { - standard: "IRC27", - type: "image/jpeg", - version: "v1.0", - name: "", - uri: `https://ipfs.io/ipfs/${ipfsCid}` - }; - - const metadataBytes = utf8ToHex(JSON.stringify(metadataObject)); -``` - -#### 4. Import Stronghold account and synchronize - -```javascript -const manager = new AccountManager({ - storagePath: `./${accountName}-database`, -}); -await manager.setStrongholdPassword(password); -const account = await manager.getAccount(accountName); - -await account.sync(); -``` - -#### 5. Mint NFT - -```javascript - const response = await account.mintNfts([ - { - immutableMetadata: metadataBytes - } - ]); - - console.log(consoleColor, `Your NFT was successfully minted in this block:`); - console.log(`${explorerURL}/block/${response.blockId}`, '\n') - } catch (error) { - console.log('Error: ', error); - } - process.exit(0); -} - -run(); -``` - -Run the script `create-nft.js` and check the console output to follow along the steps described above: - -``` -node create-nft.js -``` - -Make sure to check out the transaction block that minted your NFT in the Shimmer explorer. If everything went according to plan, the transaction spent a basic output and created two new unspent outputs, one NFT output, and a new basic output. In the newly created NFT output, you can see the immutable metadata of your NFT together with the unique IPFS URL. diff --git a/tutorials/pages/send-shimmer-tokens-with-wallet-lib.md b/tutorials/pages/send-shimmer-tokens-with-wallet-lib.md deleted file mode 100644 index 463388482eb..00000000000 --- a/tutorials/pages/send-shimmer-tokens-with-wallet-lib.md +++ /dev/null @@ -1,222 +0,0 @@ -# Send Shimmer tokens with wallet.rs - -## Introduction - -This tutorial shows how to get Shimmer testnet tokens and send them to another address. - -### What you will learn - -- Create a Stronghold account -- Generate a Shimmer address -- Get some Shimmer testnet tokens -- Fetch your balance -- Send tokens to another address - -## Setup your environment - -[Install Rust](https://doc.rust-lang.org/cargo/getting-started/installation.html) and update to the latest stable version by running `rustup update stable`. - -The next step is to clone the `wallet.rs` repository and change to the `develop` branch. - -```bash -git clone https://github.com/iotaledger/wallet.rs -cd wallet.rs -git checkout develop -``` - -Open the repository in your favorite code editor and navigate to the first example in the `examples` directory called `01_create_wallet.rs`. - -We will go through the code line by line later, so don't worry if you don't understand it all yet. First we will configure the environment variables the example needs. It will read them from a `.env` file, for which there is an example available in the root of the repository. - -In the root of the repository, copy the `.env.example` to a new `.env` file. - -```bash -cp .env.example .env -``` - -If you want, you can change the [BIP39 mnemonic](https://en.bitcoin.it/wiki/BIP_0039) and choose a different password, but be sure to set the node URLs to a Shimmer testnet node (we use the nodes provided by IF in this tutorial). For example: - -``` -NON_SECURE_USE_OF_DEVELOPMENT_MNEMONIC="curve live black weird verb salon box increase hidden bread edit yard match mercy unable depart dismiss wife stock strong estate isolate such gasp" -STRONGHOLD_PASSWORD="some_hopefully_secure_password" -NODE_URL="https://api.testnet.shimmer.network" -FAUCET_URL="https://faucet.testnet.shimmer.network/api/enqueue" -``` - -## Create an account - -Now that we have all details, let's go through the example code. - -After including the needed dependencies, we have have the main function that loads the environment variables from the `.env` file we created earlier. It uses the information to set up [Stronghold](/stronghold.rs/welcome) to store our seed safely. - -```rust - // This example uses dotenv, which is not safe for use in production - dotenv().ok(); - - // Setup Stronghold secret_manager - let mut secret_manager = StrongholdSecretManager::builder() - .password(&env::var("STRONGHOLD_PASSWORD").unwrap()) - .try_build(PathBuf::from("wallet.stronghold"))?; - - // Only required the first time, can also be generated with `manager.generate_mnemonic()?` - let mnemonic = env::var("NON_SECURE_USE_OF_DEVELOPMENT_MNEMONIC").unwrap(); - - // The mnemonic only needs to be stored the first time - secret_manager.store_mnemonic(mnemonic).await?; -``` - -It then uses the Stronghold manager and client options to create an account manager which we can use to interact with the Shimmer token accounts in our wallet. - -```rust - // Create the account manager with the secret_manager and client options - let client_options = ClientOptions::new() - .with_node(&env::var("NODE_URL").unwrap())? - .with_node_sync_disabled(); - - let manager = AccountManager::builder() - .with_secret_manager(SecretManager::Stronghold(secret_manager)) - .with_client_options(client_options) - .with_coin_type(SHIMMER_COIN_TYPE) - .finish() - .await?; -``` - -With the account manager set up, we are ready to create an account to receive some tokens. The account is created with alias `Alice`, so we can easily retrieve it at a later time. - -```rust - // Create a new account - let _account = manager - .create_account() - .with_alias("Alice".to_string()) - .finish() - .await?; -``` - -Now that we understand the code, let's run it and create our account. - -``` -cargo run --example 01_create_wallet -``` - -If everything worked correctly, you will see the message `Generated a new account` and you will find a Stronghold file and a database directory have been created to store the current state of your wallet. - -## Generate an address - -In this step, we will generate a new address to receive some testnet tokens. For this we will use the second example called `02_generate_address.rs`. - -Here again we read the environment variables from the `.env` file and then we recreate the account manager which will use the Stronghold file and database that were created in the previous step. - -```rust - // This example uses dotenv, which is not safe for use in production - dotenv().ok(); - - // Create the account manager - let manager = AccountManager::builder().finish().await?; -``` - -Then we will get the account using the alias we set earlier and provide the Stronghold password to unlock it. - -```rust - // Get the account we generated with `01_create_wallet` - let account = manager.get_account("Alice").await?; - - // Set the stronghold password - manager - .set_stronghold_password(&env::var("STRONGHOLD_PASSWORD").unwrap()) - .await?; -``` - -Now we are ready to generate a new address, which will be derived from the mnemonic that we set earlier. For our convenience, we will print the address in [Bech32 format](https://en.bitcoin.it/wiki/Bech32) so we can copy it and use it to send and receive tokens and find the address in the [testnet explorer](https://explorer.testnet.shimmer.network/testnet). - -```rust - let address = account.generate_addresses(1, None).await?; - println!("Generated address: {}", address[0].address().to_bech32()); -``` - -Let's run it and get our address. - -```bash -cargo run --example 02_generate_address -``` - -You can see all testnet addresses begin with `rms`, which is the reverse of what real Shimmer addresses start with. This is how you can tell testnet and real addresses apart. - -## Get some tokens - -To get tokens, you can either use the [faucet webpage](https://faucet.testnet.shimmer.network) or use the third example called `03_get_funds.rs` by running `cargo run --example 03_get_funds`. Either way you will receive tokens on the address we just generated. - -## Check the balance - -Now you should have some tokens. To validate that, we can use the library to inspect our account, like in the fourth example called `04_get_balance.rs`. Same as previously it will recreate the manager and open the account. - -```rust - // Create the account manager - let manager = AccountManager::builder().finish().await?; - - // Get the account we generated with `01_create_wallet` - let account = manager.get_account("Alice").await?; -``` - -Now to find your balance, first your account needs to be synced so your local state is synchronized with the state of your account in the network. - -```rust - // Sync and get the balance - let _account_balance = account.sync(None).await?; - // If already synced, just get the balance - let account_balance = account.balance().await?; -``` - -Let's run the code and see if we did receive the tokens. - -```bash= -cargo run --example 04_get_balance -``` - -This should show a positive balance. If no tokens appear, try to request tokens from the faucet again. If that still doesn't work, please come over to [our Discord](https://discord.iota.org/) and we'll sort it out. - -## Send tokens - -Now that we have some tokens, we can send them around. Open the fifth example called `05_transaction.rs`. If you want you can use another testnet address or ask someone in [our Discord](https://discord.iota.org/) to send you their testnet address and change line 31 to that address. - -This will again set up a manager, open our account and unlock it using our password. - -```rust - // This example uses dotenv, which is not safe for use in production - dotenv().ok(); - - // Create the account manager - let manager = AccountManager::builder().finish().await?; - - // Get the account we generated with `01_create_wallet` - let account = manager.get_account("Alice").await?; - - // Set the stronghold password - manager - .set_stronghold_password(&env::var("STRONGHOLD_PASSWORD").unwrap()) - .await?; -``` - -Next we will tell the account manager the amount of tokens we want to send to what address by defining an output. The function to send tokens accepts a list of outputs, so in this case we will provide a list with one entry. - -```rust - // Send a transaction with 1 IOTA - let outputs = vec![AddressWithAmount { - address: "rms1qpszqzadsym6wpppd6z037dvlejmjuke7s24hm95s9fg9vpua7vluaw60xu".to_string(), - amount: 1_000_000, - }]; - let transaction = account.send_amount(outputs, None).await?; -``` - -Let's send the transaction. - -```bash -cargo run --example 05_transaction -``` - -This could take some time. The manager will automatically go through your addresses to find enough tokens to match the amount you want to send. Then it will sign the resulting transaction and send it to the node. It will warn you when you don't have enough balance, but otherwise it will show you the transaction ID, which you can use to find your transaction in the [testnet explorer](https://explorer.testnet.shimmer.network/testnet). - -Congratulations, you are now able to manage your tokens programmatically! - -## What's next? - -You now can create an account, generate addresses and transfer tokens. Check out the [documentation](/wallet.rs/welcome) to see what more you can do. Create some native tokens, non-fungible tokens (NFTs) and develop your own application! Have fun and good luck! diff --git a/tutorials/static/send-shimmer-tokens-with-wallet-lib.png b/tutorials/static/send-shimmer-tokens-with-wallet-lib.png deleted file mode 100644 index 6bb12771ce47fae03010c5dead6a85fa296bf586..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 509641 zcmV)SK(fDyP)I|w2%1|&8ECprW!JPtQY2Qxqm zDLEHJRs}0P5_pTn92k11>)kPg@^kZxcjS1~o+#L{S-AXC`WP5Hmw0ae50SISn#KC1!IDEj%i5 zd=fA~9aUruEk7MoVHZqYD|vz}eT6QCiy2vD12{zlJ4hE+V;^5_12sY@Zh03~U>r$V z7)Vt#hmIdvWeiJKCv<%oUuqs&X$C<}5>{a*~4o_MfPhcKiXc;_A1wTt9ZFd-BY$kkz6kBC9jFKTTKOSOhCU}4qG($m8 zS}%2g0QKE5d4v;SXb>wp3o$w~e1{}fWv;@|7&k~Eb$m2|i!F?gA45_QEkGhsU@2m7 zHj^zQDFglcfiHSMV_QPbbwG^XaZqk0Fa46Rb(_`Z?Cqy z(9_lctDZBVpKgJWM6Ryi;^c&xr{Ln`0Mo#luDk?oZA^)iwu$!|00+Z_NklcJB;pcbJ4|35a%(9^F{j1jgxI!YFtdsoab}!9 zBm`FyN3Th74H6gkH3SQRfmb0BRN5dBti)b*NFd}I6&!Pu%B4&APDDyeOPwy0UBJfR z;7gZo-egWe=U}J62R70LRyl?pRQW3(pM)!^!n-P>1rw%n_4|x zRaH?{(OaR1RP^>@f$WKeR99E&^%^SG8V$DM1<_YvECk!=hTL3zQ$=S*MN?B#1^HWH z8fxygmZFn5=txaIiek zZ8dk-beqk~15cmM*9;7F&zid@Cu_{QiCIgzdDd#(s9Rj@n4hny8R+h|6j?0g<=tf2 zy0J9SZPv}2muhN9M&^$;m-F%_>h^y5%U}NOFOc^y_HbBT-PYFD;!1gsu6uEB?_C{a z>p2E2PA;1glX`pm%gTD1Dh_wot7FsB%N~_iRCVfelVW1hrh1k;I_f(1o;`bl*9-H+ zYHi1}qk*2L!IyQlHE+xG>0MKL%gS<5-s;?hx!hdT-2A$(!(&d}j{ zj4CEJzrbKn#V31)#m5(>^<}1KJ-Dk@tH0lt2?PT1rLQy7`wGU4N})igOfV*dg$eoM z`1YNcbWLmL%x*4)OhrdA>#pQl z*$cOy#`aB^MIUzCZ=9Ch`B9fir#@?>^RnY``_Ip=o+(11&`U^!PsE#%b57#@Vc~mu zc^%*4&xkLTP(~6Q5(T+_{W{+1(n+}tQL;z*+Qc>o_Spx~fy%Fl1O(Uy2G}H=h_932 zuAo#JjR67pz&|N?@gBXSeF(Tx8_G6 zb&Jp5?{yaq>QiH9X0qz*v-JAi(Ta%tG|i)z3w(g^__`T+2CVKX6}s6d{3kD6AE+U+jd8*GSiY`!!G*8=Vy)?<(<2hg`fJm zG@2MiZQgn+-kv3imWEQ^KeHEiBNGVkdg#v+8ITjgnS0#^%PFF=4c1CwoRV|9x zcKj>66(8@dP6-Q(YRK%G=}*ci1%mxNaQnI#7Ojd5=kp~3u0Sf0Nc@Aau~eR15EYr4 z*m*dblvtfw5O(Q?Sb*)m#<7O$N{&G4?e75|=N|KSG3`>xJ?e1KU%1W6JNJB_R0nCDeeiATKHVL?u-dwUQltx9WINqfaA%!6r z4Co5QTz|Ff!tiY@V-Nwb7r^7X6OfHPw1jxEmlsQ4j-40+^7xF3a&ba?q zslY{qYvK5Khi3S2aak_>;&H7nj{^8Mek*)QFI+h#jQ|kFd6;j*`6B>6fjy^bm}{iN zodHY-usa-MeAweY8NjFIHvoLbJS=dzP6K`iz+V6501o{P02dzva6(i9`Cz$v3cyNC zVF&Q#699Gw?MDL`1ZL$^037mR0N-)|_!xoh^!+#hv#TG$Unc~!^PT`OeY-~ZYX`7H z0cQU|VgcY|avZ>yjsv*#V*m^S6Z!gUmb=h|?ErQtz^4!l09TI=?N(IjtDw@_0Zhl@ zQ;*G6O$>jBdV8B#07DoGlfioYC6WuR7atmEu2>-hu}+BFY{CqzG+`Cc?W}Pz#N}togJ{`l@*m+W+!yk?wYmD8cSK;;9zre-mGrI zQoh_h{|@8@g8%hj|CKNpI`H1!-isH{>Xs(<=eOQH-Cx3a1|~b|HWqSIBigce2dBCo zq-*rOz0;zFz}>q-n=r{ zl&kOWS?O4|PUtqD9O)iEH03?rKltgVsf9V~$l}(|wJR@+itzpRp*Z8|0n|U5oPC%% zCKL>pcw96_rXG%_H?)j}rDWt7r3ETQOmrksQ6)yXs#QcSOpDxy_m znTfwHcbk%;{e&DzVRqGe_MiSVrZO7C@-+_(#sW?2!cRXv>}l>zi-~!)e$|NSQ&aD# zxl;N1%SW#i1;$dPgz!re78#wSk|%3(41B)y$L#EQr8Mf=)oX=;f$_=T7pn!Hp666a zgF~I;r8lJbmnsoMiIxW|0be2Rc0vG-%PlD>A$K(aC%7>C(P8IkMQnjl2;7Q;WLmW^ z=H&J>Lnn@h`hX^6N|-sdE2Y@kZ}A193H+c;=18W+~# z$-H=WUC@cF4rW0cCW<-*9bIw^qvYmc8CozWA-T=h$BiiT_yW9yYKKI3ceXM_U4 z+}jWrcMgaTgMgP8_6h)FN?`gp@dp6R0`wFmo#4tj0bo|~rSmud?5vLd5dcFzJk+7s zo|??Ioh;fv&lK>N$j1WM-wt5B&I0gh{uURfq}VlJcFDnDg4Pdfz~Jvk0T}Xe0A>mN z=>UeviQv-);9IO*Is?Fd|Fr-n8|*vioXiveFnt7|0KNqQfU$5)1E#v?nHn&aGfdFO z0qh{~X#lfA&WCBR(b)v;tN}xg12`4vg}&O`SpnFBzbA!)v$J=oxl`YzVGPju`RV!j zu|%6B9Kno3rIL-2m*w1hy_)bPIVpvw7p`NL|Os(o#(g)Y_G` zmF|tDj=e7XGzx?Y9;1>(;Ucdh3m-p|1chca zeP&nx#?t&mca09;=HY{fy7GN!^0T_xP2l(Er%yNXbh?cZgC;dw9wsq{$zQE!OT}U+oidN0J6HAP-Q5eB;T~VN#VNxJ3}fL{ zhfPycmRYN=tHAw&hme16Ox1TcDJdp0>S~4QadumL-w!{{ncpt=HjWtzf=m4_T<{3I z84f50M0a+kHbB=C3h*kCl_p0u_NgT97X+TJLYaUsl^S#8!C~TXqdY34O|FzkJTOio zxe-#(Vu(qLKJO|d>=kl{OG<`CL6siv&@^w~hJ94X7vg&u$HrQAcfvd>zpos2!(Ds3 zMC7jhk=T@nOK{9>+`rv#mxu)6shxe{TtP~FbVEyH_N#vx50WO;KWK=&8m#08w#!pe z#w7xfC&*hwZ}zSPz+}Ou{fR`(?N$Ws^!DxHfXK9=s&;|TFh`c5_8{=bARj@{o$Q^l zF{6io1Cl}Ch2rYM;Q-EVlwZWEd&LV61)ltK-skvy9`+F(dHasG%Hid*(j`VEYyh*T=rZ zF5r^^Fe{EN*yI4PkB{gR0qhL*k0P+MRrw46b3O{dz%MIy06QQ|H=U#`*n1{`Pb=0+Fp0GK8 zaP@2gUpy)H8Nyf<7?;BW_-g=|^4Hk|+?G8(olW^mfrwYWGYFx-+5vot2&M#j!%C?D zxr`6k8NhG?V?5Dy2@9|0U&V`@5gX{KDTg6ozr*zmVa}INPfsCQ0sU8BT|xMZC8_{d zQ)e$;;IW?3fQkMK^JQ9E8jQ=hdI(I=jMiJ#oCnS}H4hdw_X5EES^WzpNPQF5Oild& zu&H^lzrP*??xh+qROGIyg}ez+X|)-=hB11!dvbnbZf>r8U2yEOkHEe>GCyBiR|os>B#hCMFdWyJ85yXlSsLlU-pRT;XwVjTg$Gtv1{lLLaS0C+ z4R{d7ZrG~dQ2@VxK>+-0v2J621jggN=g*&S)jfrm_~-rongLy&&eGhJ9z(ulZeCGQ zy+)C)X{xBsjL{$N_D(6%^hHH^mgTp#BXz&*y?**`YwP)oUtT<~!|_CWt})L&UY)QO znX;y``sd6wwKW6%Sq~?OpL^iV2Bs&vziw_WuX%3Hy7BtwpWi)uw)OO9oPN@jtH_ZE z#X%Q>g2aZ#^scOh&epW39A$_iwKFjv>;r&-;rofJ1D2xPXo=)zV2%_j9$%R~)H-vo zwW+E)#3&F$S>uOC!i}32sYvQZ8mH8$b`CHO}ipI_+9 z7Y1Dr2muryiBXxLmchRYbP!!s>R(cMF}$V4&|VlO$=J~bx#4Ds!CZBGIC1JyKP)&X zlqjLA#wYdp4s&Jd9D|`DwrVKZH>7F?0KTsl^R-$(d~tYOafSZgjNuasr8~!!Ap^N_ zQvib(0w5ItmR^s>V;3F)JiXO2Zvms3fqd$WI}$NJNWj5y%FCSG_CM#l^+n0>GG#aVxuE7rib!U$G>D z|61hZgT10F-+uS4h@~}Nl*yI;0_MSjADVps{(YI~bLy2XDGv3&pCNN4er8X6M*?7~ zP2*s%k`jhlBH|Zk^;Cx(+i*4rodL`qb=<1VF0j0In*BJDPq??wM*b(shYvY>PWu+T z7(O2Zu!t41%=_}oFZss=BtC}UGfdDYz6io z5Y?rSkV}NX1!n;G6g63foz{lWAonRbw%3`!utBpD2O;!z@V5=G?CG7I>FEfv5(w_) zp8znBcpAVCxp7=*5SAUlarqJ1Kq~|QW`)ef;`wR>$bZ!aV2BfdsVlb^fmWa>v|kc$ zr2%y#s-eCTJ2bIK>nj*((q~O+H0kN-)%q%iz#0TuP34mPgHU4^76ywRHJgCktgMB+ zyu6+slL?0F3Vm)?R<5bJ44Q9!lYVsQu(v5opQxDv4d#e9G&?m`lUP5e>jq$9iZ+)M zaFU~Ydf=|zw_0b*bg$nn{_>=wd#R=l-rB9LjwSO3?9E%R4>p#T_N_~kaG)-YbPuf5 z)U$3pL9hjG3^X}EhKGba%HBI61qp4`+Xr(B#FWtJoanL=mYOX2o z>BsX79$(rb^b#&yqla+Dium`JS@RE!6C7+EgDl1 zu>_d!O?9<4wRT;-DQk%tO;f1aqr=aKw#n{-`G8Pr0Qf!yp9u|rv zmm3sGxsl4mp`rAKsQVIuR3sG0WWoy&p}^mt$AN%Bx7|G{y(sMYB0^vWz=UXGWz^uK zU&Do5Sdzg;unhF`67s!7UL{<2APZyQc;)d}y5O6-V8P2jT&*q{9wwlJ`ih_}d{Lq- zg|}2?$NTbJt`vWdVI^J!punZj%X=G+Y5avQ?dtABr@{+k>?*Dgv_hB9Mc;kD&E?=H zbrZ?HAHUw!i*MvDZH!$_m$!ksuwkMF^7vN=`!Po#{01W5>z`-94V7l$&0L<#Z_CKr~ z+wFG-fN!1xFrxwQfMyY3C8cftX#m>@eChWHTzVY9`LWqM)7i090-Xf&Q2^uofG!JQ zygAMZHiMp{y%fN}a78a8Rilr}hAMDW_4G7$K*#{l79r16a3;(J1-J`#XYA|A)8*y$ zL(T2&9qO&`uQ%n*_4H@uLOTY334r^Feq7c}&jb5(Y;0;`D^-$PvtrZIa+{j-Caksd zPY3gw%gdJue&_NAi!9w6`%mi#Na5ez>!^h?JF>V(;+AXYYxkZkzJ3kxPE6Z?-O(&6c7vxPZ&bmsdI#_n`ScfA{kiq^{O#wd$5e zFyR&`_~HfpvvV6GaLktVm=?11JJVG|`u=<6mZtQy_4VnrnAG*Qw(R&@w=(-JM^E53 z-h1)v*~rGh$l^0ZZ6P|l?lrX7#qPPObcIUaTb8xZ12wm1a&u!ftE>6t=IrWE{icPU zo}R3(%&xAk%)5>H!Oa1j{~3a@>y|dmbNyXoQZbyo0R_>DTOs*XWlP<&S(%N7f)ItG zuQf?=<6@BZT6R)W+F|*;*_57hQ7n+;G)SSl3Ugu-`->hW<=_U-Rr^Y$FdW~wkrPqf zwXh0heA29&$xR$O9O{Z0zaNv93W<*j55FFmT{X1Z8B?m>b{B{dBo!>bRu!w#R177h zre-Gxl&U3ypyIn@f9jekYwhZq`StDf$nn!YB8zsoYdQk#PL#Gsjp_IMH-Z0@|}zl z7_-G;H|2%^&-1>AheJsLaC!rO7lMk5#p+@;4)z&T2@)|*B9IE* zONOET$`D1Z9k0r6zaHxC;>!1Rr2xigFE8Tw1$f=uT$lhWkt+<&YuA<`az9qvdD+PcDj$!Bp0EhYuSYEsG;PLh4yK>1jadGR<@a4I2ysr4T6C*Ya zdctvx=^clEI)G0B%tm161OKl9*uM1-0hsO(G4kcv0Hy?X_5uGf0BcJ>qyS$&0bnS= ze;mN9*!;mC1z_96_9$&93^Uwi0gQKSp#ToC3kzV#hgfQ}B_A^zpO8;hfSpa)rvdEn z{{}MrWlYc6M4hB=*jOl_v5->$hS&iN0cA@s*%4f7=dUw>N#JvS1lUfY9uas-;0|Vz zkL=>?0wy{x=*k3OQ2;l?id@kPU#=ckNC8|$`3nI#X^K&78o7StFI8)%sH?XEil#2F zzi9yqp9$;rCRm=qUmzO%)k9#12A{!d%!Do3)v1a4R(OP4bGy=#lJuR;z=U~Yqq)~q zR#ep719Dl`%FS?}A|t3HZP438}wvt?a1Df7cd&ncLTsHn*j0rR^3P~ zGJ=5B<#Ow6`Et3XD6iSntg|9c`sJfCSfR^w*1E+P2)%l-^?Gq@YXk?wyF6dF2Nf84 z^^5n|RI_9*f)l%^xoEJrdS`vNwf~-_XeKdr=jye%{Onf|`Q&GA${Xld#0>9nB(4Rq zUkCg9uw}o0{%-NfF9SVYinusUwSH;=R&>OcnI{&eG!?zgO|Zg4{YOYw<_}p-&HYn- zJw*fX+Tsdc>>;HpZ%R=BKwS`rhmSQx7UWz@yl1uEn@Z1A$>Y)#jhf6zqu<4wSEn(- z(Cm_>zE2DZlgEUVey^?!QNYC9s!)n0VlnKwVaf6Feiv^{_x8Z>eXzeYdoM9FGq=9= zhe-K&e6%V~9;Gw}@WT^QzupPkckd54;vHSE<&kQlq04@*JsFUFj|=PQ2UD zdT+45ex~f@%XYaE5maKoQnf6oM8Ne7AB#f#bw~nfwo@3%zaAn_ zNsuAF1<%hs9+dLXwwr#q|J}i?{(M9&c>{eMAG~tn5QA;-lSporR&q)F^v#SgKkxJB zb{`#T3{q&<5O-N+P^B7&N^sMsq=X9N%Jbg7BBG{Hp}&ZD{3s6?Phd{`P-~J@00I-r zGr}XnS9=4=)Fmt{&e--QbOzACHZBiC!pD?Ke=%`uD}9IYkReuPB$o=c$%QGQ{7`=% zZ?#s+a|g@;TKH!f+c#0j0Yg}q@#6Sg`Q{rEXT{iU@dhXp$ohc7+jqVf0scrGa?`r+6T9^nB#Fn<)mzQuxNzw;dV2{fy|5&bm58|PGX|@)ix>%J z|F{bnat7tj0`SN9dOy_!eR7)92Y(#+KNi3&f+>4h3ZIU^I=y1YuN|N8=AHy_ibDfF z4PQqPv~324uz=&I0~jwmhL6W-IS_1*#==BS9_9}Nn6WxL(H9FR0en&gw$sucHg!50 z>(e!0zmEVg_rh>B+m_$fcbu2MK1I-S}qItfWv~<{?DS&fx zo9eNBv}~3DxW6CqRxp%SVSp$UvT(t9woW{IAcq_7(we>l|{E zCOd%9XM0;)@8J^e=;+St)x>H{gUc^>W2@G8_4<2wBB+?ojtluZFnc{VKPEP!N@uP` z<}kvy_KuDwH;z~3e0i_p7(fZiT zzRb)AO>>sKg$H>SL}<@hpKd+hs#&)5MjNEWyDBz@2N-e;esLPpo4JLlq%=ibe7>SF zQ`KVhQ;$cqPW|*?Mz=KE+K5mnzmT|y_?uvwysxh>Jv}-{QtBu1l}hDp+3hzj-l!TX znxC|9p$s++)230{g$ye9vq_DDkJ1OTp&xMOiGcx>wg17>HfFZJ_rKK?0712@J@$AU4vG%r> z)b&SIg#mK-hci5Ijq!o;Jb05mUGHc3;U0e{L#wUyf-99Mc>)o1z?^6W+}yrGfl{r8 z0xZNaGscT$48MG2S2)BjDL|B!M0`Pj3rSFy zfUU-;!uAX?0%^{Bx+2y&A!Gb2KFrGm?AzPl;*=sL8JC_NfOG+6zx|epv0{Rg9kEOt zLFJu0S72&pvUhAqBKf>Ro;!76ix3X|53c;rp`K&+7kDnf9Ax`9vMbQyiPmffFqxci z{3J-vGAY|uKQxA3qto6q9I^k;0qksoJ`P~^6LQ`G;Pb}=u$=}coaXQE0GJw|sUiBq0ERG&bQ)&>+fC38VUbG#%&gL_e-j)T+!!1Z zd^Uhtm+uGl*H6`ef0Mt*0qjTt2KiV3Ln!(PfMX#9!1;uX$0U&Q(w2$j5Qin2;jc4* zA%WN8t_4ENjwJxjZfnCtY)uY(92kRomcOR}j7|E{UTPdhlyVQWMg&Dq(LADQs{4{9 z8p4b>x~|dS3&ccJLpz4TjO5-&76eVf3|%&8syETmD7Jwah!Fnv!us3<6&T0TY^Nrq zA>mZ_^75MNvjE_!tR^rQIlauW(4=+Cn`>t4#?#mD5K-J+`(&|hAN1W=LY#BCxx03= zZln%ATQIlQtSehyTU&ZM@?vjm1c6LH?_0~DMT5Qwyn-%oTIg>w?d~29A&+@t{~ZA^ zBA#JBK0<=e$>|oZm;9n@qu;ro~BW%zIo@SJnoXVG)NH8a5pPAap&rtn|@+xxG_KC zS~yB`H08}c#-okd+F2dn-ZtIZ+KO}|rG(EH3bc3bOA+lQf>wx#U6Kc6Q01>jgcyy6 zFe#@nIYpV0oIHNNQeD~}X^8xQ?p}{y&M_86D5ITSn_q?Rift#c=vCX;&v$Wmu6_U{VNlUQl3^VD-rS{ z;|t|sYG}F_D%HZuVs)vS&lhJzst{DxAPxGyge!zCTL6o#cl^J+3POMt!k1lzz8M+G z91i%zD8xL0lPwmAj~^>f!@D575ep?r=DWlss9 zc?D`Yi~(R9c?m1Gx7}SnkBph#8ApPar#mq@3$)4c=RL^*IIMEJm;l%d$H_$0&P_C9 z=(i;$n1KdY+3e7ml3toi$rZWmSm>%PV%QNZA?mP?9TqiC0{~&;!<&OYZ#0b@ekNJS{vIF?M4Zv6eU+u_s{-E+< z0Ed16z(f+9#2zNi4u&}K7XW62K=G3SjCUyn3nu|=XE3vXSxx{L0svFao&>O*0dR;7 zz*IuWs~{N11XBPr;_Re71E3E2o({>H*8j-aZcpkssdEPVx<6$_qAWHZR_zO?%28wYY0J;u| zvLgu8vdo%mJB}8K-?pw}z8g75sEdUJ-uKU*JgI}!&H}(?WzgiCM@KxB=q+8yOf+< zS{ZafQjpoznyxZLs^kWUJU033@%E&y)r0xTwUw;C0LhI@+8Y;*FgkNRTQalCstOS* zjJ1#`1VA^O>+8zOn>9cF=_k`nlOi%FJ}?H+Rd)-FP_wy0_5J%9s9{wyOuVLu_2CBj zW-AQ%U&tU8AhS0N>M7qSRc9cQa;Lp8C!Fsc6oku*9(}Z)9FUWv^cHyE!MVb7+GFF# z6zS<9N-lI=_*qb?Vtu_WCqS$$)e4{|a>WT5cZ3KduJlCF4&1PzlPW7Kg_4|rbLW%8 zq#oe`EpnK<$-@WqK&}uWXi|f`eRsWT2-#5_E-ucU=X?J0CVhu6C-~LrBlQrgj0P^{J>tm8RPepL;3&kW$2F?z9f1H%6%)L6L^6T148d;5P5vl=>C#64m|eC57;hB77zXfyz+mu)0SqAvpGe>{)!?)FdknxI;4k#j?CQ2^ zzz>p|26!nT3R}o>(R}_IQ`=JyZMcgk%^w>a`>Zb%u`888ckxSUelk4B0k$ujb=9%?5#+}qKheV;YscjL>ReBHO!^ee*h3Z7 z`M2Pxy{pk5KC%>{nh5flm(8p2VV9Q=rZ-0B7%vb2mw0(ef&;G>A{ps|QI%C+(boU~ zLoYRk#I6U9-&ABic=NQQZf!ZKFa6aS*v+w z^X$V1Q}snl;N?_}qQc|k!X7#966zwU$tBnK-wp57T@YF{J|6-Ec#O-n3H5eN|Xl!|Eo z_MPlDsSs)|HSThSz6lvpiTZoBfEI)lppZtm#8<2gZW#+N3<>bNu8IoLN`$1kB8o+d zF2HLX9-X@L=v76h>d!n(fMgrK5&#yQ%SnCp*KO|Y5~T0)c;3EWUFP#_(BJ{U_M%K2 znmuLg%x<<8I{m=gc&;Ne0KZnP;jg7+dgh0?j@qXosNLK03;ReYn@syjK zy|dnaNm!{gq_)TANC8mbQ|9jC#y=N+jz5g^fPOv#5j`XD%VliL&}*R!lX@Bijf{>8 zwvr`xmoH?MSHMebp;=KPnKM5)_|ys5$rHUJ2YTQ;0PQ_3wdylrL+PO<=QVgWp~dssHu+r$)k*5pS_L(!{f zhVK_3u>!!T)V#7>UR0LX!-QWVs7E#0t#Ap zm-WU4huyg7aUtk}@X8f$;q}z2#H5x0aY0Pya#2;IDnI^KNP#iDZT&DJIn2=5w?DEt zZ`qA507+2~!|w(NEX_$Y-J6M)5(QHk(iWqLNz$~!Qm|HTdeAkxKHV@DF1-;}kd~Wk zkow7j1TYLs#3)?lMsjUDiDo5M%HyJpNWl$Lh8vT!5eh}nS(=;^CZE|IQt@3qw!bSG zz8zWhD$-#1>s2j*SIYR0r4mU%ctG2$!=0-^xYHS0T5>|#0+e??<7)r;M^s;?#FeNK zJ~gft0y`zLO0@)pHAcn7#>PaaDq12_hvK!B$PE@(ZVwBD-}~~VW06%=ov5M_{bx^} zU>Jue!=>a=fpR#L$J0JXE}_A`6B_$ zJ%d?3j=*HcyxjkD02bI!DL50rpBjYq2>^zi1~3cZ(?y_916b`Op}z-U=O8S|X#i9C z^dKx&&H}KbR`rJ*!6A13vL@&-ieM@jPOEVo2k5bi8fUqI&z9c=@bPeDh%Nt@(K(&m zzu7E)83rTMc64+-0+b~qsU}R^!YqL8_&m+vU}pv&2QZFdJ2E(gPGSQv@`TwyFA$j2 zvT}HUD|UBBNoW))#IZijI(esQX=f;-gvy9&CK$zHJ+1Lf1>w=_`m90AKrKjxxa4ls zXhy{;lD*r+D7myCB|VY|GJl)q4$N~4S%}nv5{W=6_;hh-w{_y)AaGR=_cI_30XUmX zJw#>)YB%=h7xy-SstI$);ug%riz79&Bybr%;EpFKo4hoF5*VoGTsJv6Ie@~JC`nmE zG+;{+C2%i(Zn%F<{c~1Wv;TDqX-y;Z8wUqgbInR^Hy}7LPz34K>+`x%0vd@#h|QYN zm08fqp=b~dC(=+vF-D<5>Er=a=hDH_yf&bF*fY^x*MWzJ0aG)=t9u^}nz|6xZ0d*W zHx@s#z8C&oD8)VH%gtHoeM!}(o;+(&S+73VWUk$S>OX;Eo3pDAAFpmKt?5kZeb=h1 z13f&%LWBt6-@boXOlDu>m{D@Gy}l4h^mJ_My`X_}@+0y69HaMho1%D|D`k}2X>DG*cq;8YQ3KbU_xFhSU5@F(*Qn>U;4?esg+dJ z>f`)9i@g$RGd`V$CHLo2J!XH`=cz%({G|91h5q@-XQ zfE_kyN6lwv{xaTSyfEF>>}eZ-V~+ti0*dS?h-(AzH1tnB17Pr%5V+ISM7GdmV7f$$ zUtty!fraW-&^t*Zp<2?Os3>pFL;>6c03*fM2H;$5fdSXLQ45`KVRb=g1+KdftQ#Gh z*n&_j2Ecj%7>PQ_7OFSF20fT(si^^gI~F(1x;$$)N&A65JTi|a3kZOET041!f|Mg2 zdoSK2rm7AhP|KDwl!lz&&>{Q^N+}EA-XU1dd#p9j5q`Dx6q@qVKCHe)<;%68nsHeu#5K9v zV<{UPEusJ}Gfl-*S0KPnU*7}sI=&Q&U8Cwlz^RMyn@McvvP!1LU z>B!`AQxb|&#YS91eMwLGcCHHA-x}# z`^QrXL*%U+MhSet5}2FfQL*}7x;kFO zkRKZ(@hHZb0AP-H3QAET_>)nJ?hqitZCjZv3?^kQY!87nuXx5dh;~a!yo3V{~DN zfiD0fgAm&sn4FPODHM2@rmCVONWKm7;tG|D_>7Wa+P6o2y+sw@7N%5IdeCSi+HL_| zk3>ScDhxu6k>r@9p+rS>YEmx3%?Gnd;R`OJn#J79F^|$(6sgm%6l1ECVqSPy1{}{q zSftyGX4=!N826wUCVAQCVD7G1dl^%fhyd7=Be-&<#GSB}<3?D3=1{ki1}!U_Z{OCZB52E9SgHM9O`abF zC>Z^@&*xkbErRI+V&NKupt=i!qFDgD2)sl*5cZ4h@4ll&E~)s4C{4YJwZ&dkCzg3Z z*LJ}sY-bc`8mo=x7cT-}EV50HD1fhgf8U?ayPn*}!7(DtMYV3CC;uk_?CubJZ5mfi z%47PRkp^t9nf1R1V2FL=CjutNj>1OPKG;y(o7lliy~06Wr;9QFqJ@~jCn+?%|1$t+l;V%I&J)Lt9R;)$?`a;Eh zMTkqF2>=uRQhK726WGh*7YZ^%VA7N@w;wiKGy#M>>ma!{h{PflD4U320lcBgF9EO~ z3LY0LmUvUbyA*<7TJjo$Co9UTF{gGJ`0{ey|Y<{khTv0+f(>6Q2EY8U@P zl8+`2_PYnbb5!|2`Dp9h!-?|cqGnD0HBGN>;($!M|7P_kQ}f|rS#L~STTI{G#43cT zr6pC5zCBu*=;=qbO_YhAtm}A=Os40Hk5_d=Lqkx4rx;PY=4XtouK|d+}`RU=<--rm~v9yr?UR3A^EULzQ`JyV672(lU1L zT=@O_UmM1d@f)PQd2MXWAdkBm7h*tXO37GDTKp}Q#e|fxI z$-R)Uvy**}CoRnELtNBfciQ;U00ew(%Vcn)qM&7gJQ=x4SL5Xf>wqS!YFmGm902eH z72iK>kK+4Re!GqEW!|4I`+;fh0I*ix5FOJNbvXbfMYx>X!@xEy-hdmNzl6raLaA@| zXxXowcTsbzaq3=8eIv)sZ5S>&SiJ-8zRYdx+$L`*Z6uS>= zvqvAL%DFDC;jUgcz z=r3+_-9951%N60S=LwDv6B98}U%k9xdJig1PCa~7hRk(TS5&YR@LK?O7_x0AiE;#CG4cTb7uW&p%wWpjoYSV`69C5gDW0A-O4~O4)|i|e zrVlVF0{wLy8~)6CUY!9<3t(kK+K2#NO}#^hRY|c_Ic0_-Zpv9$g5vLS0z*O^c4*)j zyKco*Ym&wT?+1Q;GZ5#B$hQL+M>7^`%tE8E0%^E40dN~o%v>J8Pc-6G_<&)Erq!Sc zgdx+oQj*Qv#I#xRL%7y3kgM_(ft>Y#Kee`YMudcm*HY&;;`W&Me{z?v{0HZU`gwBB^0C^Hj9zeT=*?rV?Cj3Q}%C+U?n(}gz0I@($zxxY8D)CS=X6iv+ z6yf^9>eH?FsQ(NCZ=u@bVDHM>+w#pPBhasx1}w;s(&QuW2-PPy5suuyFoO~zot@P& ziZ&!=l?~#H_gFVJ=JG5})%j`Z4<2v)f~;ZqraM*!)6=rka!1kP@Uf{GPZ|qFD`g~n z`*BU}CrY)8t_!?4C@T;q9s<~(dWid$wXcW+@JF?95865JX9(RuEpP!!9Xiimih}Ie4eLJIBZZww?w0G7N4(7LEV)0Fe$N* zmK3+gr<@NkglQ{XZu{`np@KW#Q*4O5h2E9!9BoW-5>9`>A1q7jK3lrCh?)6tp%cTSwj3>3EAWFNfj(@o}*%(6(kHe?q|iNt}sk|quQywBk%CYeiMyHooiSl+)Ca87j=#0PY59~-JMkUfV(BL;q9 z632=Qbyz#Zp1XVk-u5+HHzan2F0%(Xo2*aMm-%q&_26>~(XI})-kGHz;OdziKMvs! zQW-T_SmsjU3n6rYPu{&hTBK4tgPn7coZlh7X9>GA02G#DDok{$riVkEcd-%xVE`L` zO6X?WfDasdI?|eQ*hx-ou??{S7!l$c0&RP>rK5q7PA>K&rpC()JeRG27=w? z(02jtQIf1{Dq3Cx2`lOeff3n-B3MW=DleL?>ww>P!@5MOMM2T-9ze%J^a1XMpSOH| z|Ij)s=V7WTf_jET**BXnl8aAj+2|vg!efBj0Q+AUM$v?7d5ZFJzAPX{MS-# zw>7W17Z)^GG&^DKM)k^`o|(bcTuq`zp@_*xnpIgDBF0u~2Z-5PPdZQZuWle)7%dCU z`__jk)uEcaDhRYqb36WhU8CY zYV^p18q{Z|C#6Oe(5lgroP2pfPNZTQeKM-64GG1U@#Jfa+{F`7eQUZRCK3IR0s;(b zHTngI_#x{SjSu{!#3n2ByPB^MW62ob(5N_^>4I%o=_>=fIMSAJwE*Vg%i%CQ506Df zhAVSW7+P5RwI(g5FjzwF;UZa1NYq!zPRJ-0l>{j>QvN(X?oFe35uhCEC;07rD`~l#%lQU@^!^6@adTQ5(u0wYfkjfO4C|}(65|KPzum;BZe zLUIBSLyr1gVe$+pzQ84eFUKvL$Nd6Rc=7`P;KE4ou~_C!vWa-qtIK2!T@i7JgIUOt zsf+ob8nET#eJ7O17u|LM*#ELOvD6drp~WyUKzqsVXhRX9E%2rQ#%XXmoB*0Iev6jt z2_yr|ht#UR{RK_!6#<3EP=arN+a23@(ytN-%DI##w;cgf)HN;I7BFE}&IopQan3Fx z11Ug>w$BQaMf@3#Ckr11V21|m3}DWu0@!|CC->VsJe&<+r}2Lbz|I7Q*qRgC*8d2A znZnLzV%Hh5PJz$X%t7<)4S3<5KPRcwO# zjY?Cby#uBoa6JZK^0HkP0X_?0()*AA7$k<^0#R>cbZ7`11b+#HLEx%sKnXl0PE_cS zy;vkoj7WwO?LXK*u|X`)P=7~Ig4qm*YY|jM==OuX@c#l^Bp?f@MY?Ox0wE#nzJL;% zADIY&6IbV~H3OD~1rvZd+6#yAf@S4x5tvO_Y=V;*b+2B}FQK3nLcA8|H((upz4+qA z$o_<7U=lT>%_PvOreg~L{-S#sZ0L|FyP86wL+I;qQ zxnF0oWaa9SABCpDlN*l#(4PA0TOnad`sU?w9aLpJtH8Nki^`K$E7~*RK}!z+!#Uia z6%!M4x3N)^NUZUVckgCqrX%kA;X;3UV@rTkLgb?1Zf@sLs-htN+SMFG6wIK;kkrwN z^r#$PrJuU;q93{$6viet>K_q}J-r2eAsSTI$T)monCj*hq^1}GB z!tt-porkXbInQ6~zkLU~DM*Krh(J=x+o}pZ#9|MWkLJs>Q`_5BG1<}4(bspvw~l&<67U&ix2iTVmi zQUDLj{Do+VfHkZFz>*s&sJDp$@gdhyb`w1n1KZm0bnzMBiy1M9MS&|RdjYKrw)d#$ z_V#3Abmno02t^Fkh~W}OY

&^cQ*BJOOdULKjtgy8_afkWnj#{e8W^#GzaWh7i-P zS1}^Ec+5?mDXRhSqICo4?&a;((&Ed#jWBPf?JzNAqsH_JJFkoTZTtctI_#o6Pfz?P z4C3sZp-EH%_yH(qoC$1?er8#XtHz?wHzo9Fb`)aI{?1)=1qXff?f54N)t@-@}#4AI| zg!0*g0nN=&f_u@Uw`bw;#BBKzn&y-Kfe09$fL=Oht(~l~%$Ry-5q=C)ZC(*@g8G+v zJ*zs)G6rwCOXpdgK*7B8(nvIRxwKa>yJU{aKIa=|) ze!9_(Dju@{Fm&KS5`CpxE}wWjM>2;dSC%Kt^Jtuaaa#z)BK5L1(7gZMMl+mzID}kv z4`~^Qxa_BRoVeFS>X0O*rLB)nw_S~yTKIWu@5#&EtNjbQ3G>>~6QnxT>P$Zol~)sY z>1H5&tw+mwKRlS~-93D`deBX}Bi43L^rv^_cBQ97#n-3zHD*3|(4`;h)MxhfDf07? zr5hKgh=~gURWD^|Z%CzMjhRiIRcQr=9CWGZ%baSAz8af2I@qfzFqTxR6GBvtEiDac zKRp~+UT*GcY)NW3&#vCfbn{Ez9BpuO&zk^ z zvA6&7*FbkDc;JFav@H{(a%16jsZ_{y5s0NYUZTtiQ}W0X?@wcfv1o+~exg5}I~S@Q zFIInxMuW7D)87JU@!9JwD7O)uAe5B0r&jev%MCeU{KfDqX6A=NIR0z#=o1QuY0 zIupviF%wQO6P(>GB8&B4%JS>^rva`bAI%fExN z3xU2{c|}0&=uDjrIG;r_=&BHUAarxk8|hGp2Lo#X%3*(HF~YLFNxITkxO-y$^K8%nYHe+$6ZZEJ+T05F8M zF0|p-0pK&$U-8EPIPBv9Op9+20Dt{q07p1tpcxx9UNAvpbAD`r^QaMPiIFs0Blo!*{EzgfEi)X%S2?^Lay|Q z05BtZ7Qn0qOr#fr%-;Hnb!f&t)}<%EkZMxMs~uUgf?(K7Rb&cajBF-lG!XcUC}~oi z`RP+wse77%X&q{6=<4f7tyU6#JV%OGg7JWE4;uL9f#ev|GY0^ZUPbd86ISaI0*X-# zx~5}qZ}Hv6fpuW*?b60Ra*k0DYozY^-rm+bBo@J*ZJE`fF~3De_>1z;XvsT406a1| ziAd^a&(O8^=Xa#m1{y9rT?Do_P^1#A{)-@w@^B?qgm1msU#hhXk;t*6wA9|w_3XCT z{y9*&yLUQpY61Ff#}jm4s4*|}_utE#>8(h-7I&$usc1PbtFNmSRkt3_Eg>3w)>6Kl z*Z)J73GIN9j)kYK2UDaY@?m{0v|s$TaVizO!q-9y5JzwmeFsnqN}=gYOo}ubqGD6C zrlzuBVXo?&ft$1-rx@*VGn24!s(;}P%m!IquvIrVXZ58IzI|ENsWM1Wd_x%)6=e)> ztj4pLsxd~B7~K&2b%B+7}##|5y^v zH!6)n{-4Ii#-gJmRncwosIR_CxZ~?D0%~CF1%YLi#`fva#s<_A36>-z$ERs#I@gm! zasXi5_tYVonnYA%naZlaH#2cC*=?RljDbJy*iBrSBaw#fyj)pMjg*L$*|0;Dbt+N| zRYHy}%E_k$HIz|4%7roqFX1ZKA5MF{Ledkl+?Y03a_$+zEM@o_s{B8$q|0Cu;H`*Z*wld}Qr zJdy=4mOd505N7=o0Svp(rvlhsOcEfp;S?XIjzO9N*om9}%>V{aKM}yh2khqz zVDfpw0)1Nh1%N@|-v{t<9hezwcMIDAY%hLgw><~i#HIjK6EsCHE8s6N6%zm_gRj7Y@-!(aknJ^e$0%x2^^vG|2_BA%E4xM^a3@!$UK-vGW5gecdV0pQWmX5ba+ zyQJwKvVKrrk<{8STg^+gBjDry0Rp4}*Et}H7i;BQK z02r45nogoNhZTNd5~cmLZts_8i$Cw9ZQzSVVEySl+Bj^Pdl4+%Oe#yRtreLNdxbI^ zD4x-=_9&~fv#Beos&{mEXS%6bH@{@!#l@QLiK#48*&vMDLmEXve@{_f z*4?{PrqL?RL)}~CLgB&XR<0)hzVf>nXE5s_(knm%iIu6%!p7o89(x z82a_z93Q_KW;Ci&^)pE-DJ-!uNm;84kDFTImY?aG(np4jheS4H^_Z;(6BGMC*KX(@ zbZOu&$VzWaA6#25FY8hnP&YX^zCB;ng7Q(!K zF(@b^50QjN&vd3n8bYqB#qMOp&Gntw#s;Gh(Y?1TGvcrFB?J^q+@^j(^!=Jy1ejJdwf*DSH<2u7q`z# z;2On{Vr^7=_Ih7qgF=z4lm|ver~mrvui1*0jO06DxHcvWaRTX?nVQztA65^{J*|oI za2io0%(H8mtiY*b|Z^h1{>>D9W14?a|nptj|LVjHWrvLeRiZ9QVL#k@rX7~hSG*Wi`D=U4+#}iT#!Y?O$NBy%T7K&+O zh$O`HN4o6W-f%UnM65z{?9z4xf`|sQnQ$MhkY(`MF--e_ss1vk-u_ zn8rf;z&ng6EuJSamM0`gDSByP$rJ4o9Q@;`$9KH_eZ8oW7PO~>TphJ3Fc{}J0bu9a zmH67gq`mMnKAB7Ofj3+B9RU1MH8PF?*fs~vjdHY>IBWbdzB@SWdJ4ewSN<@kIiCvP zvxVnGU>@(o0Oo%pfT=l|Er=>@3#CGN*17I6RooNaA7yvti_M-p{`4|8@ z3jpkQ0>C*o05kZ#cm{wye%AyYb}ALg<_|vR0JassIs?EFb^!0#_zN2}DOv?{aiRu- zuvm2Zn~tRbb{vi+C;kRH0hsx;$3ruPIMC9!vq_J%T}0hd1=>O2TX6NFRYM#BFy;e+ zsZdKaIzvQ6V1p($HI)K*niU4f6u^Kkt;|6xIzj+Ytmu1m9nXG2OMBRZmpYz2+Z=$} zx;xYiO|~A8fg<|oQISq(-B?1e0z_wltyUac%Bm|uMi3x~ zpexjnG|$d1KPuCi2PQ$*_wQl6o}ZsbhA}WaJAi^8@7~Qn-N3Td479_oeDv%+G+Qtc zNXBNQEkQ5FoU=vd8pLibnK7mVgnnH|S|0)Aux_F?AiCqCx5Lj9y|7j<5C?TxS$*zQ zR~NqCPd%0+OH(GIy%Dh7)cgp+V_;m<6c}2e>prThd-rtX0NGYO&G&RrbZ7I>*mt6P zt$Ze{D-nH;G);%U!p>YBn^v8#n#x;Qo9W6-PtVkku9$TTNOzv8M->)RR##VgQq}r& zTtOrhvp9M14T)cHVBlTkyhtTRL&Fc~7<{j{qO-oWFFjEem#VM7SKF~SG6JLgyQc>W zO})FLO}TvyN>y6o!@1cWQ+-l&qynY7rWHsC5J+2QUasvb&Up&BBrpg`ttb^OLU3^i z0;-K37X;#hq@?JvbKwS_Pz;OYxyZzsnf?cT2E-0Y!{Q6C^HC7vdUVoQIN`PcTbZC? zXs(fwsfxyoQgu*}Z2ZR`Q;cFH=Lq?T9FEWMLkSTc{EG;PwR*=`_p~Y`#)i=>?vk(E~iN zxKO6_B@=Gt>h6XwIzFC!j`JD50R}Kkr3y5JoQ(EZBynRL?@(9o%58sK52{+SUR;)^ zj7AGRUVu+0VFI6B7yxsL>dkd%#q1O!3_z$Iq7=cd~f)1r)@nP3wPk{5k1;CL141gU3Cj50E(}N=TEcrMe@aceP z$2OdjX+~sgzHl7C5SGADc%k;%>tMApy?CeBcacq-8XFg_NQKiig4m#ADR)`&p3;9= z1Uo{awKzHOO9Z_LQKkyeT(8){{LX1e(2pa~#g=NoMC%2633MUs3SNmMsh0{hK378l zrUGqO50f(GFUnBvqPGwMFv6+^HUUQ@;ykrZ48S70qJ!Oex49P@Fs?2@Mcgs^?US4#%knG`t+OCLYjd*JT;2_U=2^{X>kGXW z9T=cvPu7&9Y_esAD8R3wa>EE)gKAf1l<9Z^KlBrl4up~#-3ZGf8t^Q-I1IqUjI5=) z0bN=52=aAt*v7uKmKL7I2~f@IXmbhA0XmX-WQJ}|OvSkxJ%Y!U*OuWLHZ>PDH%;{n zmQPG{TgvJYOQr8Es;PUnRrh-1;0=`anR>KZ=$>1B+`n*d^6gQ1S@X~+Las8aMt3Ww zQ|a%U-{1UlFzdmTzI94(TFzTQ;ubV!l+#8#;H)W4;&gSRO3{@TbM59OHDa*T!3|Lb z2@;94AiAr*zCS4~Uy+#!gLOeeUzRBkzvR#JBXzJPn9Vr86QSu5bDUE(` z=8mP`L!Q*VR)tY=(Re*Fa*PLcMsi)17JZ#s>7+Mp;lHEIIC2s_qlQ<4J%W781(?N^D2 za8=}=lCNgBCncdy27;NOP`Z6C0=Y;B0}gDopd&9jwR3c*9k;vq_SD3*MwO9|+xq#0 zjAUOv2q@m*d~ZPBk>cwhBOxxKC9VYSZJS5f9?4t+0+(!m zTXKqL>>Q^c=e*#YO2lq-Jrlt8u&y%!46y?k27&(?0NWQ&F!@U=|7|{C3CrAL252b} z2Y^4E5X@A?V##@?e2fYDe*(Y|X8^O&S7!^|eI|gZ*jF9MjE@tI zkdU5>7o?g37z!}){zl}7gs4!_k+cy+p6<1i^7UzP)_`w;$ArOO-}*W*wz>*R?Q|6d zurq-HV5<5;pxH9+UXYimhDDX(X*>!z01TmaXqd*=q3go6imc2awiXcrHL%&S zhnTMNS^yaQ-P~NOLGBL$u%&#qNLP+!7QkhL)~D~b5PdcO=FJ3D?2!QruulNIHoFQ> z^FI3f*G`~YU{=#$6Rh~nmbJCn9w?xB%a*);T-W}7x2~BK;B0Cx@7VhVy@p{-&l?=9 zPwcACv*19YhaVkTiVjgv5s}lx*?^x`ld4Iq$TAJKc0Dk`j9))vF->I>mAb5~x0Q4S zCascVP_AMs3E}YaQqsj;a=rODpJuNs<8mLYrNan7pcm`^&nOZg*;I`Y-wQN z;e)$PLx&aF_s2sF4O1v7GL(qGs|HmfEUmkbel6>>S@-Ikryp4`$9oh^@2BgLq%6-qwJaHkuhlCL9NDI5SsuI}~v)EHEn7Ka;| z+m|>Y1x{D@xKi%tFC>|_C8VB(D{w937Z=N*5Obgf^Z5Mm z0)#xHJkO7>9;K!xR?O_CrYVpijnw7#w(Qi_nR|nWnb9Fqzv9wlbWFS-%IASwZU|Je z0ob=#n}LX`tL?EdG4VMP*|v-y5Pm*m{6~3oF8Vz{?E_XA0DI9GVxY`ZdN~#Pa(25^ zELMieqoc;6m13e^`m43FFNuYj!(}_#1HiJ-6kjPcc#i)S4%o(F$>ifo)LcqY+N{Wt zI*cxczA`Mpbo-5$CvKV0mWUagcTOvVEgIS?$-fP<2ut|i=kKQj z7(#M@|LXvJhUb?huwy*a5edrdiDT>l_Wl0?;2TZ=W(?40%g3c5K~C>u8!)i^WdM9k z`(>ByR%oIDlZHss_^>%(lVTJY^|f4e4Js;g#E1C{rT3H}+E#cAtCzkW4SLP0JAQ+2a7$OP)HSwpW~ghzuosBzUiTT@eu zPWl_jSSq)anM?%0%jID0tj;x(aX%PTr9jS zx8%{Lg-N-&Q^=!+H5+BM@IL_JnxO$FrCm$DNy<5Uco;)&!d>eb72l2^>2Qgk1bM)@ zxe--})9&hnq~{`YX>$PGg&#B>zD@f&BTOkByPK4xP#IH_uaAv2q_@Jb`wN`VgQMBW zIjH9IL-NJ~XJ zt4M?l9&cZn*LT`tZ@#B1PZ|Kzb7bu9dOTlP`QwjmEvodgN576%wZ|7CowyzShEj)q zUHkP>WK@_W?H5*iyK>4f?hwEnX=J!cF(Qt81hoT!?WXI)H?aD*z6OpT>P# z=p9;kJwPh;#x0ttogAksk8I&W!UW_mv5KC+KOsY_<12e-g6b5l~J$L=Q4_wkr8)N_C;!tO-@ch-^coCmC zdNpPghx&U7$k7<+utC$=u3W(e{5Z$bkQ`(r8?GP$$=ww{tP^5=hywiC=UholQ)8_ZQCRqklL6zg5s2uDbvA}Wv(6_j z=N;gdG&h>AfS;JqcKy{WO5kd2setB`N>;EP`$#z~f?(1ksh1SufRNBCz*L7+-ObG> z&)&nTJ5pYTk^1H`OWqs;iJQv~VWWorJ2#;tgwk2zYF$7?GyqIgW1acwJlv=I8`e1# zYMyCsF4N@^7x1hZ(aMTdvwOE3Nv0AA{zJbLy7`NUSl zbfJpn+ZyZaJZb3v;@LA)hDI1xc~3u{G5W2wBa7Jzd&=gRj)w)un$~ zw^g^lQH#e40636%)KOk@=H9*LHwWD&eJ)xHpl~+nca)^b>Y1H1zrpX5-qgJIvIrds zt79@@NytopfNEkPad6AuBBHv5KEv{`96yLef*!zEKw?7Y|X!~=k2xqz~Pw+%^ zE>u}#L(-HcDN4c(PL5LrOMuP%q`Ss&>8K>+=%|w?SX`&$*Q{7k&T= zKLHh9-k2-psyu#Lk*;|(RLBpRI}4hhRfizGy5bG@&lSZ_wL zH=sg7l3f{e5;z;VAn0PN*|{X8!` zp%{gl-EM!u1TaIPC+MQQWmAY4WV(_MUTCqFgC(vA2|;dT7kTz5E{@9Z=Kz6Z3$Bx@ zxS!!oMDu_#6<}^p(4`SjBx{QIRlL85#5oIKZ}v{ms=b}5zCAKTN{9@dSQZQtea=95j zdC`gpMr$+FSrUr1ylk-`&1eHU>e2wQkd|Wz>4o&<$^6D_cg<$)035}LWnM&9(=3LP z?hZvbrYtWH1U}GN>)@_kT3K1EgP#})O_RvqJ?cOV7d*iT$J(4XuXP|JX$y^%_I0|o zwOY7>(NplJiKUTEG+)v!bsQaa)J!a)Gs7yr%TH7F0Pxn&8}qZexw7Vd{O5?#;K`yM z2KF}x<^>H&CF>m>OiWDdn#x+pD_^rd#_!WrUxrH4D9)LN-UCCXOe70uP2IY7Ekvb= z&5wyw5h)=52j?h_#)A0v>}yfbC@#&d$WNSXE9=@wQkRkZGFLp~2ErdP75Gpj=G~5>o&}_pXXpbHn6vgAw^i z(&)^-sO!ckdAqOwc`>RhSEMx*M9QNK$jc29a+IYRm9h(dIgvjkr7HO@LP;2sj>z4d zRFM>U6@QAfUk4pLaceC%%0Loe_6; z89F!;=Cy-1Bn|!yFzT z03KHdagwt~U+n~o1*9-zkZc>51P*%gLo*WipL2YmJTg9290jPLp<=eeaPG1^!JBhi zB+E#+elCR`1^$qRTQzGW!m<)1i%!VHpV+l#pD~|FKuw>)JYi2 zuH@&Ubab;f;~2^td>gpcw_2zJKLVnk5pd0f*bb z`FkkF0K87~_Y8)UX-~9!_+Tayvv4+mPs_;`gh3ZBT%aG2ASb<;8R0NSw0g9Sz|4nT8^!{8!#g83{+>=qx=9BU0F&@)VuOxl zPfw*9H9ztRmvL4sPlK3Ez3}D|2HT>Ysano--p~38?#+s6v~0@lZ-STxix3h8^1eYX zFOqm(16O;KPoI*)6t&ho%kF4z6~eejNq}^-4!vW_^Lmho#AFts1AY-{$kzh`FX*}_ z(d1xaZWX&Rn8ZWt07_zQ2IycwURpw`Fx36SR z&%b-VxQGC({nsNS&whE2EnCliscCN7)xjNXUMp(udf0ERJKCH?bN;RF&9{>yudP{{ z>8Adl9=}<7_x%0O2XMlgmy7!I^ELf>H82O`XWHMl>aPXgjHoDrJ`a2GLY8UhaI`{G zG}DUO92K!~s84n`t4Fu`_@{>tr_wWHQ#B0_`Yki9>8eO|=?!U%Dm6bo%4qljhov>P zG^i9YDs;~eGmaS=9xNP8n0opjH01aNdH5AHG~mI-RQB>wBDyyGDR1T9yBB`wO3zIF zS}Pc9%sPCz9^az!3-VK!LX{TMTv+j?_`+N9+4t{UfcC2PQ}U$+(#vUx-RALc{1`a) zr|5gH+9Y^N#lKc4mGIu?q$HzcrJ}J#DM5J+#OL6iPjEmqCxHm@PPj**Y{Wl!N|Ou6 zzk_P$>KT6StC&BXKgTWn*D z85c8#Hx{PIM6%*n_kE$cX83cF(36sQ?`>zw`SX8nyORQ&G0zp%ojuQA&Or_9SKt2= zCpz)bdb?Py4o6u>IE8)ruJC=jdS`^6cSSZ2QI`P{0GKMM(%`ESfr~IS!}lDIbKYC+ z&GS`<@=>D;Wvsltd9=L^;S^5e;==Ph4^z4Sci#>>2tv98k;Gp&7cdl5W^Bgb1DhyR zti5xN&x7@uRF@`b^eTo|T1^vua2S_-5LN>N*vH2e!#hlE2M#v6kfWUfz8(DyoB_=G zR&7c%Q=OA`__xEB>p&he3g^clx`mwut8^TE({vQrO6~0U23R9G%rKlganpy#fhPh? zr|@um#BdgX z&pU)q1>yR?!(D&o-QQ8b>U4{vv&Gp24YB19+sSELVvBnGj+{m>bC7cfe!QI&N6%rF z!FCWk_oENV25DDX#m@Oyk`K|f#1^rrmSTsOjg+sM=nwuy8!w^Sf0k6 zRDm7kGtL6=o#SdS1+Y!B*I%IwgHt(=z-x+Y5mev?hJ6{a%oP=#gS$iEubu%g6Pd*} zKI$>Ati0^4nqG(1n3kUeONl{usqPuN5bf5^o@}V8t;sVr^&&pH0{k5%OkFT7 zudG=Z07C;IAr@@8Y_QB?otP^d%qzmf z1xiYzC;#I6zfeK27z$jCKyj{nx<9h_%iaj;bXaQeg}~nzfHcC%Hqc`biBh_}!TPKR z{XHwSwcVSG$X$XT_+Y+fwyEN9dD)BzYUtkwZyuYM*DR(!MUrWGle8l)w;Upwd1yL6 zv-jn*qmiTTg`fK8(BCi-l~&Ty;t+g(s{qAH^HIVXIZs(#>9J6KW71n^W;E%F7K2(F zoD-LpeGOVHs24jOqq>`}sc+4VL41-tM4pz|30CG6J*sFA_6v#EWHz>@H{3-Pi`?`i zQxQ5!==y)S+hTwhIXtGdY-lvTz-W+Mybp6rh*5|}4F*+gT6%g?T72>)iHFd=vQ#To z;&HIOBDEnhe&_17=&G5)r~oPS+2poYfFSNk$l5{j@OT&>SVny(JcRgp*Vr`w&4p=-vSKu^hC_q_`mGLpA*siBNzH*Z6;7I(uYW$ zEkY~1kR9i}{Soag;8OlVNUI0`P$4>%(pWH*ggE0{~6?T%uJ`b#A?g4DwteKksfIa*Z(08gI; za77-WTZO}0#h#rR8=)qG@*7g8E0BBSyxoXQO89_WT{NHt?R>+Ha65s7!gj?Kv$0Js)ssjI79Spib(MxMeETT5gT z*hlUShLLr&{6_*3+W+EOHt|VoaMX4WmKCj-tvzr->(EGl0E|Y9euls3epJ`JkGhuV z7_q-!_vDww8WgB58z6E;aoK%TU+yUMHVYk zru0pZaD8}A=vX{5Pdr9ISg$@tQ!$95ly&oFWC`~SJ{oN5GA$oHTYP=gz4~~fd!TGa zla>hw|1G3|MXOMB5>?3Rk!?HGm4=M$n6#wCro?oGs>Oha`kY&ZsnL-}rP2@**RD`x zPPN`MwI(H2ts_V;ERe8nhkiM;c6l|gyKPu!4+IPCO9O>{`GA0nng6O_u7zqVhKr^XwjV%DdtQ#8yZVTV?~G@Bb)G1G z=Mw(fhWg1-p}w@KXhJASzu^d^$tmZ;m0ExPc~$#*e59eUFj*dXH??y}6QhDre5fKd z%AW&I@#R1BK-@e29N31xO6}~5I)_#C93X~a)X^g0PQ_B*m*2`HAw!RTT`!astA##a zeCDnFk!ry1-o-!ONePt_@ZAo&LNaxc=7YFtbhnn!;*2PtjGLrZ9a`***1w)S6ovGa z@xf&t56B_PD$iT19e>r9%=6(AeU%Lz=GgFt!i^#@jqubC6;gqc#|MD91i%b0F*gtC zLk`C%=CP@@$U=e%ntrR}0H(#XSPhqf9tAM94YMEg)0MRt`}hdRCk3A~f$jEMR!3&O zfg{=(Td8s0X8C3_gG;Vlfg;Sn5MRXk5rbUW74(eY(4g?M0E{1kULS^_S|`Ky6MkZ5 z{TLzHWfs7g!>%5GI)J&K0$|AR1DOBc0${1LI84^R2jCMX=zz223;;W<&CJ3l0T}Y> z0QP{K1~BA=2K>nYW)0AnoB({X|KKSAQ~CkB1i)Azc49_8m}x|ha_k7SZDtQ)HDC&0 z8i!@yjZ@>us?o!t=@^W(H`|Awmk0^JA|_`9SOK*}{e>{lC3~qL8MwEocEB=-Zi58C z^%V?&;X7s63tjYRu>*m{&|ra43UGZBq~3&e(!dw$CxitswA>s8iCBuFHLSjjy6}&BWVOh zK>qT}FSwxh&$i~5UT;`?ipnt9f*i|`jkFb@t6&^ma)I=2Cz zab0=8KDW6WjK)dc{rqn4{o=^#>KhVTHT9sYE4O~|<-gZ%pwh?dx_MOS=+^aQY4n!2 zM|vv{rt9jZe#Pwny#rUMga!_ z>XpUCq#?}<|2;GsL_)`2MFXq+R76UrDO3doITyon(CY6R0(23Cb))p_n3$xd9^Hf~ zYi4veJ22Ro6A~g-;)3~&5AOZ+!w>cKcOwgo_$QhY#t$2Rm8=X`UlbY?6>uHYr;VNG zp%0*X{nc({IF^Kn2_j{cOG;ooRtB7lPrj*^l`u{0uE=COjsP9%IkNBWkKYM6$NPH@ zk0;G|_2d2I6tv;v18T6!5^8+@W$1Wv0RKGSmG`H+npe@P=$$rscuQtq;_gs=*38Vk zM~P$bFeBjT&pa2D;~1Cmu6*HgF0JZ^F`g^$d?hh_BcldhXFeuDPed1m zcQW46Q(`W<4*VL=X+Yq=6GIpvl`KyJAY0g)R;4gl|6PY(b~g8bH(~EO0GrkKR|#mwucV;DRt2T2y}$=Rurzkp0(iX#%n37V z53fHgU&zOeyQNv!N?{d(gNqPTsc}|~=W1&(K!M4% z%k{Wa zh29HGMMXSiK4p727?a=-Eb3GKLl}{wM zwvRn{!1scl`$FUCX>%ogO^6~KKEC(FDZk7Mc`rsUeRC@CS_0Axp$AWRoys{Al3nNJ z6_nv~G|1B{JtNgKJp8!No}I4lJ^>*e-+%w``;Kdj;Na>IinLA~4ydWFtFA7&baQGl z429sO+1Q%+lGcuDhDe2`&0aZ?>U*ZFVx86F=nHh`$PRAuP&!NWavdE z;)*9cJr5jqi;I4F*466U%dT$Ms%{ofhJ{^8i?*@dndBMtkEx+$cLjy?wgf9L7dpG6 z|6kM66m2UVCgwEp8Ow(jA0CwKP@zJZwXc(}*2DX5gia1@lxaGF5WStoDf;C=ghu0V zBRZijAgvGhN4Uq8>TQDulG1%?2+#)Q#FV-?EF{@^_%h_Jf}`;qcQ9+ zb+IK|M}yD8?U6V;ZE#Y)wPs(#ySMLV!)Zen=~d&vZ;aDm#)TNotjmw{Cc1lBdSX;y zYkY&k^R7mw?-cH-ql42+L<2Rtk&&ce=`??~jl?cOhIH(pW9-OVcfi|&rg1l1wm>2Y zC`_qSLOFqIER|p?RP?+mUUpJk{-k0j`2IT5}!YCe*hGKbuI0 z+f0+QPOH)J)5!IuLO;-z`BC}6T?$ayik@PjYAAZ2Eay2}6fN^&N(kB#z?cL&8~y(L zxKh#mi(Vqj7CM?sqQA8)p;9y`q-^r0IpEbAXyWt>2u%DbfGv($KvQ-mtLC^7sGApF zeTp!{`>LZg7G|RFrvezW05BwdKY%T-2f=?1U`zXC0Aue3F!o*m^I(Z#Ve6`(EldS4 zX35Iks;vjGDfrCprXKJ{{(cz1@b^yu%s$7>2xg;PWC`FC3Qyk)U{1?3tYtP6mreZT zh@$jMv6Tofukx1`%h}~wpi9Z~tU6``g<2YcOE60Svnhk9wM#{LxwS%aUuYu;^`l;V zSt7a&T4p%&qoFAz^o8(Xd+h}Ze1W|H>IJ56)Ze_B2wf$CxoZhYK*`@kYMY<^dVd^Q zqq+X9NiGqsO7(42T#Zi&0*m#CD;Kws-z_J}if$6~BH8H?e=BZb73EXl`l(RdzcoFL zAKdfw>CfO90HdowMfL!bKy1JG902B?icuu~r$k`d0>Hn(-=1f5@0KIrdwkp0uWnJ$wB#aq)t&#{hU}>i&}_6Wt}}zxK)wz@Zfa{p|<+ z{K6V)Q-?XfJ=Hczpsw;}bg2E$m1bPH9L<8D^V% zWq{f%^b5--^9m*#!os2!zwxUJITMtcfyiyh$tyyA;hU0%+}vw@u3voNVjF&C)-Sc% zk1%&+B>x`b15)E-<7318g3^NyMte8~#|4)jIk)gdU-IP5(Od!_ivxxu3nM{w|5y_> zyBOZ5agT66;%GD)4X*C=InBm~>lFfT+s^D_Jsq_=JYrD5j6SDBPVR(Z;~b)dOO=5IdXa1Wn-zkYf^N0TzKpND#Ev49{SQ( z0hcBs{8gi;9dg156N#48?EuVyAy|AuML22pB`?2ww^DY1cfSpD$bY#*jCWiRbaTm% z3)V}jDat_B#|}leH$>5N#S~2&7w3UQ?pJ3AVOs3OAa1 zGMz>Mn7esV28zKk{)ovPE)u|O6h`9V%VCnx#iCkFP)j~D1DL14+jNC$;tLAxSH`&8 z3;b9B7}^19j;i#Qpf&SXs6om%yLD3l%eN+q!C7vT5VWOj1h5PlOaMN0;uNNgleQe^VXlH!j#?T7UTYjX^|jR3k3G-O+tr*e zw0+fk1*!enrKN7c+Om>ax{m;`>_jS&0LB0?{9U>LQZHo@V6BphMgX{kC^Ci0ZR2PG zzUiN8CQMsUPWKP}MMC)K(sFlEo)jLS7>N4eivYO$!o`-0y~|8C#4~QsDriI0_dWoA z{p)?2gNZ#~;xC2H&z?P_IMrmJXXI$p^lCPw z&o3-8vZeRZAAc;KO4np$2b>H`cJoM$_SBN_r4;M#Z9`vZUU6b4E#R|F?hA1PseS+0 z5jp#+Db+XTa7@IWr2Jr}VFiVR_NIj!432yN6H_$;VDy3=q^m=gHzLM!pOdU6wvv%l z2db4wlp6En4(+n@4tCbqIOPBK$4V3RT}}p97O^eFzoduAP#Sml<>JfRj)iys2tVY@ zWG6DJn(*0oi!py|qsPD8FEx}TRTv!^^CcrPIy!NHd&?RJ@ZN-@>m0Y`b9!}e><6BX z5lQ(D&;{yYOk}j%7lLM#r@w)DmfILKx#MsC1}}S;hFCUEsm*ui*or?eSW?H4eLjP| zOZBUewKA0sDH6Kut5sEO`HtaCYB~l0Q>UgxZdGza##O}wZd3RRMYl4}(o&}vGXXeh zWJIU22f#|anNTk5q+N*Q^LNlul9W?&-iK(O(pz&(EN+SkA*=oEFz+8q=-a{-|O#n*|_JmOK zS>2Xd0p1cO^744zWMu@Lt4Qc}lF;Rkn0wWZYgq`5>;5mR4HAj-RBO1fyf9Hi)-6~9Ye23zXD)(hRVAT zL4v`gg!{`y%`?NCi@T4qR`Wd(T%Q}KKpKUJ znf|V)LqcZo($FJ@NsT=o9?qS7gA(D~uRs6$zj9mi*jNR_b9J>XT=?zPD=&Y4#DJ?il9N+CY^0n%^$jGqR5D$uRJTj^SY63%oQt21U36J*o(4gDv zmEPxhh*6XRBO(YYdr}Q-rKS&kJl_SQthLde zss7=w27)V!48X|wZRGY1q;BmR|M<^EZ>=+HYV_8u z$XrG8wSV8ZvXXYlEvBVtr6e|-2{L!%$lN+oy!^SfUTI*}>mo+t7L*1dn4_`t^~_1@ z>q|Wl9yc;FVnf-lMwjob`P^EQuVcK{<%N;E6l*azQ)4i|G(`4MNf4COYOSrzg~gBz z(iKvHrEo;H^{CUajJNNO#5uV!Y(WRO%%Y`^~ zoGeskU<(yK#wN#F({+k^?-BTL9QX_m>kqlSfoj6?=s@uSax%0&t9H zg5wV8D67}5FH{E3d^I6eZfRTA16TpCxh0C7O#r+BpsRzlHZ#4N2L5CKZ_Z%T(i;J6 zLht`NfU%DOuslI^qj~{nKN7&0vbzSr{ya!q4`4RyT;TP#&(h>Ga|oKp^$Nh26;~gV z1O70BWpC1&Hl+0>$ZMTjm6DdnC3}TgT&A=l34_1l#F;a)bor!0a<*oWo7Y;!FgII% z0bnDpSM`pR85^QW7ye2`{a&Q?YfBWHg})_N%m5A(c&-%{Rm{Aik0_6vZkABUMe#4O zpMg}P^KTKse?a5U&*S}w7_ipq)193Vm^`tZwoxnRKo^PNvj|4F3woEs%AV`gME!t@ z!Z@Rv=|@5-w{5DTnK{iv6;tH|j)5F?9XW)1iu?9wF^3Dx?uh$Qry)4ETq8KML}KSlrw@KmXh_S3n2UTn|NL zug7UAt|WE*{71^NL|;{N#aum2!Ik68wtCd_?7>|59H<^=jMPm1d~Cyq_D_0KRu1V5ja-}by)_kO$wehZ4a&z$l?PMBh}rIM)Rgx1cg z+~JhdbPNU5)Oh)Yrtp=eAu|3%Kyu6SY`9PGS6}(32X)j0cpmi$-m}NUKh-U}rXwsf z695~H{^@}olZkEpV~?Mt90*D1oV*$tm`(dmKpEZ#Au~SURP=Fo_qelr^vrcm8VHB1>0Z&EIg77mPu5lY zm1K7GUhx#OCSCgi>r#D=Ch<`;Fc9vm)!4fFpY`{k8yI3jTs~PvJX9l<`L>{PTWBP6 zi6hKhCNcbxhFqgi+S%b8-82xPWfHYAHmr34& zisx=@2k)X-+DWSJmjYk`8D~+ZOiEXwiY>?!k!0y6a>PUwG0igWZc>EXK5%G6jmbpS z?aBoz40&={#FN>TGW#moRh+5#kV#*>at9YlZuwLVMiXt8@E7crlyWdG;4bGYf<~$U zpj@3~v3yN-I3fzRR5y4{tCBTqxZpt(?$^s3xsWecH}1xjx|l-QW^8hSnm2~Pn*dn( zF&yPaaeqGmU=FPfKC1xc-c8z&EC9@{pJv>Py-&+wGXR@B-~SPSBmNY?*hc{v?rsF| zX3%{vfUz|I_TPYDvCqK|19;zh+XTSo=~tTrcykZv0e^=1ddFgoSVCkMBvZk1ppYPpN7ByyNbaV*hLY? zO(Yr1oCpR+6KN*Z+ckxN;Prb7fM0_{vc6sA_`Bl_l*9!cm+C}-byO;KbNyd1c#R*8SIa1c0X=Rm?q@s>JS$|B6;(@la1u>-P`a zCtDhF+lW`=ZnN5htg4HbR`M=%woh~>j&}+FphF5HFLr3>)_z@Up$T;Nh>wb2`ptl)`767)v1$H-hxPo~JU>ipXU=5G9TR+=c z_}zj*s^083>P4z_iW1@LYTlb>?_;7Tb9)M|_l8iQ=JIDPtkS}7c zg{UM7rh4b+YlIKacx6YhE9406Z3NQIFcJV357zk67A(^Tk0eF-9*T&GGvcGF7=f+w zQ36;>1gg^aZ1KG0MVBwji!881h*wA{?q3D4c~lmN6}ytZ65_^%8%YBLw-@&7WP}=z z)X2uuMm^Eec5buEDzB8gN3a5e#$OO(~t0=UtVzzTl{4j*Q7 zw~+_VGxB3mHTYZB(sHpI+P3iLB8AHMtF^T)z1_X=*92fLgQl{b7umr}jM1nEqX2kt z5Mf?0Bic=GO_!56{pFWmejT6ByVN4q2IbPId1lKbEP*5ulPxL+P4%cWviLy0G!gqN3B*ll#}=3DrH9SJ@jY_QiGoDB@1L}W*#QeF0cx8R`RL!3mf_(Wzb zr3Q!UG9|^7P+9YFl{Av?;;3f=wVfT9rmon%;Hs{&AbZBbaI} zsDLneU>qMu3Wb^ zWX)34ifMJmxCJACv80QjzVg~|`a7d|Jq{^AHF>v+^KNhb`4(k*rTk4g+_)R;V7*lh zb*~4oE%qk>R^!iBmRbp$19@fC2H?&4Ysvw?w*g5EzB(e1%gzThflVC#@C;~k4tUKh4wb-b!^@^T z?K;QR(ih&~1#=j-Dt6LxB{s?x>lRuiFn{HCbrL2nHvK`pqR^@Y=u&lcQT(}x--}=% zzHgP(_U%OhDKZj_iYjQq->OUXC?d%C@OTBjsTiq9`R`msGoI($w~vO(=jM8@|9BVBO#Q;gbJ{PxIV}f%DnY}_UE4q`X3O&{Sh~`xqOt4-{~&m z!fjoYH&5Z|QrQJoNj1Y?nu8yqO(cWQ&1^+d7olGPV3ZarE6TYhv7j9NLAsQl-Xq}r z`*Y@NRM0T=42>j;s|Y*4u59KIxOKdcp{uKXPzXcJQ&TngBsaIABeM!uzP5F^Xs|s+{%Y<|be=x&^$9=Hx96{1${On$ zdeq$38FhYkss0wFSY21+7Z=m2vije?xSAXgcq;sG_z6!xI&r*4#@)C1HMO1D)_9Al=$I@n&xH zQfEqSa!sljQ5myf3{GOAh3<$;p?j*IS9S(MdwwA`HI!SQ49NC3Xk85+eIWhv7lnEs zzsRh~;lT8yod$!;=h|N6(giH& zp7r+Dt#T@$a9`yBtoBQJ6k4_8K@*Gymi>tjfL>ePVB0wUD&@;liHI!V9p{lhy; zFmzo3@Cr`0xL!bQ2mtpW#6L8To^Vg|^&uIdZX@$sSs_%B+A74TET(qQgoMva7MOSY z?Ddb&?^TYEzkW71M_9XH3IN}E_N=^E^z3Gp_xuccD|)!Ft-bbqRo3W~(DY5blvprN zGI|`z-!8J#xw(_{{m#uiPKk`|XqYU@nnXf>DKRUBkUX=z#wH>Uf9)4_`l6V^F*sP> z{QP=bXJiY#)8*ymLq(CN2tF{-^6gSsb#?WboC8PC`h^; z_&1b#t+l=N)Lx%#w0;vhYElnHxCaLZ_hmg3GaiJ8H< zewuYNuT`hk_(g?9FQ6M7bM&n95kp}{b!b3(#?k2Lm_uKtqHKt+u$R`uRqs}lb~p}K z)^PMxd_zirn|nS(CBJat2$;BhC}gq=_yvXuGxa-TPxrfmgi(g6%Z2s#T`u_U!jTHhFFx9aemMkkF106RJ1 zF$-ThKRnGZs^#4uP1eMVU91sx&^x*ye78{O__<)yWy*mLH7*4?xoj)F{W8v($r=%d zV%&5F>*zEAV7H)CuU;KkTx@!^yj&Jvz0XaTzu;oCBLeY5=wOP}@@K!XRKIXHf46Jk zwd8jz-GTdj|8d_T4He3g6$}V*iik_f7lCi?gF=F;1eaxgRxcq%R-4!^dJY0n4vq?d zT~+}Mg6NE*DA@#Ho8VHTgCl1prW62g5zcmL(g+{&{A3^xTyg;}@G5|D%(M=m(003( z1h9s6p~0b;BpRduFu!Xx=?Wq(>$$+K1Su!n`25pan*ogDOW~GesDz~&1y)Sibo1I-wS(v2;u(fLV)7w4#vihkk?#5)hMIMn*&&ytdUlybBMDlfB`P!oG&h|yjWfm z0EWHG%S_eaFpjWd>MSfw=6?ZjRvrw(>BR%ar<`g7#n5SdoQUiw)y$|FP|HLyaU06* z!lN$3lbn9Ugy^@hlM$5UI{`2bFgq8r2Jvx=`}^-d{r&gpJY@LAEXeDXb0Vn>MbXU9 zLvRo^BY+EF;V;Jv#4L_VG589r0Kh{qvl+VGy4i)iKLBP3NO4z1^UpsE0RQj<(=iz5 zOlFrqcR2X$8SO@*WP9d85B%+^d_*<#`l*ZMKU-m1t&H0 z%HrO*xFElTpAwRp4}JdPh3?GI?4v&J?iuNUA++p@bN~`bxW*?Brssrq)W3a720W`F zgd-vWjGq4CID=N(*Ox(N_Hsr|K&sX)>E+94l=KiSI)325fIBCy4PT9oCaURvGBT{A z#^3M-5)3}UrC;FYpnDfEEYuB?Lu1o~%|-?MqZR;*If5d26fXbO6}$VOudtXKoy%PChh0gWsaDk6bmEU`>yZ*?%9 zV`TwgYdx#LTRDY8jYSi?z!cfxLR(v>LxGj5lx%>Y({+v@z5R`^x}W+PeB@GkU@B22;t) zgDDOCVE|($0-F#_l1~B{1eyViowSTCTLSnSnE*E1dYGcxYiV*tj>??!CJ0u#k5n@k zT9?673<57Nl|Ws5-{s{c5r7s(!4v}dEtnKUx}s!rOGN9C7!@h>eCXUQXuCzSmKx@Y zin)URo5C$7^?H5o!PqFXDp<0l7V-UC&A70)Mo07N(cMKi30Yt{4C~U^pcvV4zkhDN zd8p_@A~Fo*b?;UFO01WnDSCgI0zEH!eT4ua^yMkVRwx29wMsPJj*ID)I;>H!IRnCeZor>?i#7ME&0|!rJ2L|{h zheltapJ+E(wXb@lCY(|VxL5EPRi?BHOG zGwP&^C99}4^dq^tHKon^#Eei*Ee1j%^WdC+_vOp*(9lEP#)bU2fSfaphmWHBpK;~Y zAAh{ciSc%(3CB73ZiKIfpN7U{pe1ss+X1NX$qN^57~Oq;J8+iq)iE(Kc))xZ!&$1E zbx79ec9FV-*G3mH&jQ>C%7~h1K+2xuIim|tb;i3=lhFYdu?bHv-uFG79_nvk|~H>un=|vF&SGk8Cz+Ju>e>=RW~3S6CRx{h;l@ zOnaC`OVY;x7!wY#G$3qY62I#KtP)!_Hw&`_@IMG5t_83-ZV6zvreL(YiMp(831G}L zbQ=6hW5>b`{vQH(w`vM~sX&q7Wh;#x*Dp+ej;xkITWA7r<^gX+@CN}bDx56nXXE4dpWV54hlZrQPH@{*fBu`3QJI~z@KOmzD=!*|_aERdKX0zA7|l%y zOX;NC_)N|jW?Oup+s=rN7Zq)fThI4ixC73rh$Ngq=;RbT~6M?-cG*%m>;3H*8D@zKAZjC0bknL>l~mIcLA$LmQH2@wNITYfzPwTia zu-F|NeK3apDOdl-*;jwO3isA&lWs5QbontsZf+hLo$;LGw}`)f#_x1 z?I2c=7`n+yEeCpnoSgN1i@@mZmDC~^PmWy?Kv3_8znFC10dRhFcuv|toZc+1YliK5 zTYJP-rfhM;Evl9zQ?l%K?ErB<-A$7|P3k)2WO3pE*@%r#M2&OLWBYCqI&@UpEGG$ z)MwF%+y;QBy1FW+=2-ei0Q?_J9f80wM~q z?>ztE*;r>vSVwD0(S?$)51a?UV}t$3AEI;Ig}=|B5W?BdpTDiY7}-#Z_}__;a9rTl ztL;BcWOenw`KcrM%IV05urjfrf9CN|KRxc87%Z5-c>&==-fLEE0$+N(va?V4MO~Vl z38?D}z49tDl#bq(Cl9a1mi1nmyxJOh`kRnySW30?(X^%c#7-t^6s0`8mK?v>bTTY= za&kDiraF~>hNrHSTufKI*=0D<_T4h~z?8tsa+-rM?j20>F2p z%BOoYU{gWler zVI7Wwb^83Ik))&;{@MHbg#Xr@M*zT94n`m&{YzOoEay@R3MpjNOWzX~$kT;4ZrtD~!D{^1(*62vQqe#U zK(~Fyan{wv4MZmeX*8lMN`REIw1^mAy^U-zTR8ypGggN3`}Z3W>CcIF z(iIj8{)%)vCSHO)#cMWst8Ce&{%yobyYEn7(?F6|&+%0No7lSnz-CHfvW}ZUoaD0C z_{Wy}IOf7O1MvDM8v)D`p90|R(%wIOW841+fE_5s+NjDP`TGF?JFB#PznO^m2>^D3 zhaU%Ex$k6>`rib=*m?kC|3d)pwy>S1$g?GY;jx7WY*~Y43E(xX-Sd81;{$I1aHH7+ zHcJOuj>+P*$yb&LwuG>Gd`2VxDI`CMzQRE|>kWik;=Ni))ec@#4zUSbHiY@c1*laisR? z_!R&aC0mt@yutb+Pt*SZi(3G&S7- zc&7d0>Gn}x8A>xAYqTNZOhR&vU+4kPI=9&FcW+-j?k|5-Ue7P9yDF^uTKsJ1MB-#s z>u~4QyyEG}_OYpoisJeu25i4r>5d9JeKl)zx_<`gU-W*ft7}p^s~-Q9FuQmqEa7_= zP4e;2PEY;ntMuwj^!1s4nR}@rEFmE|uqL^45N~|=8g6b_OWtJr%$xf?461%J*4_{n zkR9k3d*urM(>Hz-pBY(|l2G$7Apws$DlBuUB{C-nX?ogp@ob1dXCyaVot*4$iHr^M zcXy!*s`XHxFCK{UbSk44THBKES-u-ZURunv5?0v+FLho|Fjd`1mQ* zZ&M0cD8EWhP97f4WbWl2gPP=1ran+>g4b+sza#E$V{%itvz>S2Vw3i}@9ca%H2Vuh zy^@1Ydno+MwVG?Qi-+B#|9JH>AF9BV(%@i*Ua^OI!rd4*1pmc*3y3UgX*}l3rxfo% zo8+vgqR8r4;Jg3)&v$7NuJk=Q=f4d1%ub54v$y&iG*40Yp-vC`UDdF)ixbpYOImhDFH_fG+A zsbcirXY zZ`G9jljbb&L9;0rtN(Gz1Ym4+A?mN*O;3xFkTT^fz27_-Dg0hV41Z;%n=-0ez)L$Y zTj>DP#amC26Zo2MMtGOLUnWM*S5TA1FsmP!^hiqh=8Ki3B>`XxsVHJLtm%8xaS$4dq89^c* z?m%i_KGZ*Ru_27&XL^q=RHbBfy=Cym_&75)bE_^SPR~~gPTv{tOb9s;>Q~(niZ~}7wiGxqVAHY+N*ghc}4Amb3Hv%MZINdWwS4qdn2nZ@IwON zqYyYGpr+&d&dv#Pv1tbm23)&V6B2$qcy~~G`X2xEj+BY2&d!}1v!wHh) zgYB8uYC4$SIr=~h_4@U}o0%t>p(lL2!Xq0Z5A59=efVHVe3+O++0YOfdAbZ~Lj-kC zo=T_aN|fsq79O#4OQ@P;R&-0wQObzP)jIAs8UjO(AJGFKLR1Eq{Yjny)zzu49zKV8 z{g&8tgPdo%ODpO(DJgQ+YH+>yJmbTz)M%__{B&mPwL0HmS9P$0Qt*Rlfwz;+nlj*# zyCESlM6m~&1~iVWqZQRgT~17TtZi zuOKpdP*j;oWd@SX62P#|V2p6y#a#ec=`x1waZ9h7V*ItdG5$B;P990?^CoS$Md6!d zs#t+3p9`fPJ9b3qh*uc4nB&f7(ftnt*jhQucuWqO0c^Y>lHwLIZ^zXEA0OneJZn(} zZDk2y%QW$(0Jh!)z&8JL0Ap(aENvCBnhyb3+D2)9O#49qo6VBE|1$uq9xxkB&=*?^ zVEHJ`d6N({SC|28CM>)Dn*tbnAAm9C-1`9xeQ|doFlJeVwW$aE=>Wz|mCzEvYH5^$ zUx2wefYsEk>i@!61;pw(dRP?rrg88*X9a-M8c#Cd`Jjba7JOOsGFbrld|L0)@=D$% z{9dxY1eRBdE)~_kKs2En!~X@qFJABjA6QgkfnPjhhB{AA-=gD)VN;Nh(x@)c10>pi zsW`?xeEoVHcNDq)<)TYjS&7iF7%_O{_UA!veHQBuQh3FvWC8CAYK|*&IVbYN`X%&YWU^vR7*AsaMM@-B+`kA3b~AQInim zJl!@{d-_W4#g*Q&GpNGnwIpXvQF%Rg@yg+}vX%>1t7zlmCz#I5^-n*_Kr6J2$S@OE zKAxW8(O2E!7k;C3C-Muf8QEdAGqn@#5H}^cBQ)8sBGTe6r ze}}92Hy53@lp7Vili|>3GXne)zVDn|Szaca9~PC+5SdvPdoaSuAhMW7qjs0w!->gB z@O)?&AG)7e(Vy#Rn~|Ds024NLZW-={g$qu7**^YySD%5Iv6+VWJ`d+o7kYAzCB;N| zI3btor1@;C4IVYFDKoS9VpTPq+-IkW+hb7SD?e31FCRi%tgOk!2KL!)v(X+p+8ONx$g)+<`}x8raNg{~p)9v>YBTfDL0riQDJAI8`_ zMR=nrsMVl;L_zVPvijfOz6gTIdPjurM!bD}iTX0aNu+XJz6gB=(z=yt(HHU0~Ak0wdBvB-}qj1PZ zP(TU$x=3{h0@*eiJZdqd3mOo47W#}fTlsawIqkAL6z#!mYRCO_NkIgb-m3D8zG>QS zWgC%R7vmXWZ?%Qt8w!-byK_@K^TCi}h@fbU!w#i!19x8nUrq8zZ`%;-FpeF7DkI>7FhgP00Tre9|Ev= zP;GU2Y*PU5vo!w?02s5N?wVa}BY@3QuOx$2^r{rz!~@1Y1Yi!D*5Bv?Zve3RAM>0Q zsRWZ&l39}wQ+!{!Wn*@L8v!tXO_!jP&)B6|ChA-0^Ygg6mO^v!dTRfX>W4E>YY~4` z42tYsT45*e#oHHo^yi}UvyAJCWIq0I@e4RAtD;3Hn${#SxEZFFqkB*xdVeS%M%SJ& zE-*zOfkZ2T+UvNZ#VbqbEhHua%r07b5j{$*e|t-$UT<|3P)dcDOvf)CY{gVpg&guc zMdX^fRLBhiD3&8cEX9t>;UrV8nAZW7i9|E+8M$9>0n9xWvi_^Qyi&Ym9>$~(z9eK7 zj90#X&B!Z}{{8tiP0D!O^MhmkLzR^kZDXB}I}-~ifByCLo#*!|+6%_-Q7Qdkrt{?R zlf1l@#QU6h&6r9iXwee&2CMSKiO8_{sQBdJmX#N{#9htZXWV!1$;b#G z8BC$|o0j6WVZiTsQHK0r8CIcorp`zG68<^zuV$BhXVqxbtHcu8ReIr z?yZ%zD!zR+RadVjd}&Wl2_La!F0C}ao^GyRQ2nFv2%zieT%lh3CCNkg!&jKq5?1H2 z&DB-pJDYy{<7KqnE~g}?9oB_Mj^ITejy~#98k|9CrK{H9;k4KoZijybkV!&8hwl5TZ=$qDiCeu2Iou9#M)Q*Gs>CwwsPQX@#v>u|Z_oIJGI;b~}d z#l|-A|7mUh2n;p6{39kH{@u!QRG=FLLzE^lPuZxk{u@exH5#;YBY4k720`Kn@?00O zzZA(}oxO9?Z+B^W>hl_Sc{VO?AlSgHD@1tl>XiU4n?fNoq;%{EI!c0Jf?X=BI3)ps z$6Ja(fw)E%chM8fhbGQ1b=8P4GI)U&BrX+V^%^bm7tztt20aUj{$P7j>2gHow{kkQ z+D*%gYmVilrFnWg@H5%c5=I=rnr|c48ecojF1I*@Ex1}2%&f@)y`;A!AeTDGb|$Fq zQfk!kUdUb(Pmlr(suQb_Zlke+<#QkJVs|Ea)Mpo`I!DbHg77(>nIiY0(q%o65uvZd+=^M}IOS4)s^U{iX65QNmlo zf2OQjhzpO=xXUuH$>`qu{dz@KSA`fZIXF{$Ccc$Y@b(A461&FmpegktZ%lPGTEa*q zRFM&#nCMMAyw}UC0|1}!IqK!h}2mrqdP0lQ!#=0%BrJ-si?VFQ%gHL7#>zkV^ zCaW@QtFBfdV$r+YTRS{hJYRNj_nxnOg8ZVYa%TqLytxwo6(c57t7}e%d%1HwHDk}7 zvrX~IH4i%r`X^7HIO=sOY778Bc=M#ct+>6aJ-4d!VQWKVRC33ugI{~4W~6(aIT>Fa zc>MU$j8mbZlg0CGiOhCBBUCKW4Q_3%3iG2wNkcl;;OZ5UK=?V_$&vAffWmr*Rj|*njgqGoyG2V7|9!^?>evi0%WbA7U zk1;qLVFS4!i5Eqt=$#p?aWH0`EgFArAIwOB1>8#o5CsUjgI!*!49wa&EmpbdU5LoNHke`nrg3S(NQobhjXf#7Sjise= zMjHWOW`gK;sQ_jj!B+`j8jQUVD3|d^}hQV99xdczp9Fk#F4J^7$eBUjRH!ClX#b zUNTYW=J{I%d5NeyWVPqcUcA^|&_nncwSCgRG$2)$w~c0H4NlJw^%MUdL+P;i){uAu zM5ur0sjsL&hqyAaz2vZ8M{HS3=isjdq!k1Ug~ZBdm2@wS_dje+ICbq>d`i{w;^Ez2 zdHJ=5W%_wC%sDWj>h05ezb?JHQrkXt=Xzz^D6P(KFP;u7D0o23c&dLQEGj-Xk-;P@ zIHe~;lc~Wvc|6$1EBXM&Ksmo4$yy4fXa4P*XaF3Xia36%uX|8HV0LO;aIjZuUrku< zbXQ*QNjRD?1AxaKfB$&mLhb3Yc)yP7z=Mp*O8*LvIU^%GBr^7-pWhi$)2*4EiETp< zax-gE2`l>?JehVfv-4`CA8sZTa&r2rDYl`zrOdOG1S0^pw`L%7&f-d(n0|G{EikgS zApv6T^Gu6L&nUT+<@ME0!%m?JY(v?TXADBQz8-eFA_f+WI$!^w#&93Xmbq0K0vw&~ zYYAYs0;iWb;1F?}{9)eWTKAJQV>`tr{sXI<_hb_vy zNeenkpl^>1xVaw*Zz?03o*d+1%=c_+$~mUB|6K22rQNsm_IY#UKW??XOuSTW!qqzx zQWr`P&<~|TM}xE8#+pw;K29kg!&zl|rCzhm|M<(`BL-M!)I&o7U~gxw8MIQRm!f7% z0Iy0Ysh4n=6LbPmZ-rNnrz+~A`Gob(zg=1ytkqi^y@RzF(>Mx|8YGkXSzLG%RXV(& z@KXtP1|u#c%b|%J18^K(V897$O`u;+_}vj`BgB27yhbDH*Y`UR)z?5)4&p)cKgnlS zE(*5Ux|H5naFEGs)?n7Ol^A3VfGs+AS#IM1Y0j)iGg|-q0Wf#0t=1CzEH1ZVa<(`^ z&y^%Ft8-c$w&XfbH;mU{eW(%|Q?tZo09%^rm~z4tfrfXcIxK<7O*~)|7@?#D<$81D?$z7>fj%U&@l*k@ zifkr$SPrCQYc?I%96P2XT+I$!(^zRs0DrleS)g_;fDf6C+Z6z>Vic!$jY$;a08y&ce~+N2R9yIZoPx0SiHZL4AAk9= zvR^p$Ojm5r8tvlkKKSWR$!`HzYhEnF7IJ!5dp{yxs!B}YHTbIxg64j842OQ(@?Y~^U z%%sLb2ZMc6@4Ln0J9qonT>GhOGNsx>Z{v>aVMa(x)%V#se*~tchM%=H7yzkIiPc3! z$Ch1fijGi)0&J`(=oPtB99!vYQ5wY=_JoN@E~jk~KJeCT*@9O|D~;{tBc;JHUZ>J> zJPY?T#>z8fmq@lkaX~}w-}Ws~2S?h0rnI`c)Yz!_m8IUmR1a4V=aHC0O+mhP2EA3? z@Z10V&y^fIYdL8ej$H;z0tteQ>fC=K!g@fW5!phiq@c{J`qp7#U?d-c8AxR_cv_}< zWkIoxUi2f8F6K)4(?CV3;vfb2l~EMLgJF|GHsiTCjkSi^)HcjucJLmEt_#eW_4G!; z9@ASpcw2iMit%<3+6vpYB9O1Q-SXMDmp|LW?*utPgT2TKu&My?Ut58DjkOS{(CZn$ zrLngXZBr^Q;WJF-{ShaC7VBME!S2$L+hmq;NaZ+Z@s@9lxX^Z`{6b8jVkyDTF?NKR z0??+XY^X1nH>|0b=E)XeR#rSxsI|qK-`wZ+4mZBrzhnEB&p)@~%;#Gy%vxNGiCxR7 zSe60|mXoj?w_9`Z_U(?_x3IXx?iL_#dUUeY|JZdZrr;u{=C-KACmZ10F1G<1hCQvtp2A`*!0KJ2mTO%`TGd~ zHkUKQLlb~GZ3eJ%(W>*CCQ*zj&n1A*Ba9&I%3@iX>_QTFKB)ruIE%4WoL~&mBgtO? zEY|0CC@yZMvPu9LErzOguveVN=qge7ybOOa=>b#Jlqf`d#Ym14hDQ`6_P5Q8sgQ(~ z3FxB6AdakK*wa72~xsPcjdG8uC#)-48ae3sHI|GEWhv6ZJZM&ZNrK5^7*bKB>B z77a+h{JYTf#le0t+CNu$53d&K2nK0V8&=P^2bz?g|MJTneuB1sg3|RxxkBa%R6e** zeKG!Z&p6V=S;G&Lm&$***EM-9B-$%G=w#K^)`ZYANasbJUIzJTXKGT$@X@E2yR!=J zzex#;k3Si?T$Iu|S$_Q<+27MAzCN>bX>6vy^7-}g{=Aivh7^7>%Brd9M)j8hXBveb zwuXgv1fX&6;hWJ{<9Ft0hU@M~vG90N$?1=#v+ieB57`Gw0^sS_n0JNivPJ`s{h_f}a2#(Ito0qIJDmfyW&Bj?2n*a&rgAF3Cje~9&l0ZZ78~z}jd@U!ipm=_sc1oYqGqmp9+92%)&FpJrq*ItNtlRHv*U~ z#0830e`CGloZzn&{M{~QMgAFpv9$m;V^IYzw&u}>&016WyD5M-+6JYg^#E4Q-opMI zz}RL0R_&7kjI9AMwh4gO6WH>p;3`*{?zIH)>bm0b{Q&mH5 z0jvMHvf-~XBwSiw)Ea`h|6~MT<6k1;g{8OA5G6DEH4){~fGT6C3 zkqW67d1xBd=GL~Ott9yS%e_05X#Mgo+NLU>6K($a*;E^IFj0?~9;y_KW@u4AsS|Z29XTLDu_@tI~Pv-1B{<85vW=ihWs^p!H z+lWu|8FlE8uhxGcW8Vn?EP;wJpGIT1FWOr}jTU5clsQ1-Wvjp5;&^VMRBy9I>7!94 zWg)c5vnn(~7l1?Q7XU8QlQK3K?5zoV>w=o$hWS$e;Z5y-4qyeA9|AD8p1&Ugu##MU z4}h^h_kdMgg)POq!O5~Q^F zPc6-24}OZmXJJ>$R#Ur}>}XN}%({}nVggp$>>mQoytp*(pM~3az_9o9l@hk}A>rwg zLKSjF)L>nb0LGt0Dqn<;sb&UjxmlOm^8hlPwp=LW2+QT14C2Uylds=nm_`>F++raZ zh?F2Z060&m{=#1jV)x@&UVr*r+I8knGD&NmmZD}{V6ws3 zHAYR9bjYx`&qVn9*Qx z$9ywFA~QRZL%h!JF$7)fh>Q%~DYbJiA2|}26r^=^*J%ACD2URF`Ng}wjPCQ;6<4aU z)7pu8SmsOVbxcNvF*+R{rmBdi6y*|=E|mE}K`J8{U#`@TyaQOSG$=BWr z511*_cGiDuPZ~|2@1uOAWNEWQ;9HAk&RPgj$8uP{?G zoZt3Be$s&B1_=c)M+loMxrm=hFqW4f1g*C<0a#_8{Hv5*3n-a5u6p(Ilzd55!O+}? z1c0Tf0N(mJdjQzD17LDY$_ASG%W4(?UghL^0ApqVoBDk%AJ-Dt!g1XMv9|1Dn*tb< z0NzMo`;P?hr4)RL9M`A zg}T_09`S)jr9Mjrp!vh|*;jZ*vn?%Ua=LTxC4$33>K>zE2uFAc=Hj;E_!hr-!DK8s zdJ+X+97J#|o^S(dLwKbk^h^mc4;5_%T{ym6R$s4->Zs@MC=yA;qv9%rW z;GrMT+HJFn-8N2?kda*IX_m^AsrkF?|VFlDRf8Qn+!{_j6tFK^4s zop?-EyS#0X{@PJ)9-MjjeKP7z44~?NCT3>M7qp{b6xrF?nHg0V=(iXPBr}2n7~C92 zE6+~}q2FYCm2{U>CqyoVC8S*Kz2cRgdZuhCEcBaGXUeLo8qS~m`oxKY{F;}RkT9BU zn|m`_K7__F-(e;%T#OGP^P8H{mm1)C;$V1qx|>I;=fT#54j5ZnT54Q~qx3h{FTjs6 zpnie=UYrYgFR7 zq8u78_8ck-5jk|BxAZP`P?(hVD#!B>70nSrfrJXu=!})!LoNfev7Y;4qN8~uvUJ#G z;l>Rkvm#{#7k8Her4dIPgRSCk0#a(S1*Js5nndm0IA_YK)RZe*2Zm1x3@Ik{5lGWI zD(Kky*IR9gqjO%m-tv=7r!Osaku|iaT=>T1%tm{L(jHQbJLfNd@Oj-@n0SIUGuTjj5nN%hdYhUhL{_^wdw%0^$M!Pq2$&-pEu#uoya zDcu2pw}V(fiAQX;ieJp~YHr^Qz@`#0OXyneD<<^_1uRu+eh9!H^nj&VTbc>LgrnbU zlD?k+V3`}<9KhH*fPON7rF{^<9?s@_KRyKgVFG`G2P{r*0PvCZ5op!-Rks$#m6joB zApGA2Fa%bIQ360!&{yzx1Axs0UX>$+!;LC|*^v#vB895}_zd$bR{@Nz1MqQETw8d@ z^1J{r8$#DhQs`F#xTRb0w?46;3!_dMGyqvFkB52yjDMU*QBl{;Vi}9RApV#DOv~?( za7pE~$TlJ2TaSTq1;C?1zG#}GFJ2V4wN>7Gjx|5K--9&1^l<0pJPxK>;o#yBcL8Pi zE9H;O0LJH4gb(QdnzKT;iCQFMWFEivu6tzfXNf)&dP1}7f2w$|oe9De+`K-6(j zDON!JSW0G8M@T?MQ1s#%FJG-IRqdXBp$%14tsy7A@eJ=?Dya)ASx&yzni(7J@17dl zyV8)-d-7!1@bK`-!^cnfoh&OU>z%z4dj3^;+XKEJ%yj-VF_C-WDgZ`n$e+^0vuA_P z9`*6h$Ot@mGAzNbZWX|pku>mzMqRlQ8xZJ~b2!H5D;kbsL;V6m0)6eAJfnl$eRl%j zqahs~j|VFdRcs%=*3r=snC(MT?v<9_OUo~!LelpJT)UL_VzMd){eBOh;{$tyv>p8Q z^<)r*Z+2*GWJ+W%jY(8qdxppR1^62DhEk&~GDS(AK}VQ(5$sF(bg@W3p^VK=)XeF}Wf)avL+}$Jvz@=ITUH*Ps+lVFxh=oO#)r6)sl`ZFZ?z7ef zlm71eM>k*`;Uoq*7A`Koip^Iu+x`>L!vKv!boQVJK}7q_1C0EucWDxXD&yHpO1f?9mYCZ+vB zyHrxr2yIU;!6N|pv%(v;0>D;!@1&gQpd=?5ICpfWsh701l6X~+$Ni!P%T|>@g1=U# z=@pcJF@e&#^tSB=57^X{%SLIU`pnT~tKc_l@B(J!S*ZYKYrSS2NAB8xRlJ-~qESllU*=0jmJU1^x&C zn+S}7-$u6bKeY=90*js^OyqtK9JUk;miz_4seLWG}E~&svrj{c`Dumf70?(8!6}Q!k%4q1zaS#ixD@0}%bUvdhne1$r z6!0C*!$#!*N?`@%42zzA0h-&!N&P;*gQ`6)XWN|MCZruN2diCEY=w6#yy78Fz+F0f zO#miK%!4?~9?B1j_e}hmhNm{JEEr5|XJ%9vL!lWFH8n0KTm5|hP42~#l$4a2#C~*) z9?bPHhmv;RXAkcG%y{UZ=f)Ur&F`Uo;t86F^fIyN;MmMWyBI;zK3MSR=`TWg;hq?^ zHI{ia<7}M!&YjG;@HkSqaQ3W!P{{eHglmDPUiB`&TPmxYU3r)CFf8C`u)Bxbm8EwD zbMu$3HgtAYo&5T%*3Jvdms&EzqR^Y~!bYLfDZH@H6abNi^qfAcYn>qt6^W_(LSDs(>?T5VEJaG#%ES# z<+b%sUJ0nVhG!lXdSdUv*mp0MnMPLTso9xY-A$8OUQwA}D*oAS5n#66@8o~TGdk6+ zFP>SN%ad2D8bXeb+#LvS!o}Cx`5ZV9Y|y)f=Y$&==0|0Jn;`cTjmYf`4 z(v;(AXS3~Gey|XE&^X&5bhyKbj*SQ>aNN4M6DV<@fvEwpr=`t6uP*d%#??Ie?E!9-1apt>rHOHsO*JDuPu4o6S7`nZ)l&6~LGoz-m{q zgfB0t>>QNFO=k|A#N$ zl*N@8SjGS_4Ma?@!do4u_m{bmUAV9k!We|c@vUc{wjy@OsWxAy^m%-)pFA$Es?bro zMLby!)8I}#SHjpllOjnK=&HEh!{`m1;2(c^ey{wE_<^!kR+g@ue$wAX0G+UKTYvdm z%B=I+A2Un(-Vai{uoBd_Jq|s4HYsWM7Y3Sj-5H8p8tmbldL=EkCj01_l-#`Bl#cF| z<<^AR=wRE7fXJ1bFM94goxhm}fawe>=k1q|{q&enH=cVlQ?Zi$PMnNAja))?bbPqWLIv~OR?zC%Fr%IxA%gT@U%lmBxVG}^%M#^@jq zTLkO<-Q2w6V3XbjJwb*xIWs{@Bw1}J_>GJ6)>dZa6sN#Y1Qz-|wJffRhG( z9rN$|$GXZu_DKm`0605(6d&Mv{y=-R%XVty3T~I_^eO$~}Cog4cV%s=XJ$g12h{40}!gZSZ|9(!kgU z5zIB416XE(%>-6qX$fHEJOEa+wQEf|U>e6k>R0uV&nTxi09bBR0E;!Ld_Hpq0AG>I zP=Q7KIdXPZW`J>O*$AwPzo3&pc~USC#r#pGQ3<9dQs2Y@=>f~j$kkFMjAvSobrlds zCM!DxON(VOGpBC~7{lA?;?er4ibtaSX^1&gv>1sixJ0_V@N^oULRqrCAeI#|pe1FG zKr(7bq6kX_y8$o+#{GrZ0JyS}bJvM$Q_3uEFmHEN?9!$gB_<%W$bo`>b}__VW{`>Lyb?h zL`K!6W@PyK2Kk*i9D)LWa!0aXa%^O6RC0C5!L+D&^aziNkj6LhH8s~t%A#79R^Gi> ziVvv?^osjBJT$DKyCLdY?CcU9M>SC;r?TCT1bdR42?&i%i$BGXE&sE@tvUE2FV&me@4SI?issR5}S% zGAaoV*Foo`wU;9f0hQ6H(_0hmEj8jwq2#CA&mAI}xnJje2w6PbDvy0ZheBFfBCAuY z>DO9p3a75v#z_8DS1JH3L#7IVMUecG zQQ-XiQrdtB^xEj$zI5`Ai%A+8VO+7xejsX62jX2SQzAGbtC);Bjc9ce6k`KEwg2Gm zVFzU4kCC9d1e~IMgxT=jz+2>ZOZn-TzwCs}lIC;A@9swEc70APVY{uPM#IH20jmy5 z);b4UTkC~GD*){9nLwJDs`)t+uXgCPzF)@d^9|DBaErA_(efSzzs&#^-wtqhm5{ey z{C)(C>GTpTeJ_A{Z7Q_Yv!>aP0C=0rNU4iux)pbvRo2M@i(k6x23w1tUa4eP0c`e` zC0NY>ruk^=-)xl(R#|HeloeYK;7zNbEqr0iD(JQQX4|X^TCIS_R-wB&fLAA8ZD8&H z48R{>1#S1~0M^;*HUM~|nfZ%Rov>=3>H)j0wLeJ%i$5RC0Rv#nL{!0DQw^565lO;U zVt8#Hc=yM+!0I(02JqJkUe^QIOFpRcDpxgq&Gh9zOC-Zyna{N_lMAc@STrJ;))auI zY3a9{_FLdWk@rD!I(eBO7&AWvo{pQUZ zyyPE|X&7gw=H%(HgqnbGaskvoHNJcq_m#WBEfv@D-Mf_zA0NNTf{MW>KV|hlh(B@M zcw|pnH_7g$<(cZiKRO>DinPii6FROgz4JR{mvFi_&C^x?g}aSj>*1Cf=oy~o zneKD^IIP1Xp}Lv*9XR62*8)QP?a*J(Z%T{b=ReXIn-d-f1x59+n0W6I!Yh=OwZs`U zdYGZpk_=XgbD%ESUt3Imo?DAPTk@Kv>^hKJH8>cgOpwmOIUudk3Gd7)rm3my-K#Xa zU2af*F~sw3{(gZFt}$p-Tml{mV7t12_*buHJ%e4(`W$V{@$?LD^3`lXzdoAMC8N$p z(h23CyElxq$Ko{-n!cO#-Cr{}3b4AksADvErwU;dnS08Jy>(mQo2~Trm@Q%#5l!-1 z%X*SSNGC{KFl_^f;mhN0$MIF;cK(7c|MuMoXJ0oDd+&ii?vlvey2TOcK;}-`U>a+s zYZ%lz8=~FPK0# zZ$y-g;h=Ia-&U-+koUP3zz`VD-zI&#N>z5)<mVLmyW0vC-D_H}-Y|)SrZO&5E z^*JVrvf$h(a)h!EnBE{!JdKJ`PbHqHIH<@KQC5x7HcSY5`p%EPT<;-1y&}A9ksdA< zes2Yufm876<}}{#Gaw6|1b#{RV$GN!Ff%HZQCLihMsAqoFwhxl7X3`GpZ&@d$vgM1 zj|2Sv!HM<@h&$2JG?9|RERovUi%UiIJ$HyD|I9Unpnt^yt{i_*&^AZr`N4g3jvm1G z{s;Z-XbGkyoUZMhcrY$zc>M7C^{@TJsB6QL84MZS6q#JzcdV|4F($w`isG-~?MQxPkloAEn(*0}Sli^cO~oJZ>~m9;D}3;N0Ee@@pIoem4VQqtR+l2^&v zcPhtf!xA1od^|DP&45VR@B2M!OI0Z;r)!5>AJ){=2yZnkDzf49o;~TI39Su9d6Sv( z$3qfkc(XIZp|5^RCh1Eeo&nm;L*+BWH64BjGu(|MUni%!x$il9JRqcFda03~;>g}* zFZXS<^cwR=l6*4k+_D$b4)ASEi?{+aCG;LSv1v8Q37OS(ff2OGIL7_)N35I1(I>{g z)Oi~^!Bj%&kDT@G3yciAR_E87uhT2@C5XN%pJP^z&Pn_1%oBti^$rdOBDMlYz|m1> zbkK9D-ey-_T3Q4&)_RBg1*AK<8C;#Bkydim?*K`T3j0`*F<1=BlHIpdch&i!Wn6}e z!;vHIhr>e-A0CKta?yE5#L#E!;=+|ue!$9M%T^nJjk)NIF1$I?(+CgVDAh}zLL3=? zwjpyZK;vl44<_0yd`?dDqS1}N#q78G8>?+PgI+f0+H#|SH=Va2gw7(ZhKp}37^(F3 z)@Z(LY)o?7mv%Sj?jfDX6FWG2FBqxd(ok3hfMGmIasc|-RsjWY$%b_WcC`+WAF67c zVnRw~tF1=7ma4=+t+u0$ZimJstuJfIRTi>m#rGkFWE%m@7YW92sPg>W0P)$%pmLnc z7RyOk+X%`lA`@#A_{|)YZUV67B&1K21DBQs*4cqo4_H7KJ9tnmdqNuI7a>d8xWrYsz_bBV zfHez%mjqLREsx8hv-I*Sr3YPE116-QTcR_G&9Q-x{* zhv!8B6>(;9oCx%^5Z$K>=uz{u5G+!vq`8cuXV4{YkuAl|*AWH=z@qJlI5Rw#TD_G+ zoTLs*Rz@=w3k(yo2J%lI0sL_cznM40i09mk7Z{>3UtTcLe(C0mVg#68)EA5cU`9Pt zfz|U`%&sJ+oYw`o#_!MZO3!*KikVDFLGV=E1nm53Z`y&-_>!wv8^QvIC;BTY`a6dkmX;?Hm0Ur=XxGgbnSLyi{?*a1 z7r(hy4S{zDrv`>BUkT_7h^N-wS*tf5(fULm_VjVr`UjS!H6D*X?(Xj4>mT9oq4n{M z&W?`^O?7uJb+*+7hcBiDa=lNwhrz(K2_er=SeoA#klB)1?M4te*g%a40OoT9rfEy_ zL0-hZK0ceFhtL6X(EvL+jSA$kr{AG-<&+0s2EwD=gkZff!rx7Auh$z0SPKnaP_AHs zPt$Lq2ui>Pj&7&SOB0Y2n}Z?&&ZB-8{p@KuF;rXI9dnED)e7|o`iK!DawIdks)I{V zTp7tAs?3lAk{BiZx?ptSf>r5yhGXywlr(b)Bx{mJ2Ap;XLa?T&)h2z-=QED$x15Ko zTHYFbEG%@fa@k+%sBs#}$q5Y12@j{{`rFHnVi;C%DFC*?z7@c=Wh$2BuJsn_X_`cD zwH_Xt9WI=5@Q#TQb=C?+gn!JA1JX^Ue1A};T#CrEgSCwdPsu~`Re?8wj=xe=PJNjy zAXB5!&=Alvp4)<_CLh*OC^RsLOE{Q3T5a3z_)ox>J@LwprTbmP4GO;;T$Jg}Oq67G z=1o%S%&n?%i?A)0Szt_oq@d*I99simi(S(qTxVW!O)>QP5VVq3=5otoXz|rgncd8u zrBS#ik-YKvdRAkO3TRcBuL1D;<&exzL8=9NEnQ$s0Gs){9>5#z7-rH*QY9PAPt^wi zY+>u~w-s6Ooi_zA!tm_d=}7Ew;VSEnDfes z^``bBp_^uTNZqkCNnSI6EeWj3E?_)-y_XFU;)BN}fQ4>90B%%DvDCR7>Ym^$)TODH zSY2l+-yD@Qra|wiQwRlkoxnixDV$y$XUS<%!F68vz_TT@z1>U9eHH}n zMrUDq{%v#5{Xw3AT7h9KPf8hK-2%WX09cetCk__0!CYnF1~paU*0;CH+3%ui>+Rcl zIF8CuF{gE4T{hf`|Do;-f@GYSsWKi?TotV#}zf7KY6 zU6)#RA#phDeA>YiCwrF@Q^MY@ETx46F^4RmI-#ovwZn0u-;ZlcS~{xhPG5MDo6C2a zrKMM|LIY|h6GyAU0s=!XX3acq4Ld(G_q4qI`|50;v%w3bm4kPC0Njl9vxA9wnE~ni zBf#YiN%b`@oV(lD)aRky88`6T-6S8su-x2~>Y4i$x7w-_TC)n~eywaSCr?1Rc2?0! zPRt(u$sRp;rTcVUNMN6swSFjM(XX#Ms`p)Qg0;qjm}y67lxMK>5ua0KX$Q`_yNWTF zfqo%eSwl6^qf8BFR9X7lBv@pTrzN?Oq7=A%2Z11AAaX4qsYinIMK>#N;{Mquy`FVrBG%T&9 zATT^SK8+P)My@z>-lS0}J`ECywxT&p*gkN3&~~%lAnYpm2^|A2PyysEddy!f);jQJ zIG%?{d(impS{(l(!BHj0ov0w_lG6OtdXs}FPvdR0NeXLqT=fF7t*p52MC*-n$F)EYW3vn;R0P}BSlqTERN|FMuUCcxA^eyL>*K8%{qAuirxk4F z!TM5^>a}6D7p6+WTC-Q)t(PF1kt{2tbQ+^OyU5V2jxp2#+@)KVlmgkTQ3;tpmz*lci5BvqdNKaB(ek1gjXR!o^ya-{*di3)qx}T** zKVJgKg1Vyvve8Orv;x39V$qjiFFEfN58x}Aa0zv0Knm)RlC16+HEVPn<9SYE`Bee1 zOnJ`>{3^=Q)!ebf%e~Bi>9o3g_X%5In-e&d*XipUK!u|kJq_`ppa}1#YHHu-pN)SEX|1LL*59itNux<&$h{KLYI?DYI%hyPxd za(#XFT}&B?Xl>c+sd2BXuMhS)^0AACK5PFN{;`3}LxJtx4<2L;b#`W?)YV7y+~93K zd3dbwo35^J9<_HNP#N~=p6Tg^Z`ym?a1RuNO#wN<$>iv55$;*>EuKL+iHW(v{>B~N z!Cj3P>Oy>55o75Y$_)&~#McMP>GkI@7tHbwX>@mT4I9qM3fd_ZEEv{dr8qRYva;Y4 zhHaB#jA=+QNAKaA%yCyjKdyjD1-JW?jG~RWc(|XLAiFJ2)NIkj5(syWFWBAR(h{DY z(i-oRR6LLT1^ElLT9Q=KAO>qp_#OxdfmtA;HPWVyO@iLxoUMZ+Bkv#`V(K-z?CjfL zX|Uk)j_>bR7pJK)9TJLC`r--`7n34Uit(PUvU&@GxUOux!i)bXX(vgg02XwTqr6I9 zYVTxBgZJWNfLtr)ed{Y`)M}B>%T%+X*i~br_0z;8l{(lR{G-WUypl`w;@h_gQscv; zLZ~fsMYXQ@YK3r3mh;62-AYXq4mkwpWA+}DJ`ZXAt*kbS_sH_PqP8rPRdKSH#?{f$ z=z`%yaMr&HS!=7n3nNcV;L5lK6Z(ID62ZX}OkQy#7Wc}2if zzP7Q!%b?L+QK}Sy`BK?${zw)La9^T{cbip5v$92&Y2L#{EJ5*k(_d{#5d5xQVtYez?c!9?rl4L8URCIVxefU z47T1FWJZ_4T?)&nJMtLVl4vbUZ~*0|YqGftbV|7m(X|B)fiC!kyYP_>+2mY(1@y93 z`|#$ZT-JrZXjrlUY;MBpAUJLk05gmPdaXjVJ)c6}gS~@nQ$W6Qmx6PZ(sRxEBGA1e z`xWcc)Rk*brk=X{T}=ntTce$wyyLu127g#|#S)l&`pT6-n2&G=K23e8ePj1$@%X*Z z6`F+9CJj&}vy&_<;}ao7qVHaLI)Q9*{(;1}k#8Ox8^HbkY-Yqr+=&zEDRCiLp12n6 zGkPUAPf(7(^L6Cjkidq~(SgyTiL!;oh3s!LMK7AG1W z)Tbx5MEicRqr!8?7c@i&jG)61=0H$M`F~dF(tQi zY+|9OtsUVk-@uHH8Vrj2#xvS6bxIu{A*u5HvSqq5<3W4ufdZeLAWtHwfVQp5h+S&u zoJjAzX{`|)=H-5|?;qfdQH$XF%h1Z~->ayG{3+zc8&pQL%6mZK3#6h%{Y zQd(M&28Bq&Ikg7i$oSU8^!AL~3AYyuHuL*HKhbOO=&Oa>B2RT zG?ol_uC>Leb=XG2qgOL`gveBJm@y{CPet=^fM0P^nn~-zB}r!$_K+BfTb+i*QucsK zvk?TU8vvN6li(M zZo#L?pe;64`26zrZM2sV8=<2KF-xv%B82IYi6kGrX%F~oEH=8SwrY)F(jXUShx=R6 znUvN`YGGlxWK&OTc9N0iH6xQ(t}@4kjDAd1#T55zRn*XD!i+|t>8a>!Lr4zTrsc*V;391tKln)VW#!x*-5t$FBhJdd3d!1h?-bu(=6Kx&2pfB_DntfR`tZcFJ2z z;aLKBz2w&d+cf}QN`qHqz&n-!Y)OHYPH1Zci-%B|XJD_`gp@6pmH{l$y98hf)X2z4 zNmVNXTZWdT!7xSU>D#+Gi{w`xWzK+a-=0Q~l7q|ut|XW1#l5db0Jw-)SZqSM`P!85 z=6iF4m?|NUlmHe5XxS1i0W6Bh=vztGB5AZB7j$X0GP?-M^tVGWdGfMQ%EEf#;UHta z^k>1}R89cE1pHM308dt3Cd>q8l~?c=0Asp9`!f%OfCg<;B*;~S(nZZzAJ?E?TP*$F zAM0$$E4lmK-OGJ>T(ht{vlfqurm8EL5=sDb9n#-3H*W%H(XRFA`s}HiNxX>pfI&$e z+uo;7U;QX-nx3JU`Q4RU_X=ANhleIs_I7>qP1Qj6L{U*jS3Nq7maf(lg$)_`EW?t}dc7 zdynrIU+g%vgL-p**9gPJpQap0#N^*AG@^$R|H7SuQ2MOH6L&{9;`EyzG7{CyZ~g6^ z@{vRCSo1&VtN!-71~rSSi4lxGefDH$#$NosJuW;r6yyD%9fyJrV|q3Y*kLq8fSYOs+2CCNl8H{fcPE~-nnW=BP+1@37b67oDyyZ48qu{b^UYw zF^)(Y=nVikFfi~yVs3Zsbb^ZqjUN}d0Rm?7DS20Sf0N9>; zser{MhlwCNC9}UeUn=^g!urWBRoMF23jl*6y0*xmffC0-O0l$EoMflb>1E~#4TqDC z_`H1kc6Sh$M_dFYE*C@@`S1be?Qv8%e%w^5XC%wZPc$?GVA50tnrZ!Wej0OMv6Gy} zRa`3sfc^aX8I^W&_R|`qUX{HOA+4CSIX@Q~r<20`V(4d+6>DJxAqIuyoDwU~G=P}_ z41diV)&M3}0@zLh7^-pdmM!9U!x2(@5_`eT(%aZWDk)M@-f97`8JYsX4&q!(Fbs@V z2%w~1y!k@_O#B4^6Ker1kNs5uUO(0Y@Y>bgH8Pd!_h`Krz#17AoU-x%3&6`5UXQ=T zzbX&d0J`rhL9e7Q_oTqfYs2FEeX&jkyavF;I{~~Z2WDGfmz7!&NkU8_%#$n#v(1q_ zFauj2B`V71vNB->V6$)*(v;GpVfuCpwQ7!nwlJFj#~?Q%GLjKuR)CcZ7yvKvSFFk| z@?F$~>Aje;MZN0gjbo!C$Z=r;GfC#6G!LloO6BNLa%3TTCHc#;FU?kb-GIdqSOWMi z0n{E=vn0#Yv{6Ftce8bpoM%SnR=-}{WVt42D?%2^6Srh zg9GCzUuP7i&d$!Jc4kKUghuaa*_-3ZzlcMgo;z|v0dQkhPI~Oi={>rOk`z~eWbVa_;bN`QI?90W&K*f}{qbQ5yLTsO zun~;!X8_3HqR}`gGcN`qpv*d|pQ|GV&$mqpM(r*=!C2n~R#rUT33t5^9u8|JEZ z(lOGj*1=^aeQCwQ{GlQV{+abCqRa2Qz;SYXB@5sz_M@U~#5ALaYSv!$`Y* zfij#1$#s_i%(I-KRwFja2b$mio*h=9I)3%4$2ME32E73Q%TOt?0RXGk0+?W9g8-IH z-6(+na`o8)VDqi|{QxH317O9zU+h$<`F{`KPc{Z%fNQ-3EFUWvUKhaYgqgb*`mRsn z4+b#YwFWR;T@H&7C7G{qGvWc6D->P=@KV5F^OCNN!_xbRSOPGrNH`v0_IrE!Qp=_6 zJyf3gq9z?F&!GwHz==u{GO287Zow+Y(5JUYc3C~ARZ8hiz9#T_gY=esc9cRbs0F}^ zEG0EvU@hr8+96JmfaWyXuH9V5EfxgQ%x6aSr zAM5L=p2E_pr>!Bgp);><5(Hnld1myau*4rk2qaZ}nmAp1vW$Xs-#}+K{)1!pgm?aT z|Biu!D0$!OyFWH?f1qy>v;4%^w&doX#j?(_MP8|`E%EUFz?8&2!xbNY?$VgPIQevT zJZg8?k-3GU>*E>Ubazg47LHHkHH}{{dcH8tZ$CNnPLrsSPYm?UrWVHWZ-M{W(R|Ly z$;r>zvBTddE+wTt#6LDRGcZ3WKR7%kx1kN;=ZL7n$B(|xXpXHcN3=0xBJcY3?)0v% z^vda%iBa88@n7uAh|0}un<%;-b;Q&4W0a)xgOhu2$9wH`+3D$@jk{4wYk26PpdA0` z*4WtSBheA<6vr>MCdZXe)7&NAL3ly3kAKi!AD_Mcd-Hu-re972>;NwpQ^n`mZPTqj zPDnvh_w{qt;}cX$R))Bei&s)ojF&NCUrqpjqrJUjfUM3K1NX?I$eYMO?N~Y1GppqG z$8!$4pwM(8s+@mKKl!Q6(!55$VyUc5s42vP0GYtq*x5U4jL29S#4wLRJ2za+Uqc?j zC#?fK5yBrwwG7di?33o)nFD$;S0N>xghV3WvMreJqxdwmwo1~;BpAXd{lJul$%}ah z>{V?y9j|c1*}!Pr^;5sme!DA9zh*-ODU4w-Q1~5of#P}>gG!~t9bd2E69a3-707=Y zz4yc)aS+|9O!8`H7_jnyzXGQEisQu&4jP0)RBAtfR*c4`ba3EPgq?wOS+4s+G9^J> z8aLKywEbztYDBm7vh7%FN;2xeags^Pdtin*h(DVPrjM935^KH6X^>51e@<*ug0`^& zFwaQNt@UXAp#UZ<0JaJEn2*x(xO?WzW_SFwH)lFr+r#tV}pv2YG#Kck0 z$yzf1&g<95A3w?)7??eOmo)j`|MVZ<{cvx#ig(*LE-V_R#+!2^sGwfD(_5Z7L>F35 z@9D2U+aKI@`}Pad=l|$(VWbS@jLzoPBWW*h4Bj8l?dmS-Z&X)T#>B*VEyt#JbLEYyj)5oTN-jTEa zz;yP^&YiBFLH^Ud6B%&@7Xmc?3Hw?TW9u7@1-Z4)-@d(lI6Nh}APDOK7yV9S4lB86 zTKf3Mr1=y~|ME+=Z;+?gPJ1SFFZE7m?=~7^hK~dVXq@#P^E313wkWekj4kVTdIkj@ za&vQTybyp#p=(S$6=I0R8Y)Fm;bUkoR4$l4u88r8N*`$q&wZX++bQ0*dmll+z$zEIoeJzW;^M>#P2`xp_TT z67ZKZvl7K5x?kba(3+%k;vJipfk{ERr2@_#eh7%M*V>t1_Q6qB-s8F3** zT*N6!cXd+~i0rliM+_jH0?qTYeWZ zZ8s!Al4j;9i<^cW1c0|N>|E+#tCz}QlD{qvRs=RHSgqnOK`S$TPy|PC<}!de-p|i3 ztb%ofO(e6MZ9ammHcJ5B3i}Y)-mX@1=PfG%eDwJ7?J59FWA$$cVENJ<^v)7A@nI$C zUk~6Fl(l+l;{euxS|ygZEJI2Pf0q!vlA>!!``ZK9`oRVOyvr&R-XMT21Xfy~m+sdB z_#Zb2;HCNBwE(v8*AiyrDroiP9^je@yCh?^rv+XTKomAF0T`M>TuD=I4~u>)Wii+q zz=scU~1N^{hqq}gj1of(3$*M+717Ri$C`d--rcjMsP^d&)+^GcAxT(OqI-1IAYsW`R&NQUt z?>)l5jIh1_IRS_K4@dia;Tt&AQtz!XGIk-;6gEk=jn&9~f%R$nC|^s<-EYBT7vF=<<(Vp^<#_8m7CNCE@b2six+= zH23Z+Xc3plYHS`7qsaxK7wWu=`}>F8BqFt5?g_hF5_Wh}r|y}~&T{k$3o|mT>YH83 zkGPxqbCRcU<~e$GnB`KkTe!`_@JQ9?X(y0B?(!zAGS!U)6j_h?Y#ViiHnJR>bgQ=MQ?D+m+twBdK zxIX5HQSTCSB*tAWMzCBtLpV=J=Uyx)a1|gkrW~%a-Rz~`$}7?4MY}XvtG%IA0N6z% z0IX#-w4ltztw-toynO^B-n^DFOI}88_Lvn*553J!~E3=TO^(EvA_l zGsoR!7uNLcSNk@uS|fqZKGexEMF}FE5xCgBpaT&>b4ETVgn^;fNEnS zC@7#S0gSzXpxjpWt(f_n0nNw%2XK`fva{uLUr%3c$qw z5P&xpX7a8(4E)JP0Bj-U+7#G)`?)1H0${FWt$?)_z!JL4_+60&Q*c&VoZ+y!JxlK1 zvtNwwf?m3#Edm|zmQa#lx}eRm)Buf3up%*eAX~_E9A@H|AZM03lu$bI@Yg30;xNx3 zNgH66fJIK*B=TR<&|@+bBSFY3_AUWfN<@-NtpY>R&<&EU z-@H*hHF)z4<4A)KS?gs5mhkz!;v8&^}Zn?ArZMl6P+2k zxg#kVOlXbA1*6xI-cWSoSl-2k@~_iV#wQ9>0wXdrE(VTtCC4^5M@1!G@HBm{+j%G} zKQOAiAvu+H4}}M*opvUrC3(4fC&ng*`-U3Bj-=6hO9F-zF{NFWF+VnWVw`C7^wNj* zzkK=2+r?kz=H`s?*)N9u&~MV{T;YYA16fdTHex%v_ zl!_E4TU#l}CRONgmADEfUDJjGzH-NWN#~$Vi1FN7aU@9Nm6R4=K#iU;Vxg^3F*9=& z$U<=sH!@#Q%{~X()Pm?+(vtjeX#^i`rId~NIW#J`=KyToj?!+;rh}fem|voi>bDT3 z)D|bjP$Q7ufQX5(@aQ*JT;Y1$1Zhn=lbC_l`1M!l)FzA?WS|nV(j(Z7hHS%{60{1F z2%vNHC^xGtg>9WR>Up6l!c!m>0xFsA5;vX1iHKK&yA_MQW~|$;9z(K*oHc+2F8?xs z#VrSO|GzngWQE-IX!?O;NY*F8TT9|=2@99ydhm*nJKqc7RZ~d6J%Hiv`T(|&m#@DB zV2RAt044*rWWE~*u!ZGZaUB3l;I060lK7ANeRN*QOqTH)U%JK$8@d}Z<8os&+u8~TW^euY z9j|oj-+%n^+nUQA_h0v==AAxyw(uk>lyM{Vb-vNNcZ0|L{FXgm9@+8FhcLO12noo_ z&nZYuNx9g)KgTyNF1$XasrrX+JMzY-Zjg76b__l{Rdv0S;bJoJzRA?ii?Jhkhgry~6Gf{pi zF(fE}f9DlDj6p7HRakL_YO5N|;k-XQoV0^7blTj@Uw(P>c9Al$Yg)@s{bBr>@FQW| zu61=*tKCChw)Dra1{xIpl4N>rxFs-O=?Eg7G&+)-3X6QLaaV$mPmG!qE40p3r&Uy+ zZQw5o$;MCI(_&n0l~E$iADo?Rg`lL}7PZb5EV}AE++_DKjDxSV1)mcWz{^rrrsFd+ zay*GkDjJLij^}CSr1ZS7)}t68>I|6k4kvu#9PpJ_0KHVaEpY|FWA?09xned9&9Cy7 zOaM6GLhIbH!9f@A?`caTmX~KtbZd)GOiWU-y>JpfIx{@OU@nO_A2YnjzA46wJlY^; zfM3iFo3v<@2mtfgjh{mpMhI;!%E$&$-dDp4@n@JfAl@{_!AX45VEZ5xgf?32giUT0 z7)_`gT>WBn_y)TsF|ezXMhz0@uH0E%7Wi$OJoIZaV1Too@2gk26;CY#m~ED(xf}qt z#U6RPL9&%t615UqS1K?9K3A5SWm(${*$o5O?!5p8yppTGEr2bw{c!$TX!=e7Z~w~x zCe{V8vn4UMBJYO*nD`9}G-ctH3BbIO#g2Loa+vC@!;}%u8V0k36%S+ZBVm9pb)^NB3r*N+oES zBvXWjgEb%5l$+ru zk|3Q8e84DAoveArsny4NPo}>5_SVza*RPL_6?PV8jCU60jpY^P#pcFV-dR|vzVhS0 ze|zQfs~=bce)aVJ>p7vp`+DJM&UObfiyw!StoXVO)4t zU2sHfdBei>3?18b)?uMbJV04&Y? z`5#5i(=gml<=Q{2DZW~22gp&D#*Cr(r?Bld3@@>*agXsc8dd55JC(EO#^SYP9o`IJ zHn~**EFW2g9V{?8skYC}9TgurtWQG?TMcoAvD4j#vV)?tdM?U#$yZ z>#(SE0Aaoex%Ex}L&F_1mI1uupIQE0BJf(EDiD@HX5%mLn6Nzd^aS-^Ea7)W(RnY* zSXPggsl2i^%YtZPX?mDB;9z>Qh{&%i&$jHgpjWnU361FNuSJrJ(Gd)$+#DEjfIa&o zKl^&AVM`hjwwylQP>B9yPcJw3Cab9!gHe(2(h4nkI>kc?W6;S4i?j$|FmEJyOb_&# zYTOCQoDt*bgM}C^a3%*rUfgb#MO^%f$cBYM1JMDUMUq=$UI3m&c0&@lgCw{E8Y9vH za;a7?NpKL-3hDe)NQ@|!tV$2g&XOSC{Xy6PPcfClND(#hlF7@8)Kyt$_juEdhtJPO zp>bV!vgGEKyO;0vRb6Z9>||`}Y(pkkK5-&5Gn0<#yz$4^Q^&>z&QKz+u3`Y`+q+l5 zUT0xL=jCs2&5mVMPA4XJrKg~d5$WUWdpNr?*=NU&BS|~yHO^_Iq#K@iJF)%y#}lcA z(Fut?WfLhW3pb`-=M_GfD7w};-r3YK`ug?#KR>N1D(h)FGx+rBQ^YdMPA7i0fA68j z;HbEi$^()9J3huyA6tjE=G?}{Mt?qx)zx=nk@)n7hfPChc=(3YbrqIffBZPF=uTX4 z{-GqFk)8!?{iCo+3J*l{vW}HqU;KeuQ;Mz)UVeJ7Gb0_hg`gmm)=gTS7sX6Cc_E^C z@LE%QdVP37YeEu#vx8b{YZD_Aj`&31zTM(dTB>*1iR|R(K?xxd1qC`M!~F11{XUIC z$~7ne-3(f)?6vc0#S~kI!%PNI78{Srn8acyrbK#RwM|*O6iz|xb;AXsRJ*j`xfLFJ z(9z`=6Qp)<3#-szfJ#OBpaJg&J@)xt&i~-zCe$I3WOh0_bGslkH0Z0%yp-(knYn7R zwRb6YQ@8{b4S)L~{!13u$`5JCmYRY8Fr#@=YL{{Ioo^*~V5dny^z8u;^~)IH3;hp;dI20jdo>SL}sr z=xm_1as290Cwut7Q?>;2z1y~X{E4&g&8}Jk8W?;!;!5}526$=LIS~C~jylwl@ zqbB>`*{V0v2CZ5rc*;_Meot6ny+mDu++w(EIi+1&dA96Y6_$N#A^ewstX?Oy%RF9r z`Z9P|bUbr!33NUg!nLMR7z$#W76CA4E&=!nG(&c==0(&vmeCfh=UQuq&w#JHnFl*Q@2Zn}1(`ur>5 z@cZo#WhV>Ai>}=$I(eeJx07{P{Coj0dX%YSRE6n$hQQ_UxBN7N%-6?K#YX^yq&xZs zs?LA=9l92ysomWTWrN?LFcp`W{dENVjf#s1g}VA+-~FFOB)3nb_T9%EVj?3v(kCdVF1cIm-CWlHX zVqKEA5h|ITfJj|k)FiFL0GMkH7gw-fs9(tdz&zp|P+0~^aEB01#k6?w+u-f;_OXzF zg9n98go`o8Ct=rDI_)_okGID}7Z1O9neF54?udD!0^p=Dodv)IEl>d1Ni$4In2!Uc zrSk{3I(x^x?Zvb)K@*d9JI&8o7MxXR7=b@vNUC2vGXq&UodPj3n@PiS9tHsX4-$7< zKoI@bw#wz9FngW;mX0kIh1~h8^A3jN#mBXL`skn2*xO0U9u(udAds_>p;9sOrI<_b zjdKF@7o)lgD3x!XLa5q6_ALM`r;Y^SgjB{h0KCoPkJ@cwG7AE$l)h*=W%PT>$pX?M z$rKc~C}*q=D*&sw#@`|VCaT;28vvHE7Qj&SHwG~A-WB2X!;%oMOn{dG3`;HiT?t^T zm(W;^B?(Ng4`6HF{t5tdw*dgJX@=fqiS+?YnE8uL^FNEUl?3-404A)-YuVaJDr^Pd zwTNYxvJ-(0?#%L(>jT(QwT_H5D`F+*4jqt01-&AuDnr(mOP53noSiN24}TU}d5Jql zf04%$Rcl2giws#LfkJOm)cX46-QFrsu^S95( zJ16q;#>TG?APzlQQuXXl&jw*`;lNYouugT1x2FWMIB+<&2S$yANAiy(>4^V+#HDj1 z>H{MpBMz6JJljz+dcS&b;QOvRpM633A?eLS*B?D9Tj*s8dY{k!h~(tNmoF=^WSX9C zOBA9Rq4E2X>_{)17$8%QitztjQDbJIlgAO4VqM;Q9dXzY8@ z#N9F%lapUi(C<=F9264V8tMfFT&C~*lBQ!(wIa;u9D|TWyl@=iPdK?9GdJ;Rek4Ys zM@jDhfI*#4e81KWsS0GT3LG%FE7dwVUbxeiyX%7YFE4+Jk8#H_!4D^0SG&L7Bt$9@ zuI$HXffZsE>!rwR0S*I(`f8P0iv(jpV>mNb;h#A10=#_|eZ|C(6i@~%!koyIRIF36 zzB@!_c>Zi^deq!#R~-fX*B8D>6+MW1vhVhD&G{M3TvT!E@ENamGz)>^w+ z%sk5<*+CwvlyV`}M>ckdTx}M|{e$08#*9?}c++Nigo@&_V#Hu5E&Uh9eCXIVU-A7w z<*kDnin%7kuL7{@zYAdd{}BLN0J?Ghu0Gxj~(-BQCmS8VIhAbzLn8?A? zmzF5J3kJzjrwAC#4TNQ5sS*uW$$+b;*j6O5&H&&(Z1mC1VpX_l>WwI0-@vWm*c1jx zr|{H&g5}W@31EqGa}AmzG&wJq5CEQ?t*XXNA6m0h8ZsaPc^Sr%k3&?7!2-a-hvD+m z+1bgC$ts?nojt<>u*k39Oz~NO_a|ulaN{4I=-Mckw~W0X`e0r^j`5b!CM_ewsFnm_>MUEU$7P z@lt(C#x>fs(F-{_^yoo)#Mdo8`Hgk$-6u2J0}o^R&{!82_gQFYH1_m?!GVdDFQ>E9 zm>voZZOjTOh)C~ZMmYbFOX=tCt^G*|NU0qI;})(hduuN*bVK5GREh2a2KFqBrjNYnhzF$i4?J9|zhF>=y*IjS_qRv)8U@0tdI zQ9A~zwzfb)fc5HC&}lg8q28=+TwHwV6F)aM;~@<0?QCRg5zWQNIaIp(Lwz3G&-0o< z3&>e~cf(F8wsx4RgM?xV;BGPZCm&+ zw_90cHWtqagzE)(Y1Fz}QL5yp1V1tL1EJ81o`cZ@9sQzPD?=`X#;2*7mNq(5`=mJQ zl+^zs$<vt+O z)5_ATLCY+XE#piMHrw1hIEX4V801VvWK#|f@$L3IwN8y=gR-zHo|9g^4*!y*<7pbg zj?$#Yb4xieYqgkDcx>BbW3z3$jtm%paURRK;ExSLWTJQ$8sIs5Hwa*Y`o#7>{{Ghi zn0NDG!3he0*M?;3uLdx&7QmKc-XAL}*(>-9SH-QuU$(45yNbZ;Ed9!jUkTt<>%nVk z(eKy80=$B~AD#j8SlL{oG`XrZS|-3B3SeH~T>vIn1Ex2bM3yJNQ~*=% zWGF#{0B}UqGJyA308CJRo~{&m@Yj5*U$`^P9%|7XLl(Tp><0{g0q|+~d!woYsL_4} z%?L>~D*(%$Xf}nW)wMH>4v7iiDG6Z31c@u4KFOg}tEG?OO)^Y zBv9K_B0??#O8_$+%qBBPOaPPT3X5Mxi{KSGFPSi22_2I(XH{Vv2+GANr>;D_Dc)!G zAd^1NzI*l~w!HxOX2&Q8jE;?ub?^>;M9x|ERL!RHj(O$FtdQO#?>=^Nyt{C0bWkiW zcMOb;4~!lg>l|;YsyRP-e;~C4BZ|qhm-yZCRgj#Vo^A&4KL0~4k#&KX_k}PNlrgo? zcENMUXVZ65$HpH$zCLj3;Z$w&oyCR1lF7;YuU}W6dQx*4tN$kts~Q3$PUNND8%;%v zvc0*vGWI}tdV2fCCa0H(Fd?J3W2EBf65a1G~CN*9$^-ejetN-J0g5 z^U|xGLl2jS`v-Vk$frz=R+X!R1_QNS$fW}%cmfw zm`+_S;u2oQ;ut?iFO3=ilPPM9#YukKrEvhf;6`9r6m9LD^wRR(jz9D8l7=HcHLb(_ zCUB@6>ZEpbbkevZZf$ZkCP`r}4T%}&NFX{?%p0H_YtfsX++R+&di%T>KJI`~u+vr> zE)7ogree4&QE1NOJQS&9F|P~u2$|-I`=uQKh$T#W139yk@X=*KP8#>gC0E=9QJY{D z+s@g&v3c=77qfS@6!d?hQPDc>MtGPwl6Q}ruoZw^7|L}a3kJa34RkKYL>Cn7+J!3x zb3E3KG3P;92Q)*DvqCL!i7W|4cSkp|p*R~HJg42N1olj-Z5}2Q z^n(PvSGdUxZv{TcI6t_$+0Z(@2EhCV3|cpiGyMHO#b~$Lu!Kz>%P}0t4ePu=^~dnq zcG3#bL%W?ZUHC|k6tp6}-Ucv#zx{8?TEX&G0buwn7)VHrlPmLryxzM3yaLSN9lp!d z`PY@8RUZ!ErQ<&Uz{LLsfY;6`5mo@U8cA9g!0VX^>j-WvcdKgI8wKzOk0)6G?7lPt z%$H(`B>r0;z*YpNNtvy8$C|=3Th`BS48Rar_CT)z@IFOxV;R8yd-=9n61LoOXSQls zUIQi~BO{WRRIn@nX7q^i@+E|@E{Qz&&M&{*!8n-4tgmH_ngTR~z#MVn((T)qdQYD& zJ2u5A4>=nh%oLBwU*Q_uTmmq6$B1j(q4_9vuf#V1PQ?OV0r2x12vJE^bDZ$tr*=&K z3*BHSK)j*wR~jCX49ilq2y$M;E(CxP!Gfyi39;sTS@8Et4JY$0y$Mmp5L#K}$E3?h zcfe`hAuq)VaQ06>3IN}I^7GVaYRBXmlG@bscmMRKKmGjUGhwKIxvGdnpLdVz{=L~N zcTY8qcXxNDo~c;^aB9;v+RAR+B>5g28@+k6s_%a7*ZU(W*GCsbM3AZChz}_D<{a7` zUPnh(U3mJ)Hwu6~_f0Rby!`0V>zbdR-R!6d?KrHq_%dSe~y1BEm+VvBq(NwP{fEo5KG5cV0c&CorUaZ&x)kh z>FnsRpfCh1E`&$bUC?yWAoFX`{Y)7)#T#j;sV$_eFFmvqLXwk5kskY7e|aA zL)ou(8DsiMFLgSh!R*OL-2kK{=%2zyp1f5$&l0k}3+ckWzml%#qUGs#PU?9#+mE(+ z2s0#ltUV;S&bjG%Bgi>x0-|@hUp*dH>=)#RIHOQ0R*@frIa;F?0K08bX-1M+IK-BO6-}{26B|6fb<)CAIl0T`8%sRB;xaT1w|J z->d=i*Ll;XO}xTU04%&1+^*7VrK^~!&;npBXP9*)%|YF|^r(ku2IlRX{uaw(C!3G{ zic++Yt^&aS^2fJ7^=meN^jBNNYh9i9fVkVVfY%mw8n$mYK)UUs^_-fswDbkQ%acF0 zHt26`ld!kh2!PQgRVIVy!F#b;fO#DRvYc~pD=l28HLe+N*Zu~|7CjGU< zhGv2-GFbnrnDYO{3|PjJZWTAuB+2sMdSQLch5#&6;58ZWUKW1$3)6go;vGyM!Cp(A zD}yadSS=5uie>ThS6uoP_#%QO>(8PAnqFvno*DUtyh0Z1_H71&sa+qAAd*jHmRDxR zva|PeZ4vd>ho@+PW@T0plB~WVFbsf2KQtlrI26A@?uavdF zP&Nj@z^9t^T3Omw_$w{?&GW%Re4~SatI(gASrwi=M=mW9SSn&Jq zJrolCb;>v04Yj=siz(lHQ&t<5lk-JZa`V8zK*^JzpA3$6T^yR4C_H&j{2X_m5LeFs zQ1j+a;)RUSC)aAT&|Qv z<8SIBrAzeQ_|GCPcHci=Qy!IEe(CG_5nyp0VEU^+NB-wUH4_neT!mA!3I!50E{I!Fm9s-dDMN3YlH{M>ZT!PGJx9)QrY zOGtYLCGY6|_?SbEw)WdAC~TsWOyf>WLVV~aj$V!$A()}liTM(1ktK3l$4}B?j8vLQ z?f%9)@nv?rni(PYARCq5!$D35*&P(4PBBT$8hL-ERuW=OSn+W;SyEoI?tx9T5TP}( z*-5oY<%D3?U%R=+IOdo7Ql!lr*F9q(aGX^<>#7iv`n9l((hjq44RqYz@{Ry>b z*Z6oAxcgnj)DrGbX*43w%-|>}rhECbDdvx9!zwoMIYSvl<|XxBLD9wMSU+ciSBPG2 zGjI!NO>*#-U>(*;dz>|HVS7|D{L@u8-Z#HYB*ge_x{>QG<4JzbFda9E-{mJU2|D#= zfe`0^+GZ|6+t?XAUL?3mZOnrJn3^-0DehC-rCkxMR0O6J084*Da#&1#d7yX>vec~H z$XM%Uw6-+OwsIj${I>v1Y?!$p2H+J4-Z+3a+y%WJfUTcertkUyrUTmQ@OS3G>{vqV z3i?_f{9yo=^=C_LOcl#qf#yHO6nJgC1Hc4GUBdAC?!T5+taYioP7^fzl>i2>)&y3x zHJIj=U07dmqX3u<>!xT6iLE80`H~^zI20X9#f8D#ge3_~FV+E>4-4)d7LCydb_*E} zD$j`rl4IL?dfH;kr>F0nEF3*ng-t%3MM*=N4$iS$$2NxebPDxKmrn@>$Ozob({PgnV z>>w3@+56qyj|WORy3^}E+yChocq8nOh#M;6_mLjeu+ZC(+gr9clpi>HrIO8v_Eee4{bOYFl8nIylIM)JuvqXt||5 z+BL`@0PBy$U%+_5wZbQMD6cKHU{62AVI-+c=r{pt*k_DMXh0{#u(F7k3 z4=T?ZJS@zX9=r$7nO?kzcJwk;XzBCT8B|gu8mg5Zl|YBsN+{fSNz?M2+ZJt1Yj{G8 z(bX{tgTM+CYFzx*=7c`h)>01>#cJLuYuH*36Hdo7$CnKU&++laSR5bfdXNUPfS?!* z6p)3crht6aaS!r;xXABPv@#vX+YxOmWH*jWoot~jB7J`q8wF*hRPh5oDt#Lr{|Vm* zK~$|@8Y|3D4*-(_C%HOtoMJFR#w$)U7~rjeBDbBiTi{q}FDOso3QHz|wzAhtc3r=# z3G1D7wOz6y{+|HwI?q`@T!!fT0BrsIuNXsGYYDt=HoOwRY*_=?vIe|9fQcmrTj06^ zysPkQIckFdc69te080XMYi)$2_yO~^5dcHTWdO6j`(d$jy|A=k?N|mdd|eStwcw8+ ziq3n#;3-*wUJGD<3xKUcEC4GeO42J>>B0iQ61kGVg1k!Xp;9e&(S`+`51c4ROd_*) zVWBq@3Ce|@(@n=ZD8!;cN%a^2-z1g+EP^{F%qg(g#B>ktafT>8R}=EV zEQRVR^t1YCvS!Tq8Ib*xNPnU2&v$D?&RlgFz3KBjDVY3SUmrZr|#YMG0V-ya?qmvS*9qboeHu0AmRVj+`Ij5M>tEnJWPe82tsN7qw@ z;qc+ePY>n$=7&c_^*o;{85_ySn=0!pTwGj?P00$6Zr$(evu96akk`j9JM#-7f-5Uy znMMM@3%zlT?f`fsJUA=McMppX$!+u(Ef)B@2#E%vF$F;ENxgy+d_4d0+}54$j#+hC zF-g&FWs7&Fchi=H6ORS}>)jj#fRS1X^$ta7(ODqKUW0wEbW-3M+LQ%=QDGYPNl