diff --git a/.github/workflows/build.reusable.yaml b/.github/workflows/build.reusable.yaml index c602351fead..9f49acf6913 100644 --- a/.github/workflows/build.reusable.yaml +++ b/.github/workflows/build.reusable.yaml @@ -54,6 +54,10 @@ jobs: with: path: node_modules/.cache key: ${{ inputs.environment }}-build-artifacts-${{ hashFiles('package.json', 'yarn.lock', 'src/**/*.*') }} + # Create reference docs + - name: Build reference docs + run: | + ./scripts/gen_${{ inputs.environment }}_references.sh - name: Build ${{ inputs.environment }} run: | yarn build:production:${{ inputs.environment }} diff --git a/next/docs/iota-sdk/.gitignore b/next/docs/iota-sdk/.gitignore new file mode 100644 index 00000000000..73f1c5cfb91 --- /dev/null +++ b/next/docs/iota-sdk/.gitignore @@ -0,0 +1,2 @@ +docs/references/python +docs/references/nodejs diff --git a/next/docs/iota-sdk/docs/references/nodejs/api_ref.md b/next/docs/iota-sdk/docs/references/nodejs/api_ref.md deleted file mode 100644 index ae71a3e0f65..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/api_ref.md +++ /dev/null @@ -1,332 +0,0 @@ -# @iota/sdk - -## Table of contents - -### Enumerations - -- [OutputType](enums/OutputType.md) -- [CoinType](enums/CoinType.md) -- [LedgerDeviceType](enums/LedgerDeviceType.md) -- [Network](enums/Network.md) -- [AddressType](enums/AddressType.md) -- [WalletEventType](enums/WalletEventType.md) -- [OutputsToClaim](enums/OutputsToClaim.md) -- [ReturnStrategy](enums/ReturnStrategy.md) -- [InclusionState](enums/InclusionState.md) - -### Classes - -- [Client](classes/Client.md) -- [ClientMethodHandler](classes/ClientMethodHandler.md) -- [SecretManager](classes/SecretManager.md) -- [SecretManagerMethodHandler](classes/SecretManagerMethodHandler.md) -- [Ed25519Address](classes/Ed25519Address.md) -- [NftAddress](classes/NftAddress.md) -- [SenderFeature](classes/SenderFeature.md) -- [IssuerFeature](classes/IssuerFeature.md) -- [MetadataFeature](classes/MetadataFeature.md) -- [TagFeature](classes/TagFeature.md) -- [CommonOutput](classes/CommonOutput.md) -- [TreasuryOutput](classes/TreasuryOutput.md) -- [BasicOutput](classes/BasicOutput.md) -- [NftOutput](classes/NftOutput.md) -- [FoundryOutput](classes/FoundryOutput.md) -- [SimpleTokenScheme](classes/SimpleTokenScheme.md) -- [StorageDepositReturnUnlockCondition](classes/StorageDepositReturnUnlockCondition.md) -- [TimelockUnlockCondition](classes/TimelockUnlockCondition.md) -- [StateControllerAddressUnlockCondition](classes/StateControllerAddressUnlockCondition.md) -- [GovernorAddressUnlockCondition](classes/GovernorAddressUnlockCondition.md) -- [ImmutableAliasAddressUnlockCondition](classes/ImmutableAliasAddressUnlockCondition.md) -- [PreparedTransactionData](classes/PreparedTransactionData.md) -- [Utils](classes/Utils.md) -- [Account](classes/Account.md) -- [Wallet](classes/Wallet.md) - -### 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) -- [AliasOutputBuilderParams](interfaces/AliasOutputBuilderParams.md) -- [BasicOutputBuilderParams](interfaces/BasicOutputBuilderParams.md) -- [FoundryOutputBuilderParams](interfaces/FoundryOutputBuilderParams.md) -- [NftOutputBuilderParams](interfaces/NftOutputBuilderParams.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) -- [SeedSecretManager](interfaces/SeedSecretManager.md) -- [StrongholdSecretManager](interfaces/StrongholdSecretManager.md) -- [Balance](interfaces/Balance.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) -- [AccountAddress](interfaces/AccountAddress.md) -- [SendAmountParams](interfaces/SendAmountParams.md) -- [AddressWithUnspentOutputs](interfaces/AddressWithUnspentOutputs.md) -- [SendNativeTokensParams](interfaces/SendNativeTokensParams.md) -- [SendNftParams](interfaces/SendNftParams.md) -- [GenerateAddressOptions](interfaces/GenerateAddressOptions.md) -- [BuildAliasOutputData](interfaces/BuildAliasOutputData.md) -- [BuildBasicOutputData](interfaces/BuildBasicOutputData.md) -- [BuildFoundryOutputData](interfaces/BuildFoundryOutputData.md) -- [BuildNftOutputData](interfaces/BuildNftOutputData.md) -- [OutputData](interfaces/OutputData.md) -- [Segment](interfaces/Segment.md) -- [OutputParams](interfaces/OutputParams.md) -- [Assets](interfaces/Assets.md) -- [Features](interfaces/Features.md) -- [Unlocks](interfaces/Unlocks.md) -- [StorageDeposit](interfaces/StorageDeposit.md) -- [PreparedCreateNativeTokenTransaction](interfaces/PreparedCreateNativeTokenTransaction.md) -- [MintTokenTransaction](interfaces/MintTokenTransaction.md) -- [SignedTransactionEssence](interfaces/SignedTransactionEssence.md) -- [Transaction](interfaces/Transaction.md) -- [TransactionOptions](interfaces/TransactionOptions.md) -- [CreateNativeTokenParams](interfaces/CreateNativeTokenParams.md) -- [MintNftParams](interfaces/MintNftParams.md) -- [AliasOutputParams](interfaces/AliasOutputParams.md) -- [WalletOptions](interfaces/WalletOptions.md) - -### Type Aliases - -- [BlockId](api_ref.md#blockid) -- [IBip32Chain](api_ref.md#ibip32chain) -- [QueryParameter](api_ref.md#queryparameter) -- [AliasQueryParameter](api_ref.md#aliasqueryparameter) -- [FoundryQueryParameter](api_ref.md#foundryqueryparameter) -- [NftQueryParameter](api_ref.md#nftqueryparameter) -- [PlaceholderSecretManager](api_ref.md#placeholdersecretmanager) -- [SecretManagerType](api_ref.md#secretmanagertype) -- [AccountId](api_ref.md#accountid) -- [RemainderValueStrategy](api_ref.md#remaindervaluestrategy) -- [ChangeAddress](api_ref.md#changeaddress) -- [ReuseAddress](api_ref.md#reuseaddress) -- [CustomAddress](api_ref.md#customaddress) - -### Functions - -- [initLogger](api_ref.md#initlogger) -- [utf8ToBytes](api_ref.md#utf8tobytes) -- [hexToUtf8](api_ref.md#hextoutf8) -- [utf8ToHex](api_ref.md#utf8tohex) - -## Type Aliases - -### BlockId - -Ƭ **BlockId**: `string` - -A block identifier, the BLAKE2b-256 hash of the block bytes. -See for more information. - ---- - -### IBip32Chain - -Ƭ **IBip32Chain**: `number`[] - -BIP 32 chain. - ---- - -### 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 - ---- - -### PlaceholderSecretManager - -Ƭ **PlaceholderSecretManager**: `"placeholder"` - -Placeholder secret manager that can't do anything. - ---- - -### SecretManagerType - -Ƭ **SecretManagerType**: [`LedgerNanoSecretManager`](interfaces/LedgerNanoSecretManager.md) \| [`MnemonicSecretManager`](interfaces/MnemonicSecretManager.md) \| [`StrongholdSecretManager`](interfaces/StrongholdSecretManager.md) \| [`PlaceholderSecretManager`](api_ref.md#placeholdersecretmanager) - -Supported secret managers - ---- - -### AccountId - -Ƭ **AccountId**: `number` \| `string` - -Account identifier -Could be the account index (number) or account alias (string) - ---- - -### 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` | - -## 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` diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/Account.md b/next/docs/iota-sdk/docs/references/nodejs/classes/Account.md deleted file mode 100644 index 82ddf776b9c..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/Account.md +++ /dev/null @@ -1,984 +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) -- [prepareBurn](Account.md#prepareburn) -- [prepareBurnNativeToken](Account.md#prepareburnnativetoken) -- [prepareBurnNft](Account.md#prepareburnnft) -- [claimOutputs](Account.md#claimoutputs) -- [prepareConsolidateOutputs](Account.md#prepareconsolidateoutputs) -- [prepareCreateAliasOutput](Account.md#preparecreatealiasoutput) -- [prepareMeltNativeToken](Account.md#preparemeltnativetoken) -- [prepareDestroyAlias](Account.md#preparedestroyalias) -- [prepareDestroyFoundry](Account.md#preparedestroyfoundry) -- [generateEd25519Addresses](Account.md#generateed25519addresses) -- [getBalance](Account.md#getbalance) -- [getOutput](Account.md#getoutput) -- [getFoundryOutput](Account.md#getfoundryoutput) -- [claimableOutputs](Account.md#claimableoutputs) -- [getTransaction](Account.md#gettransaction) -- [getIncomingTransaction](Account.md#getincomingtransaction) -- [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) -- [prepareMintNativeToken](Account.md#preparemintnativetoken) -- [prepareCreateNativeToken](Account.md#preparecreatenativetoken) -- [prepareMintNfts](Account.md#preparemintnfts) -- [prepareOutput](Account.md#prepareoutput) -- [prepareSendAmount](Account.md#preparesendamount) -- [prepareTransaction](Account.md#preparetransaction) -- [retryTransactionUntilIncluded](Account.md#retrytransactionuntilincluded) -- [sendAmount](Account.md#sendamount) -- [prepareSendNativeTokens](Account.md#preparesendnativetokens) -- [prepareSendNft](Account.md#preparesendnft) -- [sendOutputs](Account.md#sendoutputs) -- [setAlias](Account.md#setalias) -- [setDefaultSyncOptions](Account.md#setdefaultsyncoptions) -- [signTransactionEssence](Account.md#signtransactionessence) -- [signAndSubmitTransaction](Account.md#signandsubmittransaction) -- [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`<[`NftOutput`](NftOutput.md)\> - -Build an `NftOutput`. - -#### Parameters - -| Name | Type | Description | -| :----- | :---------------------------------------------------------- | :----------------------------------- | -| `data` | [`BuildNftOutputData`](../interfaces/BuildNftOutputData.md) | Options for building an `NftOutput`. | - -#### Returns - -`Promise`<[`NftOutput`](NftOutput.md)\> - -The built `NftOutput`. - ---- - -### prepareBurn - -▸ **prepareBurn**(`burn`, `transactionOptions?`): `Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -A generic `burn()` function that can be used to prepare to burn native tokens, nfts, foundries and aliases. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `burn` | [`Burn`](../interfaces/Burn.md) | The outputs to burn | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -The resulting transaction. - ---- - -### prepareBurnNativeToken - -▸ **prepareBurnNativeToken**(`tokenId`, `burnAmount`, `transactionOptions?`): `Promise`<[`PreparedTransactionData`](PreparedTransactionData.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`<[`PreparedTransactionData`](PreparedTransactionData.md)\> - -The transaction. - ---- - -### prepareBurnNft - -▸ **prepareBurnNft**(`nftId`, `transactionOptions?`): `Promise`<[`PreparedTransactionData`](PreparedTransactionData.md)\> - -Burn an nft output. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `nftId` | `string` | The NftId. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`PreparedTransactionData`](PreparedTransactionData.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. - ---- - -### prepareConsolidateOutputs - -▸ **prepareConsolidateOutputs**(`force`, `outputConsolidationThreshold?`): `Promise`<[`PreparedTransactionData`](PreparedTransactionData.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`<[`PreparedTransactionData`](PreparedTransactionData.md)\> - -The consolidation transaction. - ---- - -### prepareCreateAliasOutput - -▸ **prepareCreateAliasOutput**(`params?`, `transactionOptions?`): `Promise`<[`PreparedTransactionData`](PreparedTransactionData.md)\> - -`createAliasOutput` creates an alias output - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `params?` | [`AliasOutputParams`](../interfaces/AliasOutputParams.md) | The alias output options. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`PreparedTransactionData`](PreparedTransactionData.md)\> - -A transaction object. - ---- - -### prepareDestroyAlias - -▸ **prepareDestroyAlias**(`aliasId`, `transactionOptions?`): `Promise`<[`PreparedTransactionData`](PreparedTransactionData.md)\> - -Destroy an alias output. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `aliasId` | `string` | The AliasId. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`PreparedTransactionData`](PreparedTransactionData.md)\> - -The transaction. - ---- - -### prepareDestroyFoundry - -▸ **prepareDestroyFoundry**(`foundryId`, `transactionOptions?`): `Promise`<[`PreparedTransactionData`](PreparedTransactionData.md)\> - -Function to 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. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `foundryId` | `string` | The FoundryId. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`PreparedTransactionData`](PreparedTransactionData.md)\> - -The transaction. - ---- - -### generateEd25519Addresses - -▸ **generateEd25519Addresses**(`amount`, `options?`): `Promise`<[`AccountAddress`](../interfaces/AccountAddress.md)[]\> - -Generate new unused ed25519 addresses. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------------------ | :----------------------------------- | -| `amount` | `number` | The amount of addresses to generate. | -| `options?` | [`GenerateAddressOptions`](../interfaces/GenerateAddressOptions.md) | Options for address generation. | - -#### Returns - -`Promise`<[`AccountAddress`](../interfaces/AccountAddress.md)[]\> - -The addresses. - ---- - -### getBalance - -▸ **getBalance**(): `Promise`<[`Balance`](../interfaces/Balance.md)\> - -Get the account balance. - -#### Returns - -`Promise`<[`Balance`](../interfaces/Balance.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. - ---- - -### claimableOutputs - -▸ **claimableOutputs**(`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. - ---- - -### getIncomingTransaction - -▸ **getIncomingTransaction**(`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`<[`AccountAddress`](../interfaces/AccountAddress.md)[]\> - -List all the addresses of the account. - -#### Returns - -`Promise`<[`AccountAddress`](../interfaces/AccountAddress.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`<[`Transaction`](../interfaces/Transaction.md)[]\> - -List all incoming transactions of the account. - -#### Returns - -`Promise`<[`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` | `Output` | output to calculate the deposit amount for. | - -#### Returns - -`Promise`<`string`\> - -The amount. - ---- - -### prepareCreateNativeToken - -▸ **prepareCreateNativeToken**(`params`, `transactionOptions?`): `Promise`<`PreparedCreateNativeTokenTransactionData`\> - -Create a native token. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :-------------------------------------------------------------------- | :----------------------------------------------------------------- | -| `params` | [`CreateNativeTokenParams`](../interfaces/CreateNativeTokenParams.md) | The options for creating tokens. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<`PreparedCreateNativeTokenTransactionData`\> - -The creating transaction and the token ID. - ---- - -### prepareMintNativeToken - -▸ **prepareMintNativeToken**(`tokenId`, `mintAmount`, `transactionOptions?`): `Promise`<[`PreparedTransactionData`](PreparedTransactionData.md)\> - -Mint additional native tokens. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `tokenId` | `string` | The native token id. | -| `mintAmount` | `string` | To be minted amount. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`PreparedTransactionData`](PreparedTransactionData.md)\> - -The minting transaction. - ---- - -### prepareMeltNativeToken - -▸ **prepareMeltNativeToken**(`tokenId`, `meltAmount`, `transactionOptions?`): `Promise`<[`PreparedTransactionData`](PreparedTransactionData.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`<[`PreparedTransactionData`](PreparedTransactionData.md)\> - -The melting transaction. - ---- - -### prepareMintNfts - -▸ **prepareMintNfts**(`params`, `transactionOptions?`): `Promise`<[`PreparedTransactionData`](PreparedTransactionData.md)\> - -Mint nfts. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `params` | [`MintNftParams`](../interfaces/MintNftParams.md)[] | The options for minting nfts. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`PreparedTransactionData`](PreparedTransactionData.md)\> - -The minting transaction. - ---- - -### prepareOutput - -▸ **prepareOutput**(`params`, `transactionOptions?`): `Promise`<`Output`\> - -Prepare an output for sending, useful for offline signing. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `params` | [`OutputParams`](../interfaces/OutputParams.md) | - | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<`Output`\> - -The prepared output. - ---- - -### prepareSendAmount - -▸ **prepareSendAmount**(`params`, `options?`): `Promise`<[`PreparedTransactionData`](PreparedTransactionData.md)\> - -Prepare a send amount transaction, useful for offline signing. - -#### Parameters - -| Name | Type | Description | -| :--------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `params` | [`SendAmountParams`](../interfaces/SendAmountParams.md)[] | Address with amounts to send. | -| `options?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`PreparedTransactionData`](PreparedTransactionData.md)\> - -The prepared transaction data. - ---- - -### prepareTransaction - -▸ **prepareTransaction**(`outputs`, `options?`): `Promise`<[`PreparedTransactionData`](PreparedTransactionData.md)\> - -Prepare a transaction, useful for offline signing. - -#### Parameters - -| Name | Type | Description | -| :--------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `outputs` | `Output`[] | Outputs to use in the transaction. | -| `options?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`PreparedTransactionData`](PreparedTransactionData.md)\> - -The prepared transaction data. - ---- - -### retryTransactionUntilIncluded - -▸ **retryTransactionUntilIncluded**(`transactionId`, `interval?`, `maxAttempts?`): `Promise`<`string`\> - -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`<`string`\> - ---- - -### sendAmount - -▸ **sendAmount**(`params`, `transactionOptions?`): `Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -Send a transaction with amounts from input addresses. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `params` | [`SendAmountParams`](../interfaces/SendAmountParams.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. - ---- - -### prepareSendNativeTokens - -▸ **prepareSendNativeTokens**(`params`, `transactionOptions?`): `Promise`<[`PreparedTransactionData`](PreparedTransactionData.md)\> - -Send native tokens. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :-------------------------------------------------------------------- | :----------------------------------------------------------------- | -| `params` | [`SendNativeTokensParams`](../interfaces/SendNativeTokensParams.md)[] | Addresses amounts and native tokens. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`PreparedTransactionData`](PreparedTransactionData.md)\> - -The sent transaction. - ---- - -### prepareSendNft - -▸ **prepareSendNft**(`params`, `transactionOptions?`): `Promise`<[`PreparedTransactionData`](PreparedTransactionData.md)\> - -Send nft. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `params` | [`SendNftParams`](../interfaces/SendNftParams.md)[] | Addresses and nft ids. | -| `transactionOptions?` | [`TransactionOptions`](../interfaces/TransactionOptions.md) | The options to define a `RemainderValueStrategy` or custom inputs. | - -#### Returns - -`Promise`<[`PreparedTransactionData`](PreparedTransactionData.md)\> - -The sent transaction. - ---- - -### sendOutputs - -▸ **sendOutputs**(`outputs`, `transactionOptions?`): `Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -Send outputs in a transaction. - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------- | :----------------------------------------------------------------- | -| `outputs` | `Output`[] | 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`\> - ---- - -### setDefaultSyncOptions - -▸ **setDefaultSyncOptions**(`options`): `Promise`<`void`\> - -Set the fallback SyncOptions for account syncing. -If storage is enabled, will persist during restarts. - -#### Parameters - -| Name | Type | Description | -| :-------- | :-------------------------------------------- | :----------------------- | -| `options` | [`SyncOptions`](../interfaces/SyncOptions.md) | The sync options 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` | [`IPreparedTransactionData`](../interfaces/IPreparedTransactionData.md) | The prepared transaction data to sign. | - -#### Returns - -`Promise`<[`SignedTransactionEssence`](../interfaces/SignedTransactionEssence.md)\> - -The signed transaction essence. - ---- - -### signAndSubmitTransaction - -▸ **signAndSubmitTransaction**(`preparedTransactionData`): `Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -Sign a prepared transaction, and send it. - -#### Parameters - -| Name | Type | Description | -| :------------------------ | :---------------------------------------------------------------------- | :------------------------------------------------ | -| `preparedTransactionData` | [`IPreparedTransactionData`](../interfaces/IPreparedTransactionData.md) | The prepared transaction data to sign and submit. | - -#### Returns - -`Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -The transaction. - ---- - -### 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`<[`Balance`](../interfaces/Balance.md)\> - -Sync the account by fetching new information from the nodes. -Will also retry pending transactions if necessary. -A custom default can be set using setDefaultSyncOptions. - -#### Parameters - -| Name | Type | Description | -| :--------- | :-------------------------------------------- | :-------------------------------- | -| `options?` | [`SyncOptions`](../interfaces/SyncOptions.md) | Optional synchronization options. | - -#### Returns - -`Promise`<[`Balance`](../interfaces/Balance.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/next/docs/iota-sdk/docs/references/nodejs/classes/BasicOutput.md b/next/docs/iota-sdk/docs/references/nodejs/classes/BasicOutput.md deleted file mode 100644 index 0c59878cfff..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/BasicOutput.md +++ /dev/null @@ -1,99 +0,0 @@ -# Class: BasicOutput - -Basic output. - -## Hierarchy - -- [`CommonOutput`](CommonOutput.md) - - ↳ **`BasicOutput`** - -## Table of contents - -### Methods - -- [getType](BasicOutput.md#gettype) -- [getAmount](BasicOutput.md#getamount) -- [getUnlockConditions](BasicOutput.md#getunlockconditions) -- [getNativeTokens](BasicOutput.md#getnativetokens) -- [getFeatures](BasicOutput.md#getfeatures) - -## Methods - -### getType - -▸ **getType**(): [`OutputType`](../enums/OutputType.md) - -The type of output. - -#### Returns - -[`OutputType`](../enums/OutputType.md) - -#### Inherited from - -[CommonOutput](CommonOutput.md).[getType](CommonOutput.md#gettype) - ---- - -### getAmount - -▸ **getAmount**(): `string` - -The amount of the output. - -#### Returns - -`string` - -#### Inherited from - -[CommonOutput](CommonOutput.md).[getAmount](CommonOutput.md#getamount) - ---- - -### getUnlockConditions - -▸ **getUnlockConditions**(): `UnlockCondition`[] - -The unlock conditions for the output. - -#### Returns - -`UnlockCondition`[] - -#### Inherited from - -[CommonOutput](CommonOutput.md).[getUnlockConditions](CommonOutput.md#getunlockconditions) - ---- - -### getNativeTokens - -▸ **getNativeTokens**(): `undefined` \| `INativeToken`[] - -The native tokens held by the output. - -#### Returns - -`undefined` \| `INativeToken`[] - -#### Inherited from - -[CommonOutput](CommonOutput.md).[getNativeTokens](CommonOutput.md#getnativetokens) - ---- - -### getFeatures - -▸ **getFeatures**(): `undefined` \| `Feature`[] - -Features contained by the output. - -#### Returns - -`undefined` \| `Feature`[] - -#### Inherited from - -[CommonOutput](CommonOutput.md).[getFeatures](CommonOutput.md#getfeatures) diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/Client.md b/next/docs/iota-sdk/docs/references/nodejs/classes/Client.md deleted file mode 100644 index 30f2a905d19..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/Client.md +++ /dev/null @@ -1,1214 +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) -- [generateEd25519Addresses](Client.md#generateed25519addresses) -- [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) -- [prepareTransaction](Client.md#preparetransaction) -- [signTransaction](Client.md#signtransaction) -- [signatureUnlock](Client.md#signatureunlock) -- [postBlockPayload](Client.md#postblockpayload) -- [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) -- [hexToBech32](Client.md#hextobech32) -- [aliasIdToBech32](Client.md#aliasidtobech32) -- [nftIdToBech32](Client.md#nftidtobech32) -- [hexPublicKeyToBech32Address](Client.md#hexpublickeytobech32address) -- [aliasOutputIds](Client.md#aliasoutputids) -- [aliasOutputId](Client.md#aliasoutputid) -- [nftOutputIds](Client.md#nftoutputids) -- [nftOutputId](Client.md#nftoutputid) -- [foundryOutputIds](Client.md#foundryoutputids) -- [foundryOutputId](Client.md#foundryoutputid) -- [getOutputsIgnoreErrors](Client.md#getoutputsignoreerrors) -- [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) -- [listen](Client.md#listen) -- [clearListeners](Client.md#clearlisteners) -- [requestFundsFromFaucet](Client.md#requestfundsfromfaucet) - -## 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`[]\> - ---- - -### generateEd25519Addresses - -▸ **generateEd25519Addresses**(`secretManager`, `generateAddressesOptions`): `Promise`<`string`[]\> - -Generate addresses - -#### Parameters - -| Name | Type | -| :------------------------- | :------------------------------------------------------------------------ | -| `secretManager` | [`SecretManagerType`](../api_ref.md#secretmanagertype) | -| `generateAddressesOptions` | [`IGenerateAddressesOptions`](../interfaces/IGenerateAddressesOptions.md) | - -#### Returns - -`Promise`<`string`[]\> - ---- - -### buildAndPostBlock - -▸ **buildAndPostBlock**(`secretManager?`, `options?`): `Promise`<[`string`, `IBlock`]\> - -Build and post a block - -#### Parameters - -| Name | Type | -| :--------------- | :---------------------------------------------------------- | -| `secretManager?` | [`SecretManagerType`](../api_ref.md#secretmanagertype) | -| `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`[]\> - ---- - -### prepareTransaction - -▸ **prepareTransaction**(`secretManager?`, `options?`): `Promise`<[`IPreparedTransactionData`](../interfaces/IPreparedTransactionData.md)\> - -Prepare a transaction for signing - -#### Parameters - -| Name | Type | -| :--------------- | :---------------------------------------------------------- | -| `secretManager?` | [`SecretManagerType`](../api_ref.md#secretmanagertype) | -| `options?` | [`IBuildBlockOptions`](../interfaces/IBuildBlockOptions.md) | - -#### Returns - -`Promise`<[`IPreparedTransactionData`](../interfaces/IPreparedTransactionData.md)\> - ---- - -### signTransaction - -▸ **signTransaction**(`secretManager`, `preparedTransactionData`): `Promise`<`PayloadTypes`\> - -Sign a transaction - -#### Parameters - -| Name | Type | -| :------------------------ | :---------------------------------------------------------------------- | -| `secretManager` | [`SecretManagerType`](../api_ref.md#secretmanagertype) | -| `preparedTransactionData` | [`IPreparedTransactionData`](../interfaces/IPreparedTransactionData.md) | - -#### Returns - -`Promise`<`PayloadTypes`\> - ---- - -### signatureUnlock - -▸ **signatureUnlock**(`secretManager`, `transactionEssenceHash`, `chain`): `Promise`<`UnlockTypes`\> - -Create a signature unlock using the provided `secretManager`. - -#### Parameters - -| Name | Type | -| :----------------------- | :----------------------------------------------------- | -| `secretManager` | [`SecretManagerType`](../api_ref.md#secretmanagertype) | -| `transactionEssenceHash` | `string` | -| `chain` | [`IBip32Chain`](../api_ref.md#ibip32chain) | - -#### Returns - -`Promise`<`UnlockTypes`\> - ---- - -### postBlockPayload - -▸ **postBlockPayload**(`payload`): `Promise`<[`string`, `IBlock`]\> - -Submit a payload in a block - -#### Parameters - -| Name | Type | -| :-------- | :------------- | -| `payload` | `PayloadTypes` | - -#### Returns - -`Promise`<[`string`, `IBlock`]\> - ---- - -### 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`\> - ---- - -### 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`\> - ---- - -### 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`\> - ---- - -### getOutputsIgnoreErrors - -▸ **getOutputsIgnoreErrors**(`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` | [`SecretManagerType`](../api_ref.md#secretmanagertype) | -| `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**(`params`): `Promise`<[`BasicOutput`](BasicOutput.md)\> - -Build a Basic Output. - -#### Parameters - -| Name | Type | -| :------- | :---------------------------------------------------------------------- | -| `params` | [`BasicOutputBuilderParams`](../interfaces/BasicOutputBuilderParams.md) | - -#### Returns - -`Promise`<[`BasicOutput`](BasicOutput.md)\> - ---- - -### buildAliasOutput - -▸ **buildAliasOutput**(`params`): `Promise`<`AliasOutput`\> - -Build an Alias Output. - -#### Parameters - -| Name | Type | -| :------- | :---------------------------------------------------------------------- | -| `params` | [`AliasOutputBuilderParams`](../interfaces/AliasOutputBuilderParams.md) | - -#### Returns - -`Promise`<`AliasOutput`\> - ---- - -### buildFoundryOutput - -▸ **buildFoundryOutput**(`params`): `Promise`<[`FoundryOutput`](FoundryOutput.md)\> - -Build a Foundry Output. - -#### Parameters - -| Name | Type | -| :------- | :-------------------------------------------------------------------------- | -| `params` | [`FoundryOutputBuilderParams`](../interfaces/FoundryOutputBuilderParams.md) | - -#### Returns - -`Promise`<[`FoundryOutput`](FoundryOutput.md)\> - ---- - -### buildNftOutput - -▸ **buildNftOutput**(`params`): `Promise`<[`NftOutput`](NftOutput.md)\> - -Build an Nft Output. - -#### Parameters - -| Name | Type | -| :------- | :------------------------------------------------------------------ | -| `params` | [`NftOutputBuilderParams`](../interfaces/NftOutputBuilderParams.md) | - -#### Returns - -`Promise`<[`NftOutput`](NftOutput.md)\> - ---- - -### 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`\> - ---- - -### requestFundsFromFaucet - -▸ **requestFundsFromFaucet**(`url`, `address`): `Promise`<`string`\> - -Request funds from a faucet, for example `https://faucet.testnet.shimmer.network/api/enqueue` or `http://localhost:8091/api/enqueue`. - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `url` | `string` | -| `address` | `string` | - -#### Returns - -`Promise`<`string`\> diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/ClientMethodHandler.md b/next/docs/iota-sdk/docs/references/nodejs/classes/ClientMethodHandler.md deleted file mode 100644 index 3353ae559b0..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/ClientMethodHandler.md +++ /dev/null @@ -1,3 +0,0 @@ -# Class: ClientMethodHandler - -The MethodHandler which sends the commands to the Rust side. diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/CommonOutput.md b/next/docs/iota-sdk/docs/references/nodejs/classes/CommonOutput.md deleted file mode 100644 index e6857be08e3..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/CommonOutput.md +++ /dev/null @@ -1,89 +0,0 @@ -# Class: CommonOutput - -Common output properties. - -## Hierarchy - -- `Output` - - ↳ **`CommonOutput`** - - ↳↳ [`BasicOutput`](BasicOutput.md) - -## Table of contents - -### Methods - -- [getType](CommonOutput.md#gettype) -- [getAmount](CommonOutput.md#getamount) -- [getUnlockConditions](CommonOutput.md#getunlockconditions) -- [getNativeTokens](CommonOutput.md#getnativetokens) -- [getFeatures](CommonOutput.md#getfeatures) - -## Methods - -### getType - -▸ **getType**(): [`OutputType`](../enums/OutputType.md) - -The type of output. - -#### Returns - -[`OutputType`](../enums/OutputType.md) - -#### Inherited from - -Output.getType - ---- - -### getAmount - -▸ **getAmount**(): `string` - -The amount of the output. - -#### Returns - -`string` - -#### Inherited from - -Output.getAmount - ---- - -### getUnlockConditions - -▸ **getUnlockConditions**(): `UnlockCondition`[] - -The unlock conditions for the output. - -#### Returns - -`UnlockCondition`[] - ---- - -### getNativeTokens - -▸ **getNativeTokens**(): `undefined` \| `INativeToken`[] - -The native tokens held by the output. - -#### Returns - -`undefined` \| `INativeToken`[] - ---- - -### getFeatures - -▸ **getFeatures**(): `undefined` \| `Feature`[] - -Features contained by the output. - -#### Returns - -`undefined` \| `Feature`[] diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/Ed25519Address.md b/next/docs/iota-sdk/docs/references/nodejs/classes/Ed25519Address.md deleted file mode 100644 index 62220a46c60..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/Ed25519Address.md +++ /dev/null @@ -1,44 +0,0 @@ -# Class: Ed25519Address - -Ed25519 Address. - -## Hierarchy - -- `Address` - - ↳ **`Ed25519Address`** - -## Table of contents - -### Methods - -- [getType](Ed25519Address.md#gettype) -- [getPubKeyHash](Ed25519Address.md#getpubkeyhash) - -## Methods - -### getType - -▸ **getType**(): `AddressType` - -The type of address. - -#### Returns - -`AddressType` - -#### Inherited from - -Address.getType - ---- - -### getPubKeyHash - -▸ **getPubKeyHash**(): `string` - -The public key hash. - -#### Returns - -`string` diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/FoundryOutput.md b/next/docs/iota-sdk/docs/references/nodejs/classes/FoundryOutput.md deleted file mode 100644 index e107c4b2d61..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/FoundryOutput.md +++ /dev/null @@ -1,142 +0,0 @@ -# Class: FoundryOutput - -Foundry output. - -## Hierarchy - -- `ImmutableFeaturesOutput` - - ↳ **`FoundryOutput`** - -## Table of contents - -### Methods - -- [getType](FoundryOutput.md#gettype) -- [getAmount](FoundryOutput.md#getamount) -- [getUnlockConditions](FoundryOutput.md#getunlockconditions) -- [getNativeTokens](FoundryOutput.md#getnativetokens) -- [getFeatures](FoundryOutput.md#getfeatures) -- [getImmutableFeatures](FoundryOutput.md#getimmutablefeatures) -- [getSerialNumber](FoundryOutput.md#getserialnumber) -- [getTokenScheme](FoundryOutput.md#gettokenscheme) - -## Methods - -### getType - -▸ **getType**(): [`OutputType`](../enums/OutputType.md) - -The type of output. - -#### Returns - -[`OutputType`](../enums/OutputType.md) - -#### Inherited from - -ImmutableFeaturesOutput.getType - ---- - -### getAmount - -▸ **getAmount**(): `string` - -The amount of the output. - -#### Returns - -`string` - -#### Inherited from - -ImmutableFeaturesOutput.getAmount - ---- - -### getUnlockConditions - -▸ **getUnlockConditions**(): `UnlockCondition`[] - -The unlock conditions for the output. - -#### Returns - -`UnlockCondition`[] - -#### Inherited from - -ImmutableFeaturesOutput.getUnlockConditions - ---- - -### getNativeTokens - -▸ **getNativeTokens**(): `undefined` \| `INativeToken`[] - -The native tokens held by the output. - -#### Returns - -`undefined` \| `INativeToken`[] - -#### Inherited from - -ImmutableFeaturesOutput.getNativeTokens - ---- - -### getFeatures - -▸ **getFeatures**(): `undefined` \| `Feature`[] - -Features contained by the output. - -#### Returns - -`undefined` \| `Feature`[] - -#### Inherited from - -ImmutableFeaturesOutput.getFeatures - ---- - -### getImmutableFeatures - -▸ **getImmutableFeatures**(): `undefined` \| `Feature`[] - -Immutable features contained by the output. - -#### Returns - -`undefined` \| `Feature`[] - -#### Inherited from - -ImmutableFeaturesOutput.getImmutableFeatures - ---- - -### getSerialNumber - -▸ **getSerialNumber**(): `number` - -The serial number of the foundry with respect to the controlling alias. - -#### Returns - -`number` - ---- - -### getTokenScheme - -▸ **getTokenScheme**(): `ISimpleTokenScheme` - -The token scheme for the foundry. - -#### Returns - -`ISimpleTokenScheme` diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/GovernorAddressUnlockCondition.md b/next/docs/iota-sdk/docs/references/nodejs/classes/GovernorAddressUnlockCondition.md deleted file mode 100644 index 6e57bcd2e90..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/GovernorAddressUnlockCondition.md +++ /dev/null @@ -1,44 +0,0 @@ -# Class: GovernorAddressUnlockCondition - -Governor Unlock Condition. - -## Hierarchy - -- `UnlockCondition` - - ↳ **`GovernorAddressUnlockCondition`** - -## Table of contents - -### Methods - -- [getType](GovernorAddressUnlockCondition.md#gettype) -- [getAddress](GovernorAddressUnlockCondition.md#getaddress) - -## Methods - -### getType - -▸ **getType**(): `UnlockConditionType` - -The type of unlock condition. - -#### Returns - -`UnlockConditionType` - -#### Inherited from - -UnlockCondition.getType - ---- - -### getAddress - -▸ **getAddress**(): `Address` - -The address. - -#### Returns - -`Address` diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/ImmutableAliasAddressUnlockCondition.md b/next/docs/iota-sdk/docs/references/nodejs/classes/ImmutableAliasAddressUnlockCondition.md deleted file mode 100644 index c839febfc5d..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/ImmutableAliasAddressUnlockCondition.md +++ /dev/null @@ -1,44 +0,0 @@ -# Class: ImmutableAliasAddressUnlockCondition - -Immutable Alias Unlock Condition. - -## Hierarchy - -- `UnlockCondition` - - ↳ **`ImmutableAliasAddressUnlockCondition`** - -## Table of contents - -### Methods - -- [getType](ImmutableAliasAddressUnlockCondition.md#gettype) -- [getAddress](ImmutableAliasAddressUnlockCondition.md#getaddress) - -## Methods - -### getType - -▸ **getType**(): `UnlockConditionType` - -The type of unlock condition. - -#### Returns - -`UnlockConditionType` - -#### Inherited from - -UnlockCondition.getType - ---- - -### getAddress - -▸ **getAddress**(): `Address` - -The address. - -#### Returns - -`Address` diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/IssuerFeature.md b/next/docs/iota-sdk/docs/references/nodejs/classes/IssuerFeature.md deleted file mode 100644 index 8a51fef69ec..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/IssuerFeature.md +++ /dev/null @@ -1,44 +0,0 @@ -# Class: IssuerFeature - -Issuer feature. - -## Hierarchy - -- `Feature` - - ↳ **`IssuerFeature`** - -## Table of contents - -### Methods - -- [getType](IssuerFeature.md#gettype) -- [getIssuer](IssuerFeature.md#getissuer) - -## Methods - -### getType - -▸ **getType**(): `FeatureType` - -The type of feature. - -#### Returns - -`FeatureType` - -#### Inherited from - -Feature.getType - ---- - -### getIssuer - -▸ **getIssuer**(): `Address` - -The address. - -#### Returns - -`Address` diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/MetadataFeature.md b/next/docs/iota-sdk/docs/references/nodejs/classes/MetadataFeature.md deleted file mode 100644 index 9087535504e..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/MetadataFeature.md +++ /dev/null @@ -1,44 +0,0 @@ -# Class: MetadataFeature - -Metadata feature. - -## Hierarchy - -- `Feature` - - ↳ **`MetadataFeature`** - -## Table of contents - -### Methods - -- [getType](MetadataFeature.md#gettype) -- [getData](MetadataFeature.md#getdata) - -## Methods - -### getType - -▸ **getType**(): `FeatureType` - -The type of feature. - -#### Returns - -`FeatureType` - -#### Inherited from - -Feature.getType - ---- - -### getData - -▸ **getData**(): `string` - -Defines metadata (arbitrary binary data) that will be stored in the output. - -#### Returns - -`string` diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/NftAddress.md b/next/docs/iota-sdk/docs/references/nodejs/classes/NftAddress.md deleted file mode 100644 index ca7a3a65206..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/NftAddress.md +++ /dev/null @@ -1,44 +0,0 @@ -# Class: NftAddress - -NFT address. - -## Hierarchy - -- `Address` - - ↳ **`NftAddress`** - -## Table of contents - -### Methods - -- [getType](NftAddress.md#gettype) -- [getNftId](NftAddress.md#getnftid) - -## Methods - -### getType - -▸ **getType**(): `AddressType` - -The type of address. - -#### Returns - -`AddressType` - -#### Inherited from - -Address.getType - ---- - -### getNftId - -▸ **getNftId**(): `string` - -The NFT Id. - -#### Returns - -`string` diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/NftOutput.md b/next/docs/iota-sdk/docs/references/nodejs/classes/NftOutput.md deleted file mode 100644 index 914ff48d54f..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/NftOutput.md +++ /dev/null @@ -1,147 +0,0 @@ -# Class: NftOutput - -NFT output. - -## Hierarchy - -- `StateMetadataOutput` - - ↳ **`NftOutput`** - -## Table of contents - -### Methods - -- [getType](NftOutput.md#gettype) -- [getAmount](NftOutput.md#getamount) -- [getUnlockConditions](NftOutput.md#getunlockconditions) -- [getNativeTokens](NftOutput.md#getnativetokens) -- [getFeatures](NftOutput.md#getfeatures) -- [getImmutableFeatures](NftOutput.md#getimmutablefeatures) -- [getStateMetadata](NftOutput.md#getstatemetadata) -- [getNnftId](NftOutput.md#getnnftid) - -## Methods - -### getType - -▸ **getType**(): [`OutputType`](../enums/OutputType.md) - -The type of output. - -#### Returns - -[`OutputType`](../enums/OutputType.md) - -#### Inherited from - -StateMetadataOutput.getType - ---- - -### getAmount - -▸ **getAmount**(): `string` - -The amount of the output. - -#### Returns - -`string` - -#### Inherited from - -StateMetadataOutput.getAmount - ---- - -### getUnlockConditions - -▸ **getUnlockConditions**(): `UnlockCondition`[] - -The unlock conditions for the output. - -#### Returns - -`UnlockCondition`[] - -#### Inherited from - -StateMetadataOutput.getUnlockConditions - ---- - -### getNativeTokens - -▸ **getNativeTokens**(): `undefined` \| `INativeToken`[] - -The native tokens held by the output. - -#### Returns - -`undefined` \| `INativeToken`[] - -#### Inherited from - -StateMetadataOutput.getNativeTokens - ---- - -### getFeatures - -▸ **getFeatures**(): `undefined` \| `Feature`[] - -Features contained by the output. - -#### Returns - -`undefined` \| `Feature`[] - -#### Inherited from - -StateMetadataOutput.getFeatures - ---- - -### getImmutableFeatures - -▸ **getImmutableFeatures**(): `undefined` \| `Feature`[] - -Immutable features contained by the output. - -#### Returns - -`undefined` \| `Feature`[] - -#### Inherited from - -StateMetadataOutput.getImmutableFeatures - ---- - -### getStateMetadata - -▸ **getStateMetadata**(): `undefined` \| `string` - -Metadata that can only be changed by the state controller. - -#### Returns - -`undefined` \| `string` - -#### Inherited from - -StateMetadataOutput.getStateMetadata - ---- - -### getNnftId - -▸ **getNnftId**(): `string` - -Unique identifier of the NFT, which is the BLAKE2b-160 hash of the Output ID that created it. -Unless its newly minted, then the id is zeroed. - -#### Returns - -`string` diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/PreparedTransactionData.md b/next/docs/iota-sdk/docs/references/nodejs/classes/PreparedTransactionData.md deleted file mode 100644 index 20b60b42217..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/PreparedTransactionData.md +++ /dev/null @@ -1,82 +0,0 @@ -# Class: PreparedTransactionData - -PreparedTransactionData`is a class that represents prepared transaction data, which -is useful for offline signing. It contains the prepared transaction data and an`Account` object. It provides methods to retrieve the prepared transaction data, sign -the transaction and sign+submit/send the transaction. - -## Table of contents - -### Methods - -- [preparedTransactionData](PreparedTransactionData.md#preparedtransactiondata) -- [send](PreparedTransactionData.md#send) -- [sign](PreparedTransactionData.md#sign) -- [signAndSubmitTransaction](PreparedTransactionData.md#signandsubmittransaction) - -## Methods - -### preparedTransactionData - -▸ **preparedTransactionData**(): [`IPreparedTransactionData`](../interfaces/IPreparedTransactionData.md) - -The function returns the prepared transaction data. - -Returns: - -The method `preparedTransactionData()` is returning an object of type -`IPreparedTransactionData`. - -#### Returns - -[`IPreparedTransactionData`](../interfaces/IPreparedTransactionData.md) - ---- - -### send - -▸ **send**(): `Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -The `send` function returns a promise that resolves to a `Transaction` object after signing -and submitting the transaction. Internally just calls `signAndSubmitTransaction`. - -Returns: - -The `send()` method is returning a `Promise` that resolves to a `Transaction` object after it -has been signed and submitted. - -#### Returns - -`Promise`<[`Transaction`](../interfaces/Transaction.md)\> - ---- - -### sign - -▸ **sign**(): `Promise`<[`SignedTransactionEssence`](../interfaces/SignedTransactionEssence.md)\> - -This function signs a prepared transaction essence using the account's private key and returns -the signed transaction essence. - -Returns: - -A `Promise` that resolves to a `SignedTransactionEssence` object. - -#### Returns - -`Promise`<[`SignedTransactionEssence`](../interfaces/SignedTransactionEssence.md)\> - ---- - -### signAndSubmitTransaction - -▸ **signAndSubmitTransaction**(): `Promise`<[`Transaction`](../interfaces/Transaction.md)\> - -This function signs and submits a transaction using prepared transaction data. - -Returns: - -A Promise that resolves to a Transaction object. - -#### Returns - -`Promise`<[`Transaction`](../interfaces/Transaction.md)\> diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/SecretManager.md b/next/docs/iota-sdk/docs/references/nodejs/classes/SecretManager.md deleted file mode 100644 index 432af7a73b1..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/SecretManager.md +++ /dev/null @@ -1,137 +0,0 @@ -# Class: SecretManager - -The SecretManager to interact with nodes. - -## Table of contents - -### Methods - -- [generateEd25519Addresses](SecretManager.md#generateed25519addresses) -- [generateEvmAddresses](SecretManager.md#generateevmaddresses) -- [storeMnemonic](SecretManager.md#storemnemonic) -- [signTransaction](SecretManager.md#signtransaction) -- [signatureUnlock](SecretManager.md#signatureunlock) -- [signEd25519](SecretManager.md#signed25519) -- [getLedgerNanoStatus](SecretManager.md#getledgernanostatus) - -## Methods - -### generateEd25519Addresses - -▸ **generateEd25519Addresses**(`generateAddressesOptions`): `Promise`<`string`[]\> - -Generate ed25519 addresses - -#### Parameters - -| Name | Type | -| :------------------------- | :------------------------------------------------------------------------ | -| `generateAddressesOptions` | [`IGenerateAddressesOptions`](../interfaces/IGenerateAddressesOptions.md) | - -#### Returns - -`Promise`<`string`[]\> - ---- - -### generateEvmAddresses - -▸ **generateEvmAddresses**(`generateAddressesOptions`): `Promise`<`string`[]\> - -Generate EVM addresses - -#### Parameters - -| Name | Type | -| :------------------------- | :------------------------------------------------------------------------ | -| `generateAddressesOptions` | [`IGenerateAddressesOptions`](../interfaces/IGenerateAddressesOptions.md) | - -#### Returns - -`Promise`<`string`[]\> - ---- - -### storeMnemonic - -▸ **storeMnemonic**(`mnemonic`): `Promise`<`void`\> - -Store a mnemonic in the Stronghold vault - -#### Parameters - -| Name | Type | -| :--------- | :------- | -| `mnemonic` | `string` | - -#### Returns - -`Promise`<`void`\> - ---- - -### signTransaction - -▸ **signTransaction**(`preparedTransactionData`): `Promise`<`PayloadTypes`\> - -Sign a transaction - -#### Parameters - -| Name | Type | -| :------------------------ | :---------------------------------------------------------------------- | -| `preparedTransactionData` | [`IPreparedTransactionData`](../interfaces/IPreparedTransactionData.md) | - -#### Returns - -`Promise`<`PayloadTypes`\> - ---- - -### signatureUnlock - -▸ **signatureUnlock**(`transactionEssenceHash`, `chain`): `Promise`<`UnlockTypes`\> - -Create a signature unlock using the provided `secretManager`. - -#### Parameters - -| Name | Type | -| :----------------------- | :----------------------------------------- | -| `transactionEssenceHash` | `string` | -| `chain` | [`IBip32Chain`](../api_ref.md#ibip32chain) | - -#### Returns - -`Promise`<`UnlockTypes`\> - ---- - -### signEd25519 - -▸ **signEd25519**(`message`, `chain`): `Promise`<`IEd25519Signature`\> - -Signs a message with an Ed25519 private key. - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------- | -| `message` | `string` | -| `chain` | [`IBip32Chain`](../api_ref.md#ibip32chain) | - -#### Returns - -`Promise`<`IEd25519Signature`\> - ---- - -### getLedgerNanoStatus - -▸ **getLedgerNanoStatus**(): `Promise`<[`LedgerNanoStatus`](../interfaces/LedgerNanoStatus.md)\> - -Get the status of a Ledger Nano - -#### Returns - -`Promise`<[`LedgerNanoStatus`](../interfaces/LedgerNanoStatus.md)\> diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/SecretManagerMethodHandler.md b/next/docs/iota-sdk/docs/references/nodejs/classes/SecretManagerMethodHandler.md deleted file mode 100644 index 44fe9416b6f..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/SecretManagerMethodHandler.md +++ /dev/null @@ -1,3 +0,0 @@ -# Class: SecretManagerMethodHandler - -The MethodHandler which sends the commands to the Rust side. diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/SenderFeature.md b/next/docs/iota-sdk/docs/references/nodejs/classes/SenderFeature.md deleted file mode 100644 index c844dac6575..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/SenderFeature.md +++ /dev/null @@ -1,44 +0,0 @@ -# Class: SenderFeature - -Sender feature. - -## Hierarchy - -- `Feature` - - ↳ **`SenderFeature`** - -## Table of contents - -### Methods - -- [getType](SenderFeature.md#gettype) -- [getSender](SenderFeature.md#getsender) - -## Methods - -### getType - -▸ **getType**(): `FeatureType` - -The type of feature. - -#### Returns - -`FeatureType` - -#### Inherited from - -Feature.getType - ---- - -### getSender - -▸ **getSender**(): `Address` - -The address. - -#### Returns - -`Address` diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/SimpleTokenScheme.md b/next/docs/iota-sdk/docs/references/nodejs/classes/SimpleTokenScheme.md deleted file mode 100644 index e1cf4fdfb09..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/SimpleTokenScheme.md +++ /dev/null @@ -1,70 +0,0 @@ -# Class: SimpleTokenScheme - -Simple token scheme. - -## Hierarchy - -- `TokenScheme` - - ↳ **`SimpleTokenScheme`** - -## Table of contents - -### Methods - -- [getType](SimpleTokenScheme.md#gettype) -- [getMintedTokens](SimpleTokenScheme.md#getmintedtokens) -- [getMeltedTokens](SimpleTokenScheme.md#getmeltedtokens) -- [getMaximumSupply](SimpleTokenScheme.md#getmaximumsupply) - -## Methods - -### getType - -▸ **getType**(): `Simple` - -The type of token scheme. - -#### Returns - -`Simple` - -#### Inherited from - -TokenScheme.getType - ---- - -### getMintedTokens - -▸ **getMintedTokens**(): `string` - -Amount of tokens minted. - -#### Returns - -`string` - ---- - -### getMeltedTokens - -▸ **getMeltedTokens**(): `string` - -Amount of tokens melted. - -#### Returns - -`string` - ---- - -### getMaximumSupply - -▸ **getMaximumSupply**(): `string` - -Maximum supply of tokens controlled. - -#### Returns - -`string` diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/StateControllerAddressUnlockCondition.md b/next/docs/iota-sdk/docs/references/nodejs/classes/StateControllerAddressUnlockCondition.md deleted file mode 100644 index 568ebbb309e..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/StateControllerAddressUnlockCondition.md +++ /dev/null @@ -1,44 +0,0 @@ -# Class: StateControllerAddressUnlockCondition - -State Controller Address Unlock Condition. - -## Hierarchy - -- `UnlockCondition` - - ↳ **`StateControllerAddressUnlockCondition`** - -## Table of contents - -### Methods - -- [getType](StateControllerAddressUnlockCondition.md#gettype) -- [getAddress](StateControllerAddressUnlockCondition.md#getaddress) - -## Methods - -### getType - -▸ **getType**(): `UnlockConditionType` - -The type of unlock condition. - -#### Returns - -`UnlockConditionType` - -#### Inherited from - -UnlockCondition.getType - ---- - -### getAddress - -▸ **getAddress**(): `Address` - -The address. - -#### Returns - -`Address` diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/StorageDepositReturnUnlockCondition.md b/next/docs/iota-sdk/docs/references/nodejs/classes/StorageDepositReturnUnlockCondition.md deleted file mode 100644 index 5522793019e..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/StorageDepositReturnUnlockCondition.md +++ /dev/null @@ -1,57 +0,0 @@ -# Class: StorageDepositReturnUnlockCondition - -Storage Deposit Return Unlock Condition. - -## Hierarchy - -- `UnlockCondition` - - ↳ **`StorageDepositReturnUnlockCondition`** - -## Table of contents - -### Methods - -- [getType](StorageDepositReturnUnlockCondition.md#gettype) -- [getAmount](StorageDepositReturnUnlockCondition.md#getamount) -- [getReturnAddress](StorageDepositReturnUnlockCondition.md#getreturnaddress) - -## Methods - -### getType - -▸ **getType**(): `UnlockConditionType` - -The type of unlock condition. - -#### Returns - -`UnlockConditionType` - -#### Inherited from - -UnlockCondition.getType - ---- - -### getAmount - -▸ **getAmount**(): `string` - -Amount of tokens the consuming transaction must deposit to the address defined in return address. - -#### Returns - -`string` - ---- - -### getReturnAddress - -▸ **getReturnAddress**(): `Address` - -The return address. - -#### Returns - -`Address` diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/TagFeature.md b/next/docs/iota-sdk/docs/references/nodejs/classes/TagFeature.md deleted file mode 100644 index aa4be6fe2a8..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/TagFeature.md +++ /dev/null @@ -1,44 +0,0 @@ -# Class: TagFeature - -Tag feature. - -## Hierarchy - -- `Feature` - - ↳ **`TagFeature`** - -## Table of contents - -### Methods - -- [getType](TagFeature.md#gettype) -- [getTag](TagFeature.md#gettag) - -## Methods - -### getType - -▸ **getType**(): `FeatureType` - -The type of feature. - -#### Returns - -`FeatureType` - -#### Inherited from - -Feature.getType - ---- - -### getTag - -▸ **getTag**(): `string` - -Defines a tag for the data. - -#### Returns - -`string` diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/TimelockUnlockCondition.md b/next/docs/iota-sdk/docs/references/nodejs/classes/TimelockUnlockCondition.md deleted file mode 100644 index cec0b2dcd00..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/TimelockUnlockCondition.md +++ /dev/null @@ -1,44 +0,0 @@ -# Class: TimelockUnlockCondition - -Timelock Unlock Condition. - -## Hierarchy - -- `UnlockCondition` - - ↳ **`TimelockUnlockCondition`** - -## Table of contents - -### Methods - -- [getType](TimelockUnlockCondition.md#gettype) -- [getUnixTime](TimelockUnlockCondition.md#getunixtime) - -## Methods - -### getType - -▸ **getType**(): `UnlockConditionType` - -The type of unlock condition. - -#### Returns - -`UnlockConditionType` - -#### Inherited from - -UnlockCondition.getType - ---- - -### getUnixTime - -▸ **getUnixTime**(): `number` - -Unix time (seconds since Unix epoch) starting from which the output can be consumed. - -#### Returns - -`number` diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/TreasuryOutput.md b/next/docs/iota-sdk/docs/references/nodejs/classes/TreasuryOutput.md deleted file mode 100644 index f18033053d4..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/TreasuryOutput.md +++ /dev/null @@ -1,48 +0,0 @@ -# Class: TreasuryOutput - -Treasury Output. - -## Hierarchy - -- `Output` - - ↳ **`TreasuryOutput`** - -## Table of contents - -### Methods - -- [getType](TreasuryOutput.md#gettype) -- [getAmount](TreasuryOutput.md#getamount) - -## Methods - -### getType - -▸ **getType**(): [`OutputType`](../enums/OutputType.md) - -The type of output. - -#### Returns - -[`OutputType`](../enums/OutputType.md) - -#### Inherited from - -Output.getType - ---- - -### getAmount - -▸ **getAmount**(): `string` - -The amount of the output. - -#### Returns - -`string` - -#### Inherited from - -Output.getAmount diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/Utils.md b/next/docs/iota-sdk/docs/references/nodejs/classes/Utils.md deleted file mode 100644 index f62092994ec..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/Utils.md +++ /dev/null @@ -1,333 +0,0 @@ -# Class: Utils - -Utils class for utils. - -## Table of contents - -### Methods - -- [generateMnemonic](Utils.md#generatemnemonic) -- [mnemonicToHexSeed](Utils.md#mnemonictohexseed) -- [computeAliasId](Utils.md#computealiasid) -- [computeNftId](Utils.md#computenftid) -- [computeFoundryId](Utils.md#computefoundryid) -- [parseBech32Address](Utils.md#parsebech32address) -- [blockId](Utils.md#blockid) -- [bech32ToHex](Utils.md#bech32tohex) -- [hexToBech32](Utils.md#hextobech32) -- [aliasIdToBech32](Utils.md#aliasidtobech32) -- [nftIdToBech32](Utils.md#nftidtobech32) -- [hexPublicKeyToBech32Address](Utils.md#hexpublickeytobech32address) -- [isAddressValid](Utils.md#isaddressvalid) -- [hashTransactionEssence](Utils.md#hashtransactionessence) -- [verifyEd25519Signature](Utils.md#verifyed25519signature) -- [verifyMnemonic](Utils.md#verifymnemonic) - -## Methods - -### generateMnemonic - -▸ `Static` **generateMnemonic**(): `string` - -Generates a new mnemonic. - -#### Returns - -`string` - ---- - -### mnemonicToHexSeed - -▸ `Static` **mnemonicToHexSeed**(`mnemonic`): `string` - -Returns a hex encoded seed for a mnemonic. - -#### Parameters - -| Name | Type | -| :--------- | :------- | -| `mnemonic` | `string` | - -#### Returns - -`string` - ---- - -### computeAliasId - -▸ `Static` **computeAliasId**(`outputId`): `string` - -Computes the alias id for the given alias output id. - -#### Parameters - -| Name | Type | -| :--------- | :------- | -| `outputId` | `string` | - -#### Returns - -`string` - ---- - -### computeNftId - -▸ `Static` **computeNftId**(`outputId`): `string` - -Computes the NFT id for the given NFT output id. - -#### Parameters - -| Name | Type | -| :--------- | :------- | -| `outputId` | `string` | - -#### Returns - -`string` - ---- - -### computeFoundryId - -▸ `Static` **computeFoundryId**(`aliasAddress`, `serialNumber`, `tokenSchemeKind`): `string` - -Computes the foundry id. - -#### Parameters - -| Name | Type | -| :---------------- | :------- | -| `aliasAddress` | `string` | -| `serialNumber` | `number` | -| `tokenSchemeKind` | `number` | - -#### Returns - -`string` - ---- - -### parseBech32Address - -▸ `Static` **parseBech32Address**(`address`): `Address` - -Returns a valid Address parsed from a String. - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `address` | `string` | - -#### Returns - -`Address` - ---- - -### blockId - -▸ `Static` **blockId**(`block`): `string` - -Returns a block ID (Blake2b256 hash of the block bytes) - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `block` | `IBlock` | - -#### Returns - -`string` - ---- - -### bech32ToHex - -▸ `Static` **bech32ToHex**(`bech32`): `string` - -Transforms bech32 to hex. - -#### Parameters - -| Name | Type | -| :------- | :------- | -| `bech32` | `string` | - -#### Returns - -`string` - ---- - -### hexToBech32 - -▸ `Static` **hexToBech32**(`hex`, `bech32Hrp`): `string` - -Transforms a hex encoded address to a bech32 encoded address. - -#### Parameters - -| Name | Type | -| :---------- | :------- | -| `hex` | `string` | -| `bech32Hrp` | `string` | - -#### Returns - -`string` - ---- - -### aliasIdToBech32 - -▸ `Static` **aliasIdToBech32**(`aliasId`, `bech32Hrp`): `string` - -Transforms an alias id to a bech32 encoded address. - -#### Parameters - -| Name | Type | -| :---------- | :------- | -| `aliasId` | `string` | -| `bech32Hrp` | `string` | - -#### Returns - -`string` - ---- - -### nftIdToBech32 - -▸ `Static` **nftIdToBech32**(`nftId`, `bech32Hrp`): `string` - -Transforms an nft id to a bech32 encoded address. - -#### Parameters - -| Name | Type | -| :---------- | :------- | -| `nftId` | `string` | -| `bech32Hrp` | `string` | - -#### Returns - -`string` - ---- - -### hexPublicKeyToBech32Address - -▸ `Static` **hexPublicKeyToBech32Address**(`hex`, `bech32Hrp`): `string` - -Transforms a hex encoded public key to a bech32 encoded address. - -#### Parameters - -| Name | Type | -| :---------- | :------- | -| `hex` | `string` | -| `bech32Hrp` | `string` | - -#### Returns - -`string` - ---- - -### isAddressValid - -▸ `Static` **isAddressValid**(`address`): `boolean` - -Checks if a String is a valid bech32 encoded address. - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `address` | `string` | - -#### Returns - -`boolean` - ---- - -### hashTransactionEssence - -▸ `Static` **hashTransactionEssence**(`essence`): `string` - -Compute the hash of a transaction essence. - -#### Parameters - -| Name | Type | -| :-------- | :-------------------- | -| `essence` | `ITransactionEssence` | - -#### Returns - -`string` - ---- - -### verifyEd25519Signature - -▸ `Static` **verifyEd25519Signature**(`signature`, `message`): `boolean` - -Verifies the Ed25519Signature against a message. - -#### Parameters - -| Name | Type | -| :---------- | :----------------- | -| `signature` | `Ed25519Signature` | -| `message` | `string` | - -#### Returns - -`boolean` - ---- - -### verifySecp256k1EcdsaSignature - -▸ `Static` **verifySecp256k1EcdsaSignature**(`publicKey`, `signature`, `message`): `boolean` - -Verifies the Secp256k1Ecdsa Signature against a message. - -#### Parameters - -| Name | Type | -| :---------- | :------- | -| `publicKey` | `string` | -| `signature` | `string` | -| `message` | `string` | - -#### Returns - -`boolean` - ---- - -### verifyMnemonic - -▸ `Static` **verifyMnemonic**(`mnemonic`): `void` - -Verify if a mnemonic is a valid BIP39 mnemonic. - -#### Parameters - -| Name | Type | -| :--------- | :------- | -| `mnemonic` | `string` | - -#### Returns - -`void` diff --git a/next/docs/iota-sdk/docs/references/nodejs/classes/Wallet.md b/next/docs/iota-sdk/docs/references/nodejs/classes/Wallet.md deleted file mode 100644 index 6dcb76a0c94..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/classes/Wallet.md +++ /dev/null @@ -1,450 +0,0 @@ -# Class: Wallet - -The Wallet class. - -## Table of contents - -### Methods - -- [backup](Wallet.md#backup) -- [changeStrongholdPassword](Wallet.md#changestrongholdpassword) -- [clearStrongholdPassword](Wallet.md#clearstrongholdpassword) -- [createAccount](Wallet.md#createaccount) -- [destroy](Wallet.md#destroy) -- [emitTestEvent](Wallet.md#emittestevent) -- [getAccount](Wallet.md#getaccount) -- [getAccountIndexes](Wallet.md#getaccountindexes) -- [getAccounts](Wallet.md#getaccounts) -- [getClient](Wallet.md#getclient) -- [generateEd25519Address](Wallet.md#generateed25519address) -- [getLedgerNanoStatus](Wallet.md#getledgernanostatus) -- [isStrongholdPasswordAvailable](Wallet.md#isstrongholdpasswordavailable) -- [listen](Wallet.md#listen) -- [clearListeners](Wallet.md#clearlisteners) -- [recoverAccounts](Wallet.md#recoveraccounts) -- [removeLatestAccount](Wallet.md#removelatestaccount) -- [restoreBackup](Wallet.md#restorebackup) -- [setClientOptions](Wallet.md#setclientoptions) -- [setStrongholdPassword](Wallet.md#setstrongholdpassword) -- [setStrongholdPasswordClearInterval](Wallet.md#setstrongholdpasswordclearinterval) -- [startBackgroundSync](Wallet.md#startbackgroundsync) -- [stopBackgroundSync](Wallet.md#stopbackgroundsync) -- [storeMnemonic](Wallet.md#storemnemonic) -- [updateNodeAuth](Wallet.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`\> - ---- - -### 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**(`data`): `Promise`<[`Account`](Account.md)\> - -Create a new account. - -#### Parameters - -| Name | Type | -| :----- | :-------------------------------------------------------------- | -| `data` | [`CreateAccountPayload`](../interfaces/CreateAccountPayload.md) | - -#### Returns - -`Promise`<[`Account`](Account.md)\> - ---- - -### destroy - -▸ **destroy**(): `Promise`<`void`\> - -Destroy the Wallet 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` | - -#### Returns - -`Promise`<`void`\> - ---- - -### 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)[]\> - ---- - -### getClient - -▸ **getClient**(): `Promise`<[`Client`](Client.md)\> - -Get client. - -#### Returns - -`Promise`<[`Client`](Client.md)\> - ---- - -### generateEd25519Address - -▸ **generateEd25519Address**(`accountIndex`, `addressIndex`, `options?`, `bech32Hrp?`): `Promise`<`string`\> - -Generate an address without storing it. - -#### Parameters - -| Name | Type | -| :------------- | :------------------------------------------------------------------ | -| `accountIndex` | `number` | -| `addressIndex` | `number` | -| `options?` | [`GenerateAddressOptions`](../interfaces/GenerateAddressOptions.md) | -| `bech32Hrp?` | `string` | - -#### Returns - -`Promise`<`string`\> - ---- - -### getLedgerNanoStatus - -▸ **getLedgerNanoStatus**(): `Promise`<[`LedgerNanoStatus`](../interfaces/LedgerNanoStatus.md)\> - -Get the status for a Ledger Nano. - -#### Returns - -`Promise`<[`LedgerNanoStatus`](../interfaces/LedgerNanoStatus.md)\> - ---- - -### isStrongholdPasswordAvailable - -▸ **isStrongholdPasswordAvailable**(): `Promise`<`boolean`\> - -Check if the Stronghold password has been set. - -#### Returns - -`Promise`<`boolean`\> - ---- - -### listen - -▸ **listen**(`eventTypes`, `callback`): `Promise`<`void`\> - -Listen to wallet events with a callback. An empty array will listen to all possible events. - -#### Parameters - -| Name | Type | -| :----------- | :------------------------------------------------- | -| `eventTypes` | [`WalletEventType`](../enums/WalletEventType.md)[] | -| `callback` | (`error`: `Error`, `event`: `Event`) => `void` | - -#### Returns - -`Promise`<`void`\> - ---- - -### clearListeners - -▸ **clearListeners**(`eventTypes`): `Promise`<`void`\> - -Clear the callbacks for provided events. An empty array will clear all listeners. - -#### Parameters - -| Name | Type | -| :----------- | :------------------------------------------------- | -| `eventTypes` | [`WalletEventType`](../enums/WalletEventType.md)[] | - -#### 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` | [`SyncOptions`](../interfaces/SyncOptions.md) | - -#### Returns - -`Promise`<[`Account`](Account.md)[]\> - ---- - -### removeLatestAccount - -▸ **removeLatestAccount**(): `Promise`<`void`\> - -Delete the latest account. - -#### Returns - -`Promise`<`void`\> - ---- - -### restoreBackup - -▸ **restoreBackup**(`source`, `password`, `ignoreIfCoinTypeMismatch?`, `ignoreIfBech32Mismatch?`): `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. -if ignore_if_coin_type_mismatch is provided client options will not be restored -if ignore_if_coin_type_mismatch == true, client options coin type and accounts will not be restored if the cointype doesn't match -if ignore_if_bech32_hrp_mismatch == Some("rms"), but addresses have something different like "smr", no accounts -will be restored. - -#### Parameters - -| Name | Type | -| :-------------------------- | :-------- | -| `source` | `string` | -| `password` | `string` | -| `ignoreIfCoinTypeMismatch?` | `boolean` | -| `ignoreIfBech32Mismatch?` | `string` | - -#### Returns - -`Promise`<`void`\> - ---- - -### setClientOptions - -▸ **setClientOptions**(`clientOptions`): `Promise`<`void`\> - -Set ClientOptions. - -#### Parameters - -| Name | Type | -| :-------------- | :-------------------------------------------------- | -| `clientOptions` | [`IClientOptions`](../interfaces/IClientOptions.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?` | [`SyncOptions`](../interfaces/SyncOptions.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`\> - ---- - -### updateNodeAuth - -▸ **updateNodeAuth**(`url`, `auth?`): `Promise`<`void`\> - -Update the authentication for the provided node. - -#### Parameters - -| Name | Type | -| :------ | :-------------------------------- | -| `url` | `string` | -| `auth?` | [`IAuth`](../interfaces/IAuth.md) | - -#### Returns - -`Promise`<`void`\> diff --git a/next/docs/iota-sdk/docs/references/nodejs/enums/AddressType.md b/next/docs/iota-sdk/docs/references/nodejs/enums/AddressType.md deleted file mode 100644 index b615b92275d..00000000000 --- a/next/docs/iota-sdk/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/next/docs/iota-sdk/docs/references/nodejs/enums/CoinType.md b/next/docs/iota-sdk/docs/references/nodejs/enums/CoinType.md deleted file mode 100644 index 4a9587ed0c4..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/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/next/docs/iota-sdk/docs/references/nodejs/enums/InclusionState.md b/next/docs/iota-sdk/docs/references/nodejs/enums/InclusionState.md deleted file mode 100644 index 3f0c98327a6..00000000000 --- a/next/docs/iota-sdk/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/next/docs/iota-sdk/docs/references/nodejs/enums/LedgerDeviceType.md b/next/docs/iota-sdk/docs/references/nodejs/enums/LedgerDeviceType.md deleted file mode 100644 index 2501a99809e..00000000000 --- a/next/docs/iota-sdk/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/next/docs/iota-sdk/docs/references/nodejs/enums/Network.md b/next/docs/iota-sdk/docs/references/nodejs/enums/Network.md deleted file mode 100644 index 9929d49c3d1..00000000000 --- a/next/docs/iota-sdk/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/next/docs/iota-sdk/docs/references/nodejs/enums/OutputType.md b/next/docs/iota-sdk/docs/references/nodejs/enums/OutputType.md deleted file mode 100644 index 09ba683f6c0..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/enums/OutputType.md +++ /dev/null @@ -1,43 +0,0 @@ -# Enumeration: OutputType - -All of the output types. - -## Table of contents - -### Enumeration Members - -- [Treasury](OutputType.md#treasury) -- [Basic](OutputType.md#basic) -- [Alias](OutputType.md#alias) -- [Foundry](OutputType.md#foundry) -- [Nft](OutputType.md#nft) - -## Enumeration Members - -### Treasury - -• **Treasury** = `2` - ---- - -### Basic - -• **Basic** = `3` - ---- - -### Alias - -• **Alias** = `4` - ---- - -### Foundry - -• **Foundry** = `5` - ---- - -### Nft - -• **Nft** = `6` diff --git a/next/docs/iota-sdk/docs/references/nodejs/enums/OutputsToClaim.md b/next/docs/iota-sdk/docs/references/nodejs/enums/OutputsToClaim.md deleted file mode 100644 index b61a267e7d9..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/enums/OutputsToClaim.md +++ /dev/null @@ -1,43 +0,0 @@ -# Enumeration: OutputsToClaim - -Output to claim - -## Table of contents - -### Enumeration Members - -- [MicroTransactions](OutputsToClaim.md#microtransactions) -- [NativeTokens](OutputsToClaim.md#nativetokens) -- [Nfts](OutputsToClaim.md#nfts) -- [Amount](OutputsToClaim.md#amount) -- [All](OutputsToClaim.md#all) - -## Enumeration Members - -### MicroTransactions - -• **MicroTransactions** = `"MicroTransactions"` - ---- - -### NativeTokens - -• **NativeTokens** = `"NativeTokens"` - ---- - -### Nfts - -• **Nfts** = `"Nfts"` - ---- - -### Amount - -• **Amount** = `"Amount"` - ---- - -### All - -• **All** = `"All"` diff --git a/next/docs/iota-sdk/docs/references/nodejs/enums/ReturnStrategy.md b/next/docs/iota-sdk/docs/references/nodejs/enums/ReturnStrategy.md deleted file mode 100644 index b56297e8786..00000000000 --- a/next/docs/iota-sdk/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/next/docs/iota-sdk/docs/references/nodejs/enums/WalletEventType.md b/next/docs/iota-sdk/docs/references/nodejs/enums/WalletEventType.md deleted file mode 100644 index f982ca75fdd..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/enums/WalletEventType.md +++ /dev/null @@ -1,50 +0,0 @@ -# Enumeration: WalletEventType - -All of the wallet event types. - -## Table of contents - -### Enumeration Members - -- [ConsolidationRequired](WalletEventType.md#consolidationrequired) -- [LedgerAddressGeneration](WalletEventType.md#ledgeraddressgeneration) -- [NewOutput](WalletEventType.md#newoutput) -- [SpentOutput](WalletEventType.md#spentoutput) -- [TransactionInclusion](WalletEventType.md#transactioninclusion) -- [TransactionProgress](WalletEventType.md#transactionprogress) - -## Enumeration Members - -### ConsolidationRequired - -• **ConsolidationRequired** = `0` - ---- - -### LedgerAddressGeneration - -• **LedgerAddressGeneration** = `1` - ---- - -### NewOutput - -• **NewOutput** = `2` - ---- - -### SpentOutput - -• **SpentOutput** = `3` - ---- - -### TransactionInclusion - -• **TransactionInclusion** = `4` - ---- - -### TransactionProgress - -• **TransactionProgress** = `5` diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/AccountAddress.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/AccountAddress.md deleted file mode 100644 index c0ab085333d..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/AccountAddress.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: AccountAddress - -An Address of the Account diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/AccountMeta.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/AccountMeta.md deleted file mode 100644 index ec2c83dda34..00000000000 --- a/next/docs/iota-sdk/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/AccountMetadata.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/AccountMetadata.md deleted file mode 100644 index 7ef38b63984..00000000000 --- a/next/docs/iota-sdk/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/AccountSyncOptions.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/AccountSyncOptions.md deleted file mode 100644 index 1ab0fee3839..00000000000 --- a/next/docs/iota-sdk/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/AddressWithUnspentOutputs.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/AddressWithUnspentOutputs.md deleted file mode 100644 index bb81166f7c5..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/AddressWithUnspentOutputs.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: AddressWithUnspentOutputs - -Address with unspent outputs diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/AliasOutputBuilderParams.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/AliasOutputBuilderParams.md deleted file mode 100644 index 65b47776b32..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/AliasOutputBuilderParams.md +++ /dev/null @@ -1,66 +0,0 @@ -# Interface: AliasOutputBuilderParams - -Options for building an Alias Output - -## Hierarchy - -- [`BasicOutputBuilderParams`](BasicOutputBuilderParams.md) - - ↳ **`AliasOutputBuilderParams`** - -## Table of contents - -### Properties - -- [amount](AliasOutputBuilderParams.md#amount) -- [nativeTokens](AliasOutputBuilderParams.md#nativetokens) -- [unlockConditions](AliasOutputBuilderParams.md#unlockconditions) -- [features](AliasOutputBuilderParams.md#features) - -## Properties - -### amount - -• `Optional` **amount**: `string` - -If not provided, minimum storage deposit will be used - -#### Inherited from - -[BasicOutputBuilderParams](BasicOutputBuilderParams.md).[amount](BasicOutputBuilderParams.md#amount) - ---- - -### nativeTokens - -• `Optional` **nativeTokens**: `INativeToken`[] - -The native tokens to be held by the output. - -#### Inherited from - -[BasicOutputBuilderParams](BasicOutputBuilderParams.md).[nativeTokens](BasicOutputBuilderParams.md#nativetokens) - ---- - -### unlockConditions - -• **unlockConditions**: `UnlockCondition`[] - -The unlock conditions for the output. - -#### Inherited from - -[BasicOutputBuilderParams](BasicOutputBuilderParams.md).[unlockConditions](BasicOutputBuilderParams.md#unlockconditions) - ---- - -### features - -• `Optional` **features**: `Feature`[] - -Features to be contained by the output. - -#### Inherited from - -[BasicOutputBuilderParams](BasicOutputBuilderParams.md).[features](BasicOutputBuilderParams.md#features) diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/AliasOutputParams.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/AliasOutputParams.md deleted file mode 100644 index bb5ccac4086..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/AliasOutputParams.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: AliasOutputParams - -Options for the alias output creation - -## Table of contents - -### Properties - -- [address](AliasOutputParams.md#address) -- [immutableMetadata](AliasOutputParams.md#immutablemetadata) -- [metadata](AliasOutputParams.md#metadata) -- [stateMetadata](AliasOutputParams.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/next/docs/iota-sdk/docs/references/nodejs/interfaces/AliasSyncOptions.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/AliasSyncOptions.md deleted file mode 100644 index 9c5a732ae57..00000000000 --- a/next/docs/iota-sdk/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/Assets.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/Assets.md deleted file mode 100644 index ab24dfb510a..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/Assets.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: Assets - -Assets to include in the output diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/Balance.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/Balance.md deleted file mode 100644 index daae0d0be13..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/Balance.md +++ /dev/null @@ -1,76 +0,0 @@ -# Interface: Balance - -A balance - -## Table of contents - -### Properties - -- [baseCoin](Balance.md#basecoin) -- [requiredStorageDeposit](Balance.md#requiredstoragedeposit) -- [nativeTokens](Balance.md#nativetokens) -- [nfts](Balance.md#nfts) -- [aliases](Balance.md#aliases) -- [foundries](Balance.md#foundries) -- [potentiallyLockedOutputs](Balance.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/next/docs/iota-sdk/docs/references/nodejs/interfaces/BaseCoinBalance.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/BaseCoinBalance.md deleted file mode 100644 index a9ebb1be7d2..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/BaseCoinBalance.md +++ /dev/null @@ -1,35 +0,0 @@ -# Interface: BaseCoinBalance - -The balance of the base coin - -## Table of contents - -### Properties - -- [total](BaseCoinBalance.md#total) -- [available](BaseCoinBalance.md#available) -- [votingPower](BaseCoinBalance.md#votingpower) - -## 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 - ---- - -### votingPower - -• **votingPower**: `string` - -Voting power diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/BasicOutputBuilderParams.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/BasicOutputBuilderParams.md deleted file mode 100644 index 877c350c011..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/BasicOutputBuilderParams.md +++ /dev/null @@ -1,54 +0,0 @@ -# Interface: BasicOutputBuilderParams - -Options for building a Basic Output - -## Hierarchy - -- **`BasicOutputBuilderParams`** - - ↳ [`AliasOutputBuilderParams`](AliasOutputBuilderParams.md) - - ↳ [`FoundryOutputBuilderParams`](FoundryOutputBuilderParams.md) - - ↳ [`NftOutputBuilderParams`](NftOutputBuilderParams.md) - -## Table of contents - -### Properties - -- [amount](BasicOutputBuilderParams.md#amount) -- [nativeTokens](BasicOutputBuilderParams.md#nativetokens) -- [unlockConditions](BasicOutputBuilderParams.md#unlockconditions) -- [features](BasicOutputBuilderParams.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**: `UnlockCondition`[] - -The unlock conditions for the output. - ---- - -### features - -• `Optional` **features**: `Feature`[] - -Features to be contained by the output. diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/BuildAliasOutputData.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/BuildAliasOutputData.md deleted file mode 100644 index 95718d1711c..00000000000 --- a/next/docs/iota-sdk/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/BuildBasicOutputData.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/BuildBasicOutputData.md deleted file mode 100644 index d85d37bfd83..00000000000 --- a/next/docs/iota-sdk/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/BuildFoundryOutputData.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/BuildFoundryOutputData.md deleted file mode 100644 index dbc3ab39431..00000000000 --- a/next/docs/iota-sdk/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/BuildNftOutputData.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/BuildNftOutputData.md deleted file mode 100644 index a7d499237a7..00000000000 --- a/next/docs/iota-sdk/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/Burn.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/Burn.md deleted file mode 100644 index c92ca30bdc0..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/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**: `Map`<`string`, `string`\> - -Amounts of native tokens to burn diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/CreateAccountPayload.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/CreateAccountPayload.md deleted file mode 100644 index 619210f8346..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/CreateAccountPayload.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: CreateAccountPayload - -Options for account creation diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/CreateNativeTokenParams.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/CreateNativeTokenParams.md deleted file mode 100644 index c42e5e8fb3c..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/CreateNativeTokenParams.md +++ /dev/null @@ -1,35 +0,0 @@ -# Interface: CreateNativeTokenParams - -Native token options for creating - -## Table of contents - -### Properties - -- [circulatingSupply](CreateNativeTokenParams.md#circulatingsupply) -- [maximumSupply](CreateNativeTokenParams.md#maximumsupply) -- [foundryMetadata](CreateNativeTokenParams.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/next/docs/iota-sdk/docs/references/nodejs/interfaces/Features.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/Features.md deleted file mode 100644 index 3c2c65b2c9e..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/Features.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: Features - -Features to include in the output diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/FilterOptions.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/FilterOptions.md deleted file mode 100644 index 09fc01072e8..00000000000 --- a/next/docs/iota-sdk/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/FoundryOutputBuilderParams.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/FoundryOutputBuilderParams.md deleted file mode 100644 index 14a96c30dad..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/FoundryOutputBuilderParams.md +++ /dev/null @@ -1,75 +0,0 @@ -# Interface: FoundryOutputBuilderParams - -Options for building a Foundry Output - -## Hierarchy - -- [`BasicOutputBuilderParams`](BasicOutputBuilderParams.md) - - ↳ **`FoundryOutputBuilderParams`** - -## Table of contents - -### Properties - -- [amount](FoundryOutputBuilderParams.md#amount) -- [nativeTokens](FoundryOutputBuilderParams.md#nativetokens) -- [unlockConditions](FoundryOutputBuilderParams.md#unlockconditions) -- [features](FoundryOutputBuilderParams.md#features) -- [serialNumber](FoundryOutputBuilderParams.md#serialnumber) - -## Properties - -### amount - -• `Optional` **amount**: `string` - -If not provided, minimum storage deposit will be used - -#### Inherited from - -[BasicOutputBuilderParams](BasicOutputBuilderParams.md).[amount](BasicOutputBuilderParams.md#amount) - ---- - -### nativeTokens - -• `Optional` **nativeTokens**: `INativeToken`[] - -The native tokens to be held by the output. - -#### Inherited from - -[BasicOutputBuilderParams](BasicOutputBuilderParams.md).[nativeTokens](BasicOutputBuilderParams.md#nativetokens) - ---- - -### unlockConditions - -• **unlockConditions**: `UnlockCondition`[] - -The unlock conditions for the output. - -#### Inherited from - -[BasicOutputBuilderParams](BasicOutputBuilderParams.md).[unlockConditions](BasicOutputBuilderParams.md#unlockconditions) - ---- - -### features - -• `Optional` **features**: `Feature`[] - -Features to be contained by the output. - -#### Inherited from - -[BasicOutputBuilderParams](BasicOutputBuilderParams.md).[features](BasicOutputBuilderParams.md#features) - ---- - -### serialNumber - -• **serialNumber**: `number` - -The serial number of the foundry with respect to the controlling alias. diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/GenerateAddressOptions.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/GenerateAddressOptions.md deleted file mode 100644 index 4da419a3553..00000000000 --- a/next/docs/iota-sdk/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/IAuth.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/IAuth.md deleted file mode 100644 index 5b07d5f14d0..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/IAuth.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: IAuth - -Basic Auth or JWT. diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/IBuildBlockOptions.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/IBuildBlockOptions.md deleted file mode 100644 index 3a1133145c7..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/IClientBlockBuilderOutputAddress.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/IClientBlockBuilderOutputAddress.md deleted file mode 100644 index 03304e4b96c..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/IClientBlockBuilderOutputAddress.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: IClientBlockBuilderOutputAddress - -Address with base coin amount diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/IClientOptions.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/IClientOptions.md deleted file mode 100644 index 8039fcf0926..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/IDuration.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/IDuration.md deleted file mode 100644 index 7a086f2d5c8..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/IDuration.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: IDuration - -Time duration diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/IGenerateAddressOptions.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/IGenerateAddressOptions.md deleted file mode 100644 index c8c88dd67b9..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/IGenerateAddressesOptions.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/IGenerateAddressesOptions.md deleted file mode 100644 index 37332218cbe..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/IInputSigningData.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/IInputSigningData.md deleted file mode 100644 index 61f70699806..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/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**: [`IBip32Chain`](../api_ref.md#ibip32chain) - -The chain derived from seed, only for ed25519 addresses diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/IMqttBrokerOptions.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/IMqttBrokerOptions.md deleted file mode 100644 index db292c7b346..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/INetworkInfo.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/INetworkInfo.md deleted file mode 100644 index 304087f2939..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/INode.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/INode.md deleted file mode 100644 index 8e124034c0c..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/INode.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: INode - -A node object for the client. diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/INodeInfoWrapper.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/INodeInfoWrapper.md deleted file mode 100644 index de8d2e3ba7a..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/IPreparedTransactionData.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/IPreparedTransactionData.md deleted file mode 100644 index 5ec44352d5f..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/IRange.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/IRange.md deleted file mode 100644 index 5564901414a..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/IRange.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: IRange - -A range with start and end values. diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/LedgerApp.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/LedgerApp.md deleted file mode 100644 index 047b35ab872..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/LedgerApp.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: LedgerApp - -The current opened app diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/LedgerNanoSecretManager.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/LedgerNanoSecretManager.md deleted file mode 100644 index f1d89c496a4..00000000000 --- a/next/docs/iota-sdk/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/LedgerNanoStatus.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/LedgerNanoStatus.md deleted file mode 100644 index 2db2b7b002b..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/LedgerNanoStatus.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: LedgerNanoStatus - -The status of a Ledger Nano diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/MintNftParams.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/MintNftParams.md deleted file mode 100644 index 121ce38a6dd..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/MintNftParams.md +++ /dev/null @@ -1,63 +0,0 @@ -# Interface: MintNftParams - -Nft options for minting - -## Table of contents - -### Properties - -- [address](MintNftParams.md#address) -- [sender](MintNftParams.md#sender) -- [metadata](MintNftParams.md#metadata) -- [tag](MintNftParams.md#tag) -- [issuer](MintNftParams.md#issuer) -- [immutableMetadata](MintNftParams.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/next/docs/iota-sdk/docs/references/nodejs/interfaces/MintTokenTransaction.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/MintTokenTransaction.md deleted file mode 100644 index d3c0f52bea2..00000000000 --- a/next/docs/iota-sdk/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/MnemonicSecretManager.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/MnemonicSecretManager.md deleted file mode 100644 index a0a5e97e5c7..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/MnemonicSecretManager.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: MnemonicSecretManager - -Secret manager that uses a mnemonic. diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/NativeTokenBalance.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/NativeTokenBalance.md deleted file mode 100644 index 9250f99020c..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/NativeTokenBalance.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: NativeTokenBalance - -The balance of a native token diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/NftOutputBuilderParams.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/NftOutputBuilderParams.md deleted file mode 100644 index a2f1fdd51c4..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/NftOutputBuilderParams.md +++ /dev/null @@ -1,66 +0,0 @@ -# Interface: NftOutputBuilderParams - -Options for building an Nft Output - -## Hierarchy - -- [`BasicOutputBuilderParams`](BasicOutputBuilderParams.md) - - ↳ **`NftOutputBuilderParams`** - -## Table of contents - -### Properties - -- [amount](NftOutputBuilderParams.md#amount) -- [nativeTokens](NftOutputBuilderParams.md#nativetokens) -- [unlockConditions](NftOutputBuilderParams.md#unlockconditions) -- [features](NftOutputBuilderParams.md#features) - -## Properties - -### amount - -• `Optional` **amount**: `string` - -If not provided, minimum storage deposit will be used - -#### Inherited from - -[BasicOutputBuilderParams](BasicOutputBuilderParams.md).[amount](BasicOutputBuilderParams.md#amount) - ---- - -### nativeTokens - -• `Optional` **nativeTokens**: `INativeToken`[] - -The native tokens to be held by the output. - -#### Inherited from - -[BasicOutputBuilderParams](BasicOutputBuilderParams.md).[nativeTokens](BasicOutputBuilderParams.md#nativetokens) - ---- - -### unlockConditions - -• **unlockConditions**: `UnlockCondition`[] - -The unlock conditions for the output. - -#### Inherited from - -[BasicOutputBuilderParams](BasicOutputBuilderParams.md).[unlockConditions](BasicOutputBuilderParams.md#unlockconditions) - ---- - -### features - -• `Optional` **features**: `Feature`[] - -Features to be contained by the output. - -#### Inherited from - -[BasicOutputBuilderParams](BasicOutputBuilderParams.md).[features](BasicOutputBuilderParams.md#features) diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/NftSyncOptions.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/NftSyncOptions.md deleted file mode 100644 index bb6be26b72d..00000000000 --- a/next/docs/iota-sdk/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/OutputData.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/OutputData.md deleted file mode 100644 index 52eb4bbba0c..00000000000 --- a/next/docs/iota-sdk/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/OutputIdsResponse.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/OutputIdsResponse.md deleted file mode 100644 index cd9a11c9372..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/OutputIdsResponse.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: OutputIdsResponse - -OutputIdsResponse. diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/OutputParams.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/OutputParams.md deleted file mode 100644 index 49eb533a9d5..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/OutputParams.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: OutputParams - -Options for the creation of an output diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/RequiredStorageDeposit.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/RequiredStorageDeposit.md deleted file mode 100644 index dcbb88106fa..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/RequiredStorageDeposit.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: RequiredStorageDeposit - -The required storage deposit per output type diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/SeedSecretManager.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/SeedSecretManager.md deleted file mode 100644 index 71fc7707a41..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/SeedSecretManager.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: SeedSecretManager - -Secret manager that uses a seed. diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/Segment.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/Segment.md deleted file mode 100644 index 7679cb1cae2..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/Segment.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: Segment - -A Segment of the BIP32 path diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/SendAmountParams.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/SendAmountParams.md deleted file mode 100644 index f2c8a80fd8d..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/SendAmountParams.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: SendAmountParams - -Address with a base token amount diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/SendNativeTokensParams.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/SendNativeTokensParams.md deleted file mode 100644 index 8803cc26e35..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/SendNativeTokensParams.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: SendNativeTokensParams - -Address with native tokens diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/SendNftParams.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/SendNftParams.md deleted file mode 100644 index 39d96be9eae..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/SendNftParams.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: SendNftParams - -Address with an NftId diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/SignedTransactionEssence.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/SignedTransactionEssence.md deleted file mode 100644 index 0237352ca20..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/SignedTransactionEssence.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: SignedTransactionEssence - -The signed transaction with inputs data diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/StorageDeposit.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/StorageDeposit.md deleted file mode 100644 index 98936a049ab..00000000000 --- a/next/docs/iota-sdk/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/StrongholdSecretManager.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/StrongholdSecretManager.md deleted file mode 100644 index d3e361b1b0c..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/StrongholdSecretManager.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: StrongholdSecretManager - -Secret manager that uses Stronghold. diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/SyncOptions.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/SyncOptions.md deleted file mode 100644 index 3ae8f8daf00..00000000000 --- a/next/docs/iota-sdk/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/Transaction.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/Transaction.md deleted file mode 100644 index 2a76cb78f9f..00000000000 --- a/next/docs/iota-sdk/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/TransactionOptions.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/TransactionOptions.md deleted file mode 100644 index ba24704a43e..00000000000 --- a/next/docs/iota-sdk/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/next/docs/iota-sdk/docs/references/nodejs/interfaces/Unlocks.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/Unlocks.md deleted file mode 100644 index 4f613fbbd1a..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/Unlocks.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: Unlocks - -Time unlocks to include in the output diff --git a/next/docs/iota-sdk/docs/references/nodejs/interfaces/WalletOptions.md b/next/docs/iota-sdk/docs/references/nodejs/interfaces/WalletOptions.md deleted file mode 100644 index 30e4f183f70..00000000000 --- a/next/docs/iota-sdk/docs/references/nodejs/interfaces/WalletOptions.md +++ /dev/null @@ -1,3 +0,0 @@ -# Interface: WalletOptions - -Options for the Wallet builder diff --git a/next/docs/iota-sdk/docs/references/python/iota_sdk/client/_high_level_api.md b/next/docs/iota-sdk/docs/references/python/iota_sdk/client/_high_level_api.md deleted file mode 100644 index 119b2786904..00000000000 --- a/next/docs/iota-sdk/docs/references/python/iota_sdk/client/_high_level_api.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -sidebar_label: _high_level_api -title: iota_sdk.client._high_level_api ---- - -## HighLevelAPI Objects - -```python -class HighLevelAPI() -``` - -### get_outputs - -```python -def get_outputs(output_ids: List[OutputId]) -``` - -Fetch OutputResponse from provided OutputIds (requests are sent in parallel). - -### get_outputs_ignore_errors - -```python -def get_outputs_ignore_errors(output_ids: List[OutputId]) -``` - -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: List[HexStr]) -``` - -Find all blocks by provided block IDs. - -### retry - -```python -def retry(block_id: HexStr) -``` - -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: HexStr, - interval: Optional[int] = None, - max_attempts: Optional[int] = 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: List[str], amount: int) -``` - -Function to find inputs from addresses for a provided amount (useful for offline signing) - -### find_outputs - -```python -def find_outputs(output_ids: List[OutputId], addresses: List[str]) -``` - -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: HexStr) -``` - -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: HexStr) -``` - -Reattach a block without checking if it should be reattached. - -### promote - -```python -def promote(block_id: HexStr) -``` - -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: HexStr) -``` - -Promote a block without checking if it should be promoted. diff --git a/next/docs/iota-sdk/docs/references/python/iota_sdk/client/_node_core_api.md b/next/docs/iota-sdk/docs/references/python/iota_sdk/client/_node_core_api.md deleted file mode 100644 index 2251173c8fd..00000000000 --- a/next/docs/iota-sdk/docs/references/python/iota_sdk/client/_node_core_api.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -sidebar_label: _node_core_api -title: iota_sdk.client._node_core_api ---- - -## NodeCoreAPI Objects - -```python -class NodeCoreAPI() -``` - -### get_node_health - -```python -def get_node_health(url: str) -``` - -Get node health. - -### get_node_info - -```python -def get_node_info(url: str, 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() -> List[HexStr] -``` - -Get tips. - -### post_block - -```python -def post_block(block) -``` - -Post block. - -### get_block_data - -```python -def get_block_data(block_id: HexStr) -``` - -Post block. - -### get_block_metadata - -```python -def get_block_metadata(block_id: HexStr) -``` - -Get block metadata with block_id. - -### get_block_raw - -```python -def get_block_raw(block_id: HexStr) -``` - -Get block raw. - -### post_block_raw - -```python -def post_block_raw(block_bytes) -``` - -Post block raw. - -### get_output - -```python -def get_output(output_id: OutputId) -``` - -Get output. - -### get_output_metadata - -```python -def get_output_metadata(output_id: OutputId) -``` - -Get output metadata. - -### get_milestone_by_id - -```python -def get_milestone_by_id(milestone_id: HexStr) -``` - -Get the milestone by the given milestone id. - -### get_milestone_by_id_raw - -```python -def get_milestone_by_id_raw(milestone_id: HexStr) -``` - -Get the raw milestone by the given milestone id. - -### get_milestone_by_index - -```python -def get_milestone_by_index(index: int) -``` - -Get the milestone by the given index. - -### get_milestone_by_index_raw - -```python -def get_milestone_by_index_raw(index: int) -``` - -Get the milestone by the given index. - -### get_utxo_changes_by_id - -```python -def get_utxo_changes_by_id(milestone_id: HexStr) -``` - -Get the UTXO changes by the given milestone id. - -### get_utxo_changes_by_index - -```python -def get_utxo_changes_by_index(index: int) -``` - -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: int) -``` - -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: HexStr) -``` - -Returns the included block of the transaction. - -### get_included_block_metadata - -```python -def get_included_block_metadata(transaction_id: HexStr) -``` - -Returns the metadata of the included block of the transaction. diff --git a/next/docs/iota-sdk/docs/references/python/iota_sdk/client/_node_indexer_api.md b/next/docs/iota-sdk/docs/references/python/iota_sdk/client/_node_indexer_api.md deleted file mode 100644 index cdc4dcaff20..00000000000 --- a/next/docs/iota-sdk/docs/references/python/iota_sdk/client/_node_indexer_api.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_label: _node_indexer_api -title: iota_sdk.client._node_indexer_api ---- - -## NodeIndexerAPI Objects - -```python -class NodeIndexerAPI() -``` - -### basic_output_ids - -```python -def basic_output_ids(query_parameters: QueryParameters) -> OutputIdsResponse -``` - -Fetch basic output IDs. - -### alias_output_ids - -```python -def alias_output_ids(query_parameters: QueryParameters) -> OutputIdsResponse -``` - -Fetch alias output IDs. - -### alias_output_id - -```python -def alias_output_id(alias_id: HexStr) -> OutputId -``` - -Fetch alias output ID. - -### nft_output_ids - -```python -def nft_output_ids(query_parameters: QueryParameters) -> OutputIdsResponse -``` - -Fetch NFT output IDs. - -### nft_output_id - -```python -def nft_output_id(nft_id: HexStr) -> OutputId -``` - -Fetch NFT output ID. - -### foundry_output_ids - -```python -def foundry_output_ids(query_parameters: QueryParameters) -> OutputIdsResponse -``` - -Fetch foundry Output IDs. - -### foundry_output_id - -```python -def foundry_output_id(foundry_id: HexStr) -> OutputId -``` - -Fetch foundry Output ID. diff --git a/next/docs/iota-sdk/docs/references/python/iota_sdk/client/_utils.md b/next/docs/iota-sdk/docs/references/python/iota_sdk/client/_utils.md deleted file mode 100644 index 78b8f765b89..00000000000 --- a/next/docs/iota-sdk/docs/references/python/iota_sdk/client/_utils.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -sidebar_label: _utils -title: iota_sdk.client._utils ---- - -## ClientUtils Objects - -```python -class ClientUtils() -``` - -### hex_to_bech32 - -```python -def hex_to_bech32(hex: HexStr, bech32_hrp: str) -> str -``` - -Transforms a hex encoded address to a bech32 encoded address. - -### alias_id_to_bech32 - -```python -def alias_id_to_bech32(alias_id: HexStr, bech32_hrp: str) -> str -``` - -Transforms an alias id to a bech32 encoded address. - -### nft_id_to_bech32 - -```python -def nft_id_to_bech32(nft_id: HexStr, bech32_hrp: str) -> str -``` - -Transforms an nft id to a bech32 encoded address. - -### hex_public_key_to_bech32_address - -```python -def hex_public_key_to_bech32_address(hex: HexStr, - bech32_hrp: Optional[str] = None) -> str -``` - -Transforms a hex encoded public key to a bech32 encoded address. - -### request_funds_from_faucet - -```python -def request_funds_from_faucet(url: str, address: str) -> str -``` - -Requests funds from the faucet, for example `https://faucet.testnet.shimmer.network/api/enqueue` or `http://localhost:8091/api/enqueue`. diff --git a/next/docs/iota-sdk/docs/references/python/iota_sdk/client/client.md b/next/docs/iota-sdk/docs/references/python/iota_sdk/client/client.md deleted file mode 100644 index 5cfbf70a9e8..00000000000 --- a/next/docs/iota-sdk/docs/references/python/iota_sdk/client/client.md +++ /dev/null @@ -1,356 +0,0 @@ ---- -sidebar_label: client -title: iota_sdk.client.client ---- - -## ClientError Objects - -```python -class ClientError(Exception) -``` - -client error - -## Client Objects - -```python -class Client(NodeCoreAPI, NodeIndexerAPI, HighLevelAPI, ClientUtils) -``` - -### \_\_init\_\_ - -```python -def __init__(nodes: Optional[str | List[str]] = None, - primary_node: Optional[str] = None, - primary_pow_node: Optional[str] = None, - permanode: Optional[str] = None, - ignore_node_health: Optional[bool] = None, - api_timeout: Optional[timedelta] = None, - node_sync_interval: Optional[timedelta] = None, - remote_pow_timeout: Optional[timedelta] = None, - tips_interval: Optional[int] = None, - quorum: Optional[bool] = None, - min_quorum_size: Optional[int] = None, - quorum_threshold: Optional[int] = None, - user_agent: Optional[str] = None, - local_pow: Optional[bool] = None, - fallback_to_local_pow: Optional[bool] = None, - pow_worker_count: Optional[int] = None, - client_handle=None) -``` - -Initialize the IOTA Client. - -#### Parameters - -- **nodes**_: string or array of string_ - A single Node URL or an array of URLs. -- **primary_node**_: string_ - Node which will be tried first for all requests. -- **primary_pow_node**_: string_ - Node which will be tried first when using remote PoW, even before the primary_node. -- **permanode**_: string_ - Permanode URL. -- **ignore_node_health**_: bool_ - If the node health should be ignored. -- **api_timeout**_: datetime.timedelta_ - Timeout for API requests. -- **node_sync_interval**_: datetime.timedelta_ - Interval in which nodes will be checked for their sync status and the [NetworkInfo](crate::NetworkInfo) gets updated. -- **remote_pow_timeout**_: datetime.timedelta_ - Timeout when sending a block that requires remote proof of work. -- **tips_interval**_: int_ - Tips request interval during PoW in seconds. -- **quorum**_: bool_ - 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. -- **min_quorum_size**_: int_ - Minimum amount of nodes required for request when quorum is enabled. -- **quorum_threshold**_: int_ - % of nodes that have to return the same response so it gets accepted. -- **user_agent**_: string_ - The User-Agent header for requests. -- **local_pow**_: bool_ - Local proof of work. -- **fallback_to_local_pow**_: bool_ - Fallback to local proof of work if the node doesn't support remote PoW. -- **pow_worker_count**_: int_ - The amount of threads to be used for proof of work. - -### build_alias_output - -```python -def build_alias_output(alias_id: HexStr, - unlock_conditions: List[UnlockCondition], - amount: Optional[int] = None, - native_tokens: Optional[List[NativeToken]] = None, - state_index: Optional[int] = None, - state_metadata: Optional[str] = None, - foundry_counter: Optional[int] = None, - features: Optional[List[Feature]] = None, - immutable_features: Optional[List[Feature]] = None) -``` - -Build an AliasOutput. - -#### Parameters - -- **alias_id**_: string_ - Hex encoded alias id -- **unlock_conditions**_: array of UnlockCondition_ - The unlock conditions for this output -- **amount**_: int_ - Amount of base token -- **native_tokens**_: array of NativeToken_ - The native token to add to the output -- **state_index**_: int_ - Index of the state -- **state_metadata**_: string_ - Hex encoded state metadata -- **foundry_counter**_: int_ - Counter of foundry outputs created -- **features**_: array of Feature_ - Features for this outputs -- **immutable_features**_: array of Feature_ - Immutable features - -#### Returns - -Output as dict - -### build_basic_output - -```python -def build_basic_output(unlock_conditions: List[UnlockCondition], - amount: Optional[int] = None, - native_tokens: Optional[List[NativeToken]] = None, - features: Optional[List[Feature]] = None) -``` - -Build a BasicOutput. - -#### Parameters - -- **unlock_conditions**_: array of UnlockCondition_ - The unlock conditions for this output -- **amount**_: int_ - Amount of base token -- **native_tokens**_: array of NativeToken_ - The native token to add to the output -- **features**_: array of Feature_ - Features for this outputs - -#### Returns - -Output as dict - -### build_foundry_output - -```python -def build_foundry_output(serial_number: int, - token_scheme: TokenScheme, - unlock_conditions: List[UnlockCondition], - amount: Optional[int] = None, - native_tokens: Optional[List[NativeToken]] = None, - features: Optional[List[Feature]] = None, - immutable_features: Optional[List[Feature]] = None) -``` - -Build a FoundryOutput. - -#### Parameters - -- **serial_number**_: int_ - The serial number of the foundry -- **token_scheme**_: TokenScheme_ - The Token scheme. Currently only a simple scheme is supported -- **unlock_conditions**_: array of UnlockCondition_ - The unlock conditions for this output -- **amount**_: int_ - Amount of base token -- **native_tokens**_: array of NativeToken_ - The native token to add to the output -- **features**_: array of Feature_ - Features for this outputs -- **immutable_features**_: array of Feature_ - Immutable features - -#### Returns - -Output as dict - -### build_nft_output - -```python -def build_nft_output(nft_id: HexStr, - unlock_conditions: List[UnlockCondition], - amount: Optional[int] = None, - native_tokens: Optional[List[NativeToken]] = None, - features: Optional[List[Feature]] = None, - immutable_features: Optional[List[Feature]] = None) -``` - -Build an NftOutput. - -#### Parameters - -- **nft_id**_: string_ - Hex encoded nft id -- **unlock_conditions**_: array of UnlockCondition_ - The unlock conditions for this output -- **amount**_: int_ - Amount of base token -- **native_tokens**_: array of NativeToken_ - The native tokens to add to the output -- **features**_: array of Feature_ - Features for this outputs -- **immutable_features**_: array of Feature_ - Immutable features - -#### Returns - -Output as dict - -### build_and_post_block - -```python -def build_and_post_block(secret_manager=None, - account_index: Optional[int] = None, - coin_type: Optional[int] = None, - custom_remainder_address: Optional[str] = None, - data: Optional[HexStr] = None, - initial_address_index: Optional[int] = None, - input_range_start: Optional[int] = None, - input_range_end: Optional[int] = None, - inputs: Optional[List[Dict[str, Any]]] = None, - output: Optional[Dict[str, Any]] = None, - outputs: Optional[List[Any]] = None, - tag: Optional[HexStr] = None) -``` - -Build and post a block. - -#### Parameters - -- **account_index**_: int_ - Account Index -- **coin_type**_: int_ - Coin type. The CoinType enum can be used -- **custom_remainder_address**_: string_ - Address to send the remainder funds to -- **data**_: str_ - Hex encoded data -- **initial_address_index**_: int_ - Initial address index -- **input_range_start**_: int_ - Start of the input range -- **input_range_end**_: int_ - End of the input range -- **inputs**_: Array of Inputs_ - Inputs to use -- **output**_: SendAmountParams_ - Address and amount to send to -- **outputs**_: Array of Outputs_ - Outputs to use -- **tag**_: string_ - Hex encoded tag - -#### Returns - -Block as dict - -### get_node - -```python -def get_node() -> Dict[str, Any] -``` - -Get a node candidate from the healthy node pool. - -### get_network_info - -```python -def get_network_info() -> Dict[str, Any] -``` - -Gets the network related information such as network_id and min_pow_score. - -### get_network_id - -```python -def get_network_id() -> int -``` - -Gets the network id of the node we're connecting to. - -### get_bech32_hrp - -```python -def get_bech32_hrp() -> str -``` - -Returns the bech32_hrp. - -### get_min_pow_score - -```python -def get_min_pow_score() -> int -``` - -Returns the min pow score. - -### get_tips_interval - -```python -def get_tips_interval() -> int -``` - -Returns the tips interval. - -### get_local_pow - -```python -def get_local_pow() -> bool -``` - -Returns if local pow should be used or not. - -### get_fallback_to_local_pow - -```python -def get_fallback_to_local_pow() -> bool -``` - -Get fallback to local proof of work timeout. - -### unhealthy_nodes - -```python -def unhealthy_nodes() -> List[Dict[str, Any]] -``` - -Returns the unhealthy nodes. - -### 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. - -### submit_payload - -```python -def submit_payload(payload) -``` - -Submit a payload in a block. diff --git a/next/docs/iota-sdk/docs/references/python/iota_sdk/secret_manager/secret_manager.md b/next/docs/iota-sdk/docs/references/python/iota_sdk/secret_manager/secret_manager.md deleted file mode 100644 index fbb21fb6945..00000000000 --- a/next/docs/iota-sdk/docs/references/python/iota_sdk/secret_manager/secret_manager.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -sidebar_label: secret_manager -title: iota_sdk.secret_manager.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. - -## SecretManagerError Objects - -```python -class SecretManagerError(Exception) -``` - -secret manager error - -## SecretManager Objects - -```python -class SecretManager() -``` - -### generate_ed25519_addresses - -```python -def generate_ed25519_addresses(account_index: Optional[int] = None, - start: Optional[int] = None, - end: Optional[int] = None, - internal: Optional[bool] = None, - coin_type: Optional[int] = None, - bech32_hrp: Optional[str] = None, - ledger_nano_prompt: Optional[bool] = None) -``` - -Generate ed25519 addresses. - -#### Parameters - -- **account_index**_: int_ - Account index. -- **start**_: int_ - Start index of generated addresses -- **end**_: int_ - End index of generated addresses -- **internal**_: bool_ - Internal addresses -- **coin_type**_: int_ - Coin type. The CoinType enum can be used -- **bech32_hrp**_: string_ - Bech32 human readable part. -- **ledger_nano_prompt**_: bool_ - Display the address on ledger devices. - -#### Returns - -Addresses as array of strings. - -### generate_evm_addresses - -```python -def generate_evm_addresses(account_index=None, - start=None, - end=None, - internal=None, - coin_type=None, - ledger_nano_prompt=None) -``` - -Generate EVM addresses. - -#### Parameters - -- **account_index**_: int_ - Account index. -- **start**_: int_ - Start index of generated addresses -- **end**_: int_ - End index of generated addresses -- **internal**_: bool_ - Internal addresses -- **coin_type**_: int_ - Coin type. The CoinType enum can be used -- **ledger_nano_prompt**_: bool_ - Display the address on ledger devices. - -#### Returns - -Addresses as array of strings. - -### get_ledger_nano_status - -```python -def get_ledger_nano_status() -``` - -Returns the Ledger Status. - -### store_mnemonic - -```python -def store_mnemonic(mnemonic: str) -``` - -Store a mnemonic in the Stronghold vault. - -### sign_ed25519 - -```python -def sign_ed25519(message: HexStr, chain: List[int]) -``` - -Signs a message with an Ed25519 private key. - -### sign_secp256k1_ecdsa - -```python -def sign_secp256k1_ecdsa(message: HexStr, chain: List[int]) -``` - -Signs a message with an Secp256k1Ecdsa private key. - -### sign_transaction - -```python -def sign_transaction(prepared_transaction_data) -``` - -Sign a transaction. - -### signature_unlock - -```python -def signature_unlock(transaction_essence_hash: HexStr, chain: List[int]) -``` - -Sign a transaction essence hash. diff --git a/next/docs/iota-sdk/docs/references/python/iota_sdk/types/address.md b/next/docs/iota-sdk/docs/references/python/iota_sdk/types/address.md deleted file mode 100644 index 382a81faa07..00000000000 --- a/next/docs/iota-sdk/docs/references/python/iota_sdk/types/address.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -sidebar_label: address -title: iota_sdk.types.address ---- - -## Address Objects - -```python -class Address() -``` - -### \_\_init\_\_ - -```python -def __init__(type: AddressType, address_or_id: HexStr) -``` - -Initialize an Address - -#### Parameters - -- **type**_: AddressType_ - The type of the Address -- **address_or_id**_: string_ - The address to use. Can either be an hex encoded ED25519 address or NFT/Alias id - -## Ed25519Address Objects - -```python -class Ed25519Address(Address) -``` - -### \_\_init\_\_ - -```python -def __init__(address: HexStr) -``` - -Initialize an Ed25519Address - -#### Parameters - -- **address**_: string_ - The hex encoded address to use. - -## AliasAddress Objects - -```python -class AliasAddress(Address) -``` - -### \_\_init\_\_ - -```python -def __init__(address_or_id: HexStr) -``` - -Initialize an AliasAddress - -#### Parameters - -- **address_or_id**_: string_ - The hex encoded address to use. - -## NFTAddress Objects - -```python -class NFTAddress(Address) -``` - -### \_\_init\_\_ - -```python -def __init__(address_or_id: HexStr) -``` - -Initialize an NFTokenAddress - -#### Parameters - -- **address_or_id**_: string_ - The hex encoded address to use. diff --git a/next/docs/iota-sdk/docs/references/python/iota_sdk/types/burn.md b/next/docs/iota-sdk/docs/references/python/iota_sdk/types/burn.md deleted file mode 100644 index 66e7d6bef88..00000000000 --- a/next/docs/iota-sdk/docs/references/python/iota_sdk/types/burn.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -sidebar_label: burn -title: iota_sdk.types.burn ---- - -## Burn Objects - -```python -@dataclass -class Burn() -``` - -A DTO for [`Burn`] - -**Arguments**: - ---- - -- `aliases` - Optional[List[str]] - The aliases (hex encoded) to burn -- `nfts` - Optional[List[str]] - The NFTs (hex encoded) to burn -- `foundries` - Optional[List[str]] - The foundries (hex encoded) to burn -- `nativeTokens` - Optional[List[NativeToken]] - The native tokens to burn diff --git a/next/docs/iota-sdk/docs/references/python/iota_sdk/types/common.md b/next/docs/iota-sdk/docs/references/python/iota_sdk/types/common.md deleted file mode 100644 index 6db6f0ebbd6..00000000000 --- a/next/docs/iota-sdk/docs/references/python/iota_sdk/types/common.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -sidebar_label: common -title: iota_sdk.types.common ---- - -## Node Objects - -```python -class Node() -``` - -### \_\_init\_\_ - -```python -def __init__(url=None, jwt=None, username=None, password=None, disabled=None) -``` - -Initialize a Node - -#### Parameters - -- **url**_: string_ - Node url -- **jwt**_: string_ - JWT token -- **username**_: string_ - Username for basic authentication -- **password**_: string_ - Password for basic authentication -- **disabled**_: bool_ - Disable node - -## SendAmountParams Objects - -```python -class SendAmountParams() -``` - -### \_\_init\_\_ - -```python -def __init__(address, amount) -``` - -Initialise SendAmountParams - -#### Parameters - -- **address**_: string_ - Address of the output -- **amount**_: int_ - Amount of the output diff --git a/next/docs/iota-sdk/docs/references/python/iota_sdk/types/feature.md b/next/docs/iota-sdk/docs/references/python/iota_sdk/types/feature.md deleted file mode 100644 index 3a247e83860..00000000000 --- a/next/docs/iota-sdk/docs/references/python/iota_sdk/types/feature.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -sidebar_label: feature -title: iota_sdk.types.feature ---- - -## Feature Objects - -```python -class Feature() -``` - -### \_\_init\_\_ - -```python -def __init__(type, sender=None, issuer=None, data=None, tag=None) -``` - -Initialize a feature - -#### Parameters - -- **type**_: FeatureType_ - The type of feature -- **sender**_: Address_ - Sender address -- **issuer**_: Address_ - Issuer Address -- **data**_: string_ - Hex encoded metadata -- **tag**_: string_ - Hex encoded tag used to index the output - -## SenderFeature Objects - -```python -class SenderFeature(Feature) -``` - -### \_\_init\_\_ - -```python -def __init__(sender) -``` - -Initialize a SenderFeature - -#### Parameters - -- **sender**_: Address_ - Sender address - -## IssuerFeature Objects - -```python -class IssuerFeature(Feature) -``` - -### \_\_init\_\_ - -```python -def __init__(issuer) -``` - -Initialize an IssuerFeature - -#### Parameters - -- **issuer**_: Address_ - Issuer address - -## MetadataFeature Objects - -```python -class MetadataFeature(Feature) -``` - -### \_\_init\_\_ - -```python -def __init__(data: HexStr) -``` - -Initialize a MetadataFeature - -#### Parameters - -- **data**_: HexStr_ - Hex encoded metadata - -## TagFeature Objects - -```python -class TagFeature(Feature) -``` - -### \_\_init\_\_ - -```python -def __init__(tag: HexStr) -``` - -Initialize a TagFeature - -#### Parameters - -- **tag**_: HexStr_ - Hex encoded tag used to index the output diff --git a/next/docs/iota-sdk/docs/references/python/iota_sdk/types/native_token.md b/next/docs/iota-sdk/docs/references/python/iota_sdk/types/native_token.md deleted file mode 100644 index a6db0bdcc69..00000000000 --- a/next/docs/iota-sdk/docs/references/python/iota_sdk/types/native_token.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -sidebar_label: native_token -title: iota_sdk.types.native_token ---- - -## NativeToken Objects - -```python -class NativeToken() -``` - -### \_\_init\_\_ - -```python -def __init__(id: HexStr, amount: int) -``` - -Initialize NativeToken - -#### Parameters - -- **id**_: string_ - Id of the token -- **amount**_: int_ - Native token amount diff --git a/next/docs/iota-sdk/docs/references/python/iota_sdk/types/output_id.md b/next/docs/iota-sdk/docs/references/python/iota_sdk/types/output_id.md deleted file mode 100644 index 5c02ddee01a..00000000000 --- a/next/docs/iota-sdk/docs/references/python/iota_sdk/types/output_id.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -sidebar_label: output_id -title: iota_sdk.types.output_id ---- - -## OutputId Objects - -```python -class OutputId() -``` - -### \_\_init\_\_ - -```python -def __init__(transaction_id: HexStr, output_index: int) -``` - -Initialize OutputId diff --git a/next/docs/iota-sdk/docs/references/python/iota_sdk/types/signature.md b/next/docs/iota-sdk/docs/references/python/iota_sdk/types/signature.md deleted file mode 100644 index 518affd464a..00000000000 --- a/next/docs/iota-sdk/docs/references/python/iota_sdk/types/signature.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -sidebar_label: signature -title: iota_sdk.types.signature ---- - -## Ed25519Signature Objects - -```python -class Ed25519Signature() -``` - -### \_\_init\_\_ - -```python -def __init__(public_key: HexStr, signature: HexStr) -``` - -Initialize an Ed25519Signature diff --git a/next/docs/iota-sdk/docs/references/python/iota_sdk/types/token_scheme.md b/next/docs/iota-sdk/docs/references/python/iota_sdk/types/token_scheme.md deleted file mode 100644 index d7611899495..00000000000 --- a/next/docs/iota-sdk/docs/references/python/iota_sdk/types/token_scheme.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -sidebar_label: token_scheme -title: iota_sdk.types.token_scheme ---- - -## TokenScheme Objects - -```python -class TokenScheme() -``` - -### \_\_init\_\_ - -```python -def __init__(minted_tokens=None, melted_tokens=None, maximum_supply=None) -``` - -Initialize TokenScheme - -#### Parameters - -- **minted_tokens**_: int_ -- **melted_tokens**_: int_ -- **maximum_supply**_: int_ diff --git a/next/docs/iota-sdk/docs/references/python/iota_sdk/types/unlock_condition.md b/next/docs/iota-sdk/docs/references/python/iota_sdk/types/unlock_condition.md deleted file mode 100644 index 798dde85f24..00000000000 --- a/next/docs/iota-sdk/docs/references/python/iota_sdk/types/unlock_condition.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -sidebar_label: unlock_condition -title: iota_sdk.types.unlock_condition ---- - -## UnlockCondition Objects - -```python -class UnlockCondition() -``` - -### \_\_init\_\_ - -```python -def __init__(type=None, - address=None, - amount=None, - unix_time=None, - return_address=None) -``` - -Initialize an UnlockCondition - -#### Parameters - -- **type**_: UnlockConditionType_ - The type of unlock condition -- **address**_: Address_ - Address for unlock condition -- **amount**_: int_ - Amount for storage deposit unlock condition -- **unix_time**_: int_ - Unix timestamp for timelock and expiration unlock condition -- **return_address**_: Address_ - Return address for expiration and storage deposit unlock condition - -## AddressUnlockCondition Objects - -```python -class AddressUnlockCondition(UnlockCondition) -``` - -### \_\_init\_\_ - -```python -def __init__(address) -``` - -Initialize an AddressUnlockCondition - -#### Parameters - -- **address**_: Address_ - Address - -## StorageDepositReturnUnlockCondition Objects - -```python -class StorageDepositReturnUnlockCondition(UnlockCondition) -``` - -### \_\_init\_\_ - -```python -def __init__(amount, return_address) -``` - -Initialize a StorageDepositReturnUnlockCondition - -#### Parameters - -- **amount**_: int_ - Amount -- **return_address**_: Address_ - Return address - -## TimelockUnlockCondition Objects - -```python -class TimelockUnlockCondition(UnlockCondition) -``` - -### \_\_init\_\_ - -```python -def __init__(unix_time) -``` - -Initialize a TimelockUnlockCondition - -#### Parameters - -- **unix_time**_: int_ - Unix timestamp at which to unlock output - -## ExpirationUnlockCondition Objects - -```python -class ExpirationUnlockCondition(UnlockCondition) -``` - -### \_\_init\_\_ - -```python -def __init__(unix_time, return_address) -``` - -Initialize an ExpirationUnlockCondition - -#### Parameters - -- **unix_time**_: int_ - Unix timestamp -- **return_address**_: Address_ - Return address - -## StateControllerAddressUnlockCondition Objects - -```python -class StateControllerAddressUnlockCondition(UnlockCondition) -``` - -### \_\_init\_\_ - -```python -def __init__(address) -``` - -Initialize a StateControllerAddressUnlockCondition - -#### Parameters - -- **address**_: Address_ - Address for unlock condition - -## GovernorAddressUnlockCondition Objects - -```python -class GovernorAddressUnlockCondition(UnlockCondition) -``` - -### \_\_init\_\_ - -```python -def __init__(address) -``` - -Initialize a GovernorAddressUnlockCondition - -#### Parameters - -- **address**_: Address_ - Address for unlock condition - -## ImmutableAliasAddressUnlockCondition Objects - -```python -class ImmutableAliasAddressUnlockCondition(UnlockCondition) -``` - -### \_\_init\_\_ - -```python -def __init__(address) -``` - -Initialize an ImmutableAliasAddressUnlockCondition - -#### Parameters - -- **address**_: Address_ - Address for unlock condition diff --git a/next/docs/iota-sdk/docs/references/python/iota_sdk/utils.md b/next/docs/iota-sdk/docs/references/python/iota_sdk/utils.md deleted file mode 100644 index 168808afbca..00000000000 --- a/next/docs/iota-sdk/docs/references/python/iota_sdk/utils.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -sidebar_label: utils -title: iota_sdk.utils ---- - -## Utils Objects - -```python -class Utils() -``` - -### bech32_to_hex - -```python -@staticmethod -def bech32_to_hex(bech32: str) -> HexStr -``` - -Transforms bech32 to hex. - -### hex_to_bech32 - -```python -@staticmethod -def hex_to_bech32(hex: HexStr, bech32_hrp: str) -> str -``` - -Transforms a hex encoded address to a bech32 encoded address. - -### alias_id_to_bech32 - -```python -@staticmethod -def alias_id_to_bech32(alias_id: HexStr, bech32_hrp: str) -> str -``` - -Transforms an alias id to a bech32 encoded address. - -### nft_id_to_bech32 - -```python -@staticmethod -def nft_id_to_bech32(nft_id: HexStr, bech32_hrp: str) -> str -``` - -Transforms an nft id to a bech32 encoded address. - -### hex_public_key_to_bech32_address - -```python -@staticmethod -def hex_public_key_to_bech32_address(hex: HexStr, bech32_hrp: str) -> str -``` - -Transforms a hex encoded public key to a bech32 encoded address. - -### parse_bech32_address - -```python -@staticmethod -def parse_bech32_address(address: str) -> Dict[str, Any] -``` - -Returns a valid Address parsed from a String. - -### is_address_valid - -```python -@staticmethod -def is_address_valid(address: str) -> bool -``` - -Checks if a String is a valid bech32 encoded address. - -### generate_mnemonic - -```python -@staticmethod -def generate_mnemonic() -> str -``` - -Generates a new mnemonic. - -### mnemonic_to_hex_seed - -```python -@staticmethod -def mnemonic_to_hex_seed(mnemonic: HexStr) -> HexStr -``` - -Returns a hex encoded seed for a mnemonic. - -### compute_alias_id - -```python -@staticmethod -def compute_alias_id(output_id: OutputId) -> HexStr -``` - -Computes the alias id for the given alias output id. - -### compute_nft_id - -```python -@staticmethod -def compute_nft_id(output_id: OutputId) -> HexStr -``` - -Computes the NFT id for the given NFT output id. - -### compute_foundry_id - -```python -@staticmethod -def compute_foundry_id(alias_address: str, serial_number: int, - token_scheme_kind: int) -> HexStr -``` - -Computes the foundry id. - -### block_id - -```python -@staticmethod -def block_id(block) -> HexStr -``` - -Returns a block ID (Blake2b256 hash of block bytes) from a block. - -### hash_transaction_essence - -```python -@staticmethod -def hash_transaction_essence(essence) -> HexStr -``` - -Compute the hash of a transaction essence. - -### verify_ed25519_signature - -```python -@staticmethod -def verify_ed25519_signature(signature: Ed25519Signature, - message: HexStr) -> bool -``` - -Verifies an ed25519 signature against a message. - -### verify_secp256k1_ecdsa_signature - -```python -@staticmethod -def verify_secp256k1_ecdsa_signature(public_key: HexStr, signature: HexStr, - message: HexStr) -> bool -``` - -Verifies a Secp256k1Ecdsa signature against a message. - -## UtilsError Objects - -```python -class UtilsError(Exception) -``` - -utils error diff --git a/next/docs/iota-sdk/docs/references/python/iota_sdk/wallet/account.md b/next/docs/iota-sdk/docs/references/python/iota_sdk/wallet/account.md deleted file mode 100644 index ecebc1903da..00000000000 --- a/next/docs/iota-sdk/docs/references/python/iota_sdk/wallet/account.md +++ /dev/null @@ -1,343 +0,0 @@ ---- -sidebar_label: account -title: iota_sdk.wallet.account ---- - -## Account Objects - -```python -class Account() -``` - -### prepare_burn - -```python -def prepare_burn(burn: Burn, options=None) -``` - -A generic `prepare_burn()` function that can be used to prepare the burn of native tokens, nfts, foundries and aliases. - -### prepare_burn_native_token - -```python -def prepare_burn_native_token(token_id: HexStr, - burn_amount: int, - 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. - -### prepare_burn_nft - -```python -def prepare_burn_nft(nft_id: HexStr, options=None) -``` - -Burn an nft output. - -### prepare_consolidate_outputs - -```python -def prepare_consolidate_outputs( - force: bool, output_consolidation_threshold: Optional[int] = None) -``` - -Consolidate outputs. - -### prepare_create_alias_output - -```python -def prepare_create_alias_output(params, options) -``` - -Create an alias output. - -### prepare_destroy_alias - -```python -def prepare_destroy_alias(alias_id: HexStr, options=None) -``` - -Destroy an alias output. - -### prepare_destroy_foundry - -```python -def prepare_destroy_foundry(foundry_id: HexStr, options=None) -``` - -Destroy a foundry output with a circulating supply of 0. - -### generate_ed25519_addresses - -```python -def generate_ed25519_addresses(amount: int, options=None) -``` - -Generate new addresses. - -### claimable_outputs - -```python -def claimable_outputs(outputs_to_claim: List[OutputId]) -``` - -Get outputs with additional unlock conditions. - -### get_output - -```python -def get_output(output_id: OutputId) -``` - -Get output. - -### get_transaction - -```python -def get_transaction(transaction_id: HexStr) -``` - -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. - -### prepare_create_native_token - -```python -def prepare_create_native_token(params, options=None) -``` - -Create a native token. - -### prepare_melt_native_token - -```python -def prepare_melt_native_token(token_id: HexStr, - melt_amount: int, - options=None) -``` - -Melt native tokens. This happens with the foundry output which minted them, by increasing it's -`melted_tokens` field. - -### prepare_mint_native_token - -```python -def prepare_mint_native_token(token_id: HexStr, - mint_amount: int, - options=None) -``` - -Mint additional native tokens. - -### minimum_required_storage_deposit - -```python -def minimum_required_storage_deposit(output) -``` - -Minimum required storage deposit. - -### prepare_mint_nfts - -```python -def prepare_mint_nfts(params, options=None) -``` - -Mint nfts. - -### get_balance - -```python -def get_balance() -``` - -Get account balance information. - -### prepare_output - -```python -def prepare_output(output_options, transaction_options=None) -``` - -Prepare an output for sending -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 nft output will be used, just with the address -unlock conditions replaced - -### prepare_send_amount - -```python -def prepare_send_amount(params, 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: HexStr, - 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. -A custom default can be set using set_default_sync_options - -### send_amount - -```python -def send_amount(params, options=None) -``` - -Send amount. - -### prepare_send_native_tokens - -```python -def prepare_send_native_tokens(params, options=None) -``` - -Send native tokens. - -### prepare_send_nft - -```python -def prepare_send_nft(params, options=None) -``` - -Send nft. - -### set_alias - -```python -def set_alias(alias: str) -``` - -Set alias. - -### set_default_sync_options - -```python -def set_default_sync_options(options) -``` - -Set the fallback SyncOptions for account syncing. -If storage is enabled, will persist during restarts. - -### sign_transaction_essence - -```python -def sign_transaction_essence(prepared_transaction_data) -``` - -Sign a transaction essence. - -### sign_and_submit_transaction - -```python -def sign_and_submit_transaction(prepared_transaction_data) -``` - -Validate the transaction, sign it, submit it to a node and store it in the account. - -### 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: List[OutputId]) -``` - -Claim outputs. - -### send_outputs - -```python -def send_outputs(outputs, options=None) -``` - -Send outputs in a transaction. diff --git a/next/docs/iota-sdk/docs/references/python/iota_sdk/wallet/common.md b/next/docs/iota-sdk/docs/references/python/iota_sdk/wallet/common.md deleted file mode 100644 index 22b7af8594c..00000000000 --- a/next/docs/iota-sdk/docs/references/python/iota_sdk/wallet/common.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -sidebar_label: common -title: iota_sdk.wallet.common ---- - -## WalletError Objects - -```python -class WalletError(Exception) -``` - -wallet error diff --git a/next/docs/iota-sdk/docs/references/python/iota_sdk/wallet/prepared_transaction_data.md b/next/docs/iota-sdk/docs/references/python/iota_sdk/wallet/prepared_transaction_data.md deleted file mode 100644 index b512ae177b8..00000000000 --- a/next/docs/iota-sdk/docs/references/python/iota_sdk/wallet/prepared_transaction_data.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -sidebar_label: prepared_transaction_data -title: iota_sdk.wallet.prepared_transaction_data ---- - -## PreparedTransactionData Objects - -```python -class PreparedTransactionData() -``` - -### \_\_init\_\_ - -```python -def __init__(account, prepared_transaction_data) -``` - -Helper struct for offline signing - -#### Parameters - -- **account**_: account object_ - An account object used to continue building this transaction. -- **prepared_transaction_data**_: dict of prepared data_ - The data of a prepared transaction object - -## PreparedCreateTokenTransaction Objects - -```python -class PreparedCreateTokenTransaction(PreparedTransactionData) -``` - -The function returns the token_id as a string. - -**Returns**: - -The token id of the PreparedCreateTokenTransaction. diff --git a/next/docs/iota-sdk/docs/references/python/iota_sdk/wallet/wallet.md b/next/docs/iota-sdk/docs/references/python/iota_sdk/wallet/wallet.md deleted file mode 100644 index d3d521f5b97..00000000000 --- a/next/docs/iota-sdk/docs/references/python/iota_sdk/wallet/wallet.md +++ /dev/null @@ -1,236 +0,0 @@ ---- -sidebar_label: wallet -title: iota_sdk.wallet.wallet ---- - -## Wallet Objects - -```python -class Wallet() -``` - -### \_\_init\_\_ - -```python -def __init__( - storage_path: Optional[str] = None, - client_options: Optional[Dict[str, Any]] = None, - coin_type: Optional[int] = None, - secret_manager: Optional[LedgerNanoSecretManager | MnemonicSecretManager - | StrongholdSecretManager] = None) -``` - -Initialize the IOTA Wallet. - -### create_account - -```python -def create_account(alias: Optional[str] = None, - bech32_hrp: Optional[str] = None) -``` - -Create a new account - -### get_account - -```python -def get_account(account_id: str | int) -> Account -``` - -Get the account instance - -### get_client - -```python -def get_client() -``` - -Get the client instance - -### get_secret_manager - -```python -def get_secret_manager() -``` - -Get the secret manager instance - -### get_account_data - -```python -def get_account_data(account_id: str | int) -``` - -Get account data - -### get_accounts - -```python -def get_accounts() -``` - -Get accounts - -### backup - -```python -def backup(destination: str, password: str) -``` - -Backup storage. - -### change_stronghold_password - -```python -def change_stronghold_password(password: str) -``` - -Change stronghold password. - -### clear_stronghold_password - -```python -def clear_stronghold_password() -``` - -Clear stronghold password. - -### is_stronghold_password_available - -```python -def is_stronghold_password_available() -> bool -``` - -Is stronghold password available. - -### recover_accounts - -```python -def recover_accounts(account_start_index: int, - account_gap_limit: int, - address_gap_limit: int, - sync_options: Optional[Any] = None) -``` - -Recover accounts. - -### remove_latest_account - -```python -def remove_latest_account() -``` - -Remove latest account. - -### restore_backup - -```python -def restore_backup(source: str, password: str) -``` - -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() -> str -``` - -Generates a new mnemonic. - -### verify_mnemonic - -```python -def verify_mnemonic(mnemonic: str) -``` - -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_ed25519_address - -```python -def generate_ed25519_address(account_index: int, - internal: bool, - address_index: int, - options=None, - bech32_hrp: Optional[str] = None) -> List[str] -``` - -Generate an address without storing it. - -### set_stronghold_password - -```python -def set_stronghold_password(password: str) -``` - -Set stronghold password. - -### set_stronghold_password_clear_interval - -```python -def set_stronghold_password_clear_interval(interval_in_milliseconds: int) -``` - -Set stronghold password clear interval. - -### store_mnemonic - -```python -def store_mnemonic(mnemonic: str) -``` - -Store mnemonic. - -### start_background_sync - -```python -def start_background_sync(options, interval_in_milliseconds: int) -``` - -Start background sync. - -### stop_background_sync - -```python -def stop_background_sync() -``` - -Stop background syncing. - -### listen - -```python -def listen(handler, events: Optional[List[str]] = 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: Optional[List[str]] = None) -``` - -Remove wallet event listeners, empty array or None will remove all listeners -The default value for events is None - -### destroy - -```python -def destroy() -``` - -Destroys the wallet instance. diff --git a/next/docs/iota-sdk/docs/references/python/sidebar.json b/next/docs/iota-sdk/docs/references/python/sidebar.json deleted file mode 100644 index 6a30a47190a..00000000000 --- a/next/docs/iota-sdk/docs/references/python/sidebar.json +++ /dev/null @@ -1,54 +0,0 @@ -{ - "items": [ - { - "items": [ - { - "items": [ - "references/python/iota_sdk/client/_high_level_api", - "references/python/iota_sdk/client/_node_core_api", - "references/python/iota_sdk/client/_node_indexer_api", - "references/python/iota_sdk/client/_utils", - "references/python/iota_sdk/client/client" - ], - "label": "iota_sdk.client", - "type": "category" - }, - { - "items": ["references/python/iota_sdk/secret_manager/secret_manager"], - "label": "iota_sdk.secret_manager", - "type": "category" - }, - { - "items": [ - "references/python/iota_sdk/types/address", - "references/python/iota_sdk/types/burn", - "references/python/iota_sdk/types/common", - "references/python/iota_sdk/types/feature", - "references/python/iota_sdk/types/native_token", - "references/python/iota_sdk/types/output_id", - "references/python/iota_sdk/types/signature", - "references/python/iota_sdk/types/token_scheme", - "references/python/iota_sdk/types/unlock_condition" - ], - "label": "iota_sdk.types", - "type": "category" - }, - { - "items": [ - "references/python/iota_sdk/wallet/account", - "references/python/iota_sdk/wallet/common", - "references/python/iota_sdk/wallet/prepared_transaction_data", - "references/python/iota_sdk/wallet/wallet" - ], - "label": "iota_sdk.wallet", - "type": "category" - }, - "references/python/iota_sdk/utils" - ], - "label": "iota_sdk", - "type": "category" - } - ], - "label": "Reference", - "type": "category" -} diff --git a/next/docs/iota-sdk/docs/references/wasm-api-reference.md b/next/docs/iota-sdk/docs/references/wasm-api-reference.md index c9fe787acfe..0964960123e 100644 --- a/next/docs/iota-sdk/docs/references/wasm-api-reference.md +++ b/next/docs/iota-sdk/docs/references/wasm-api-reference.md @@ -1,3 +1,3 @@ # Wasm API Reference -Please refer to the [Node.js API reference](nodejs/api_ref.md). +Please refer to the [Node.js API reference](./nodejs/api_ref.md). diff --git a/next/docs/iota-sdk/sidebars.js b/next/docs/iota-sdk/sidebars.js index a42025dc9b2..95ecb30e0b3 100644 --- a/next/docs/iota-sdk/sidebars.js +++ b/next/docs/iota-sdk/sidebars.js @@ -9,6 +9,74 @@ Create as many sidebars as you want. */ +const fs = require('fs'); + +function directoryExists(path) { + try { + return fs.statSync(path).isDirectory(); + } catch (err) { + return false; + } +} + +var python_references = {}; +if (directoryExists(__dirname + '/docs/references/python')) { + python_references = { + type: 'category', + label: 'Python', + items: [ + { + type: 'autogenerated', + dirName: 'references/python/iota_sdk', + }, + ], + }; +} + +var nodejs_references = {}; +if (directoryExists(__dirname + '/docs/references/nodejs')) { + nodejs_references = { + type: 'category', + label: 'Node.js', + items: [ + { + type: 'doc', + id: 'references/nodejs/api_ref', + }, + { + 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', + }, + ], + }, + ], + }; +} + module.exports = { docs: [ { @@ -168,55 +236,12 @@ module.exports = { id: 'references/rust-api-reference', label: 'Rust', }, + nodejs_references, + python_references, { - type: 'category', - label: 'Node.js', - items: [ - { - type: 'doc', - id: 'references/nodejs/api_ref', - }, - { - 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: 'Python', - items: [ - { - type: 'autogenerated', - dirName: 'references/python/iota_sdk', - }, - ], + type: 'doc', + id: 'references/wasm-api-reference', + label: 'WASM', }, ], }, diff --git a/scripts/gen_iota_references.sh b/scripts/gen_iota_references.sh new file mode 100755 index 00000000000..a3bb80fa087 --- /dev/null +++ b/scripts/gen_iota_references.sh @@ -0,0 +1 @@ +echo "Nothing to do here yet." diff --git a/scripts/gen_next_references.sh b/scripts/gen_next_references.sh new file mode 100755 index 00000000000..70994a4bd0a --- /dev/null +++ b/scripts/gen_next_references.sh @@ -0,0 +1,26 @@ +# Create temporaty directory to work in and clone SDK +mkdir tmp && cd tmp +git clone --depth 1 --branch develop https://github.com/iotaledger/iota-sdk +cd iota-sdk + +# Generate and copy Python references +cd bindings/python +python -m venv .venv +source .venv/bin/activate +pip install -r requirements-dev.txt +PYTHONPATH=. pydoc-markdown +cp -Rv docs/references/python ../../../../next/docs/iota-sdk/docs/references/ +deactivate +cd - + +# Generate and copy Node.js references +cd bindings/nodejs +# The SDK still uses yarn classic: https://github.com/iotaledger/iota-sdk/issues/433 +yarn set version classic +yarn +yarn create-api-docs --out ../../../../next/docs/iota-sdk/docs/references/nodejs +cd - + +# Return to root and cleanup +cd ../../ +rm -rf tmp diff --git a/scripts/gen_shimmer_references.sh b/scripts/gen_shimmer_references.sh new file mode 100755 index 00000000000..a3bb80fa087 --- /dev/null +++ b/scripts/gen_shimmer_references.sh @@ -0,0 +1 @@ +echo "Nothing to do here yet."