From 17ffaa2e1a5fcdc6c212ec41dd9823dd2d7bec48 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Thu, 26 Sep 2024 12:42:41 +0000 Subject: [PATCH] Updating documentation: philogicae --- docs/classes/account_src.Account.html | 4 +-- .../account_src.BaseProviderWallet.html | 14 ++++---- docs/classes/account_src.ECIESAccount.html | 4 +-- .../avalanche_src.AvalancheAccount.html | 10 +++--- docs/classes/base_src.BaseAccount.html | 6 ++-- docs/classes/client_src.AlephHttpClient.html | 22 ++++++------ ...ient_src.AuthenticatedAlephHttpClient.html | 34 +++++++++---------- docs/classes/cosmos_src.CosmosAccount.html | 6 ++-- .../dns_src.DomainConfigurationError.html | 4 +-- docs/classes/dns_src.DomainValidator.html | 4 +-- .../ethereum_ledger_src.ETHLedgerAccount.html | 6 ++-- docs/classes/ethereum_src.ETHAccount.html | 10 +++--- docs/classes/evm_src.EVMAccount.html | 6 ++-- .../classes/evm_src.EthereumMockProvider.html | 4 +-- docs/classes/evm_src.JsonRPCWallet.html | 4 +-- .../message_src.AggregateMessageClient.html | 8 ++--- .../message_src.AlephNodeWebSocket.html | 4 +-- docs/classes/message_src.AlephWebSocket.html | 4 +-- .../message_src.BadSignatureError.html | 4 +-- .../message_src.BaseMessageClient.html | 10 +++--- docs/classes/message_src.BroadcastError.html | 4 +-- docs/classes/message_src.BuiltMessage.html | 4 +-- .../message_src.DomainConfigurationError.html | 4 +-- docs/classes/message_src.FileTooLarge.html | 4 +-- .../message_src.ForgetMessageClient.html | 6 ++-- .../message_src.ForgottenMessageError.html | 4 +-- docs/classes/message_src.HashedMessage.html | 4 +-- .../message_src.InstanceMessageClient.html | 4 +-- .../message_src.InsufficientFundsError.html | 4 +-- .../message_src.InvalidMessageError.html | 4 +-- .../message_src.MessageNotFoundError.html | 4 +-- .../message_src.PostMessageClient.html | 10 +++--- .../message_src.ProgramMessageClient.html | 4 +-- .../classes/message_src.PublishedMessage.html | 6 ++-- docs/classes/message_src.QueryError.html | 4 +-- docs/classes/message_src.SignedMessage.html | 6 ++-- .../message_src.StoreMessageClient.html | 10 +++--- docs/classes/nuls2_src.NULS2Account.html | 18 +++++----- docs/classes/solana_src.SOLAccount.html | 6 ++-- docs/classes/substrate_src.DOTAccount.html | 6 ++-- .../superfluid_src.SuperfluidAccount.html | 12 +++---- docs/classes/tezos_src.TEZOSAccount.html | 6 ++-- docs/enums/avalanche_src.ChainType.html | 4 +-- docs/enums/core_src.Blockchain.html | 4 +-- docs/enums/dns_src.TargetType.html | 4 +-- docs/enums/evm_src.RpcId.html | 4 +-- docs/enums/message_src.Encoding.html | 4 +-- docs/enums/message_src.HypervisorType.html | 4 +-- docs/enums/message_src.InterfaceType.html | 4 +-- docs/enums/message_src.ItemType.html | 4 +-- docs/enums/message_src.MachineType.html | 4 +-- docs/enums/message_src.MessageStatus.html | 4 +-- docs/enums/message_src.MessageType.html | 4 +-- docs/enums/message_src.PaymentType.html | 4 +-- docs/enums/message_src.VolumePersistence.html | 4 +-- .../avalanche_src.digestMessage.html | 2 +- .../avalanche_src.getAccountFromProvider.html | 2 +- .../avalanche_src.getEVMAddress.html | 2 +- docs/functions/avalanche_src.getKeyPair.html | 2 +- ...alanche_src.importAccountFromMnemonic.html | 2 +- ...anche_src.importAccountFromPrivateKey.html | 2 +- docs/functions/avalanche_src.newAccount.html | 2 +- .../avalanche_src.verifyAvalanche.html | 2 +- .../base_src.getAccountFromProvider.html | 2 +- .../base_src.importAccountFromMnemonic.html | 2 +- .../base_src.importAccountFromPrivateKey.html | 2 +- docs/functions/base_src.newAccount.html | 2 +- docs/functions/core_src.delay.html | 2 +- docs/functions/core_src.getSocketPath.html | 2 +- .../core_src.gigabyteToMebibyte.html | 2 +- docs/functions/core_src.isNode.html | 2 +- .../core_src.stripTrailingSlash.html | 2 +- .../cosmos_src.importAccountFromMnemonic.html | 2 +- ...osmos_src.importAccountFromPrivateKey.html | 2 +- docs/functions/cosmos_src.newAccount.html | 2 +- docs/functions/cosmos_src.verifyCosmos.html | 2 +- docs/functions/dns_src.hostnameFromUrl.html | 2 +- ...ereum_ledger_src.GetAccountFromLedger.html | 2 +- .../ethereum_ledger_src.getTransport.html | 2 +- .../ethereum_src.getAccountFromProvider.html | 2 +- ...thereum_src.importAccountFromMnemonic.html | 2 +- ...ereum_src.importAccountFromPrivateKey.html | 2 +- docs/functions/ethereum_src.newAccount.html | 2 +- docs/functions/evm_src.alephToWei.html | 2 +- .../functions/evm_src.createEphemeralEth.html | 2 +- docs/functions/evm_src.decToHex.html | 2 +- .../evm_src.findChainDataByChainId.html | 2 +- .../evm_src.findChainMetadataByChainId.html | 2 +- docs/functions/evm_src.hexToDec.html | 2 +- docs/functions/evm_src.verifyEthereum.html | 2 +- docs/functions/evm_src.weiToAleph.html | 2 +- .../message_src.PostMessageBuilder.html | 2 +- docs/functions/message_src.broadcast.html | 2 +- .../message_src.buildAggregateMessage.html | 2 +- .../message_src.buildForgetMessage.html | 2 +- .../message_src.buildInstanceMessage.html | 2 +- .../message_src.buildProgramMessage.html | 2 +- .../message_src.buildStoreMessage.html | 2 +- .../message_src.getMessagesSocket.html | 2 +- .../message_src.prepareAlephMessage.html | 2 +- .../message_src.pushFileToStorageEngine.html | 2 +- .../nuls2_src.importAccountFromMnemonic.html | 2 +- ...nuls2_src.importAccountFromPrivateKey.html | 2 +- docs/functions/nuls2_src.newAccount.html | 2 +- .../solana_src.getAccountFromProvider.html | 2 +- ...olana_src.importAccountFromPrivateKey.html | 2 +- docs/functions/solana_src.newAccount.html | 2 +- docs/functions/solana_src.verifySolana.html | 2 +- .../substrate_src.getAccountFromProvider.html | 2 +- ...bstrate_src.importAccountFromMnemonic.html | 2 +- ...trate_src.importAccountFromPrivateKey.html | 2 +- docs/functions/substrate_src.newAccount.html | 2 +- .../superfluid_src.createFromEVMAccount.html | 2 +- ...superfluid_src.getAccountFromProvider.html | 2 +- .../superfluid_src.isAccountSupported.html | 2 +- .../superfluid_src.isBlockchainSupported.html | 2 +- ...zos_src.ImportAccountFromBeaconWallet.html | 2 +- ...s_src.ImportAccountFromFundraiserInfo.html | 2 +- ...tezos_src.importAccountFromPrivateKey.html | 2 +- docs/functions/tezos_src.newAccount.html | 2 +- docs/functions/tezos_src.verifyTezos.html | 2 +- .../message_src.MessageTypeMap.html | 4 +-- docs/modules/account_src.html | 2 +- docs/modules/avalanche_src.html | 2 +- docs/modules/base_src.html | 2 +- docs/modules/client_src.html | 2 +- docs/modules/core_src.html | 2 +- docs/modules/cosmos_src.html | 2 +- docs/modules/dns_src.html | 2 +- docs/modules/ethereum_ledger_src.html | 2 +- docs/modules/ethereum_src.html | 2 +- docs/modules/evm_src.html | 2 +- docs/modules/message_src.html | 2 +- docs/modules/nuls2_src.html | 2 +- docs/modules/solana_src.html | 2 +- docs/modules/substrate_src.html | 2 +- docs/modules/superfluid_src.html | 2 +- docs/modules/tezos_src.html | 2 +- docs/types/account_src.EphAccount.html | 2 +- docs/types/account_src.SignableMessage.html | 2 +- .../core_src.JSExecutionEnvironment.html | 2 +- docs/types/core_src.RequireOnlyOne.html | 2 +- docs/types/evm_src.ChainMetadataType.html | 2 +- docs/types/evm_src.ChangeRpcParam.html | 2 +- docs/types/evm_src.RpcType.html | 2 +- docs/types/message_src.AbstractVolume.html | 2 +- docs/types/message_src.AggregateContent.html | 2 +- .../message_src.AggregateContentKey.html | 2 +- ...message_src.AggregateGetConfiguration.html | 2 +- .../message_src.AggregateGetResponse.html | 2 +- docs/types/message_src.AggregateMessage.html | 2 +- ...age_src.AggregatePublishConfiguration.html | 2 +- docs/types/message_src.AlephSocket.html | 2 +- docs/types/message_src.BaseContent.html | 2 +- .../message_src.BaseExecutableContent.html | 2 +- docs/types/message_src.BaseMessageProps.html | 2 +- docs/types/message_src.ChainRef.html | 2 +- docs/types/message_src.CodeContent.html | 2 +- docs/types/message_src.CpuProperties.html | 2 +- docs/types/message_src.DataContent.html | 2 +- docs/types/message_src.EphemeralVolume.html | 2 +- docs/types/message_src.Export.html | 2 +- docs/types/message_src.ForgetContent.html | 2 +- docs/types/message_src.ForgetMessage.html | 2 +- ...essage_src.ForgetPublishConfiguration.html | 2 +- .../message_src.FunctionEnvironment.html | 2 +- docs/types/message_src.FunctionRuntime.html | 2 +- docs/types/message_src.FunctionTriggers.html | 2 +- .../message_src.GetMessageConfiguration.html | 2 +- docs/types/message_src.GetMessageParams.html | 2 +- .../message_src.GetMessagesConfiguration.html | 2 +- docs/types/message_src.GetMessagesParams.html | 2 +- ...ge_src.GetMessagesSocketConfiguration.html | 2 +- .../message_src.GetMessagesSocketParams.html | 2 +- .../types/message_src.HashedMessageProps.html | 2 +- docs/types/message_src.HostRequirements.html | 2 +- docs/types/message_src.ImmutableVolume.html | 2 +- docs/types/message_src.InstanceContent.html | 2 +- .../message_src.InstanceEnvironment.html | 2 +- docs/types/message_src.InstanceMessage.html | 2 +- ...sage_src.InstancePublishConfiguration.html | 2 +- docs/types/message_src.ItemHash.html | 2 +- docs/types/message_src.MachineResources.html | 2 +- docs/types/message_src.MachineVolume.html | 2 +- docs/types/message_src.Message.html | 2 +- .../message_src.MessageBuilderConfig.html | 2 +- .../message_src.MessageConfirmation.html | 2 +- .../message_src.MessageConfirmationHash.html | 2 +- docs/types/message_src.MessageContent.html | 2 +- docs/types/message_src.MessageError.html | 2 +- docs/types/message_src.MessageResponse.html | 2 +- .../message_src.MessagesQueryResponse.html | 2 +- docs/types/message_src.NodeRequirements.html | 2 +- docs/types/message_src.ParentVolume.html | 2 +- docs/types/message_src.Payment.html | 2 +- docs/types/message_src.PersistentVolume.html | 2 +- docs/types/message_src.PostContent.html | 2 +- .../message_src.PostGetConfiguration.html | 2 +- docs/types/message_src.PostMessage.html | 2 +- .../message_src.PostPublishConfiguration.html | 2 +- docs/types/message_src.PostQueryParams.html | 2 +- docs/types/message_src.PostQueryResponse.html | 2 +- docs/types/message_src.PostResponse.html | 2 +- docs/types/message_src.ProgramContent.html | 2 +- docs/types/message_src.ProgramMessage.html | 2 +- ...ssage_src.ProgramPublishConfiguration.html | 2 +- ...message_src.ProgramSpawnConfiguration.html | 2 +- .../message_src.PublishedMessageProps.html | 2 +- docs/types/message_src.RootfsVolume.html | 2 +- .../types/message_src.SignedMessageProps.html | 2 +- docs/types/message_src.SocketResponse.html | 2 +- docs/types/message_src.StoreContent.html | 2 +- docs/types/message_src.StoreMessage.html | 2 +- .../message_src.StorePinConfiguration.html | 2 +- ...message_src.StorePublishConfiguration.html | 2 +- ...ssage_src.TrustedExecutionEnvironment.html | 2 +- docs/types/nuls2_src.ChainNAddress.html | 2 +- docs/types/nuls2_src.NULS2ImportConfig.html | 2 +- docs/variables/core_src.DEFAULT_API_V2.html | 2 +- .../variables/core_src.DEFAULT_API_WS_V2.html | 2 +- .../dns_src.DNS_INSTANCE_DOMAIN.html | 2 +- docs/variables/dns_src.DNS_IPFS_DOMAIN.html | 2 +- .../variables/dns_src.DNS_PROGRAM_DOMAIN.html | 2 +- docs/variables/dns_src.DNS_RESOLVERS.html | 2 +- docs/variables/dns_src.DNS_STATIC_DOMAIN.html | 2 +- docs/variables/evm_src.ChainData.html | 2 +- docs/variables/evm_src.ChainMetadata.html | 2 +- docs/variables/evm_src.erc20Abi.html | 2 +- .../message_src.MAXIMUM_DISK_SIZE.html | 2 +- ...ssage_src.defaultExecutionEnvironment.html | 2 +- ...c.defaultInstanceExecutionEnvironment.html | 2 +- .../message_src.defaultResources.html | 2 +- .../tezos_src.STANDARD_DAPP_URL.html | 2 +- 233 files changed, 356 insertions(+), 356 deletions(-) diff --git a/docs/classes/account_src.Account.html b/docs/classes/account_src.Account.html index 040a50da..e12cbc8d 100644 --- a/docs/classes/account_src.Account.html +++ b/docs/classes/account_src.Account.html @@ -1,8 +1,8 @@ Account | @aleph-sdk/monorepo

Class AccountAbstract

The Account class is used to implement protocols related accounts - Ethereum, Solana, ... It contains the account's address and public key.

All inherited classes of account must implement the GetChain and Sign methods.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

address

Methods

getChain sign -

Constructors

Protected constructor

Properties

Readonly address

address: string

Methods

Abstract getChain

Abstract sign

Settings

Member Visibility

Theme

On This Page

constructoraddressgetChainsign

Generated using TypeDoc

\ No newline at end of file +

Constructors

Protected constructor

Properties

Readonly address

address: string

Methods

Abstract getChain

Abstract sign

Settings

Member Visibility

Theme

On This Page

constructoraddressgetChainsign

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/account_src.BaseProviderWallet.html b/docs/classes/account_src.BaseProviderWallet.html index 9f3e8e7a..4b114df3 100644 --- a/docs/classes/account_src.BaseProviderWallet.html +++ b/docs/classes/account_src.BaseProviderWallet.html @@ -1,5 +1,5 @@ BaseProviderWallet | @aleph-sdk/monorepo

Class BaseProviderWalletAbstract

Wrapper for web3 Providers abstraction

-

Constructors

constructor +

Constructors

constructor

Properties

provider

Methods

connect getCurrentChainId @@ -7,11 +7,11 @@ isMetamask signMessage

Constructors

constructor

Properties

Readonly provider

provider: unknown

Provider property

-

Methods

Abstract connect

Abstract getCurrentChainId

  • getCurrentChainId(): Promise<number>

  • Gets the currently selected network chainID

    -

    Returns Promise<number>

Abstract getPublicKey

Abstract isMetamask

Methods

Abstract connect

Abstract getCurrentChainId

  • getCurrentChainId(): Promise<number>

  • Gets the currently selected network chainID

    +

    Returns Promise<number>

Abstract getPublicKey

Abstract isMetamask

  • isMetamask(): boolean

  • Asks the provider if its Metamask or not. This can be false positive.

    -

    Returns boolean

Abstract signMessage

Abstract signMessage

  • signMessage(data): Promise<string>

  • Signs a message using the Provider

    Parameters

    • data: string | Buffer

      The message to sign

      -

    Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

constructorproviderconnectgetCurrentChainIdgetPublicKeyisMetamasksignMessage

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

constructorproviderconnectgetCurrentChainIdgetPublicKeyisMetamasksignMessage

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/account_src.ECIESAccount.html b/docs/classes/account_src.ECIESAccount.html index f4eecc24..210e9483 100644 --- a/docs/classes/account_src.ECIESAccount.html +++ b/docs/classes/account_src.ECIESAccount.html @@ -1,10 +1,10 @@ ECIESAccount | @aleph-sdk/monorepo

Class ECIESAccountAbstract

The ECIESAccount class is used to implement protocols using secp256k1's curve. It extends the Account class by exposing an encryption publicKey.

Encryption has been removed as of the v1.0.0 release but will find its way back into the SDK.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

address publicKey

Methods

askPubKey getChain sign -

Constructors

Protected constructor

Properties

Readonly address

address: string

publicKey

publicKey: undefined | string

Methods

Abstract askPubKey

Abstract getChain

Abstract sign

Settings

Member Visibility

Theme

On This Page

constructoraddresspublicKeyaskPubKeygetChainsign

Generated using TypeDoc

\ No newline at end of file +

Constructors

Protected constructor

Properties

Readonly address

address: string

publicKey

publicKey: undefined | string

Methods

Abstract askPubKey

Abstract getChain

Abstract sign

Settings

Member Visibility

Theme

On This Page

constructoraddresspublicKeyaskPubKeygetChainsign

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/avalanche_src.AvalancheAccount.html b/docs/classes/avalanche_src.AvalancheAccount.html index c9e1f93b..3afd1dd6 100644 --- a/docs/classes/avalanche_src.AvalancheAccount.html +++ b/docs/classes/avalanche_src.AvalancheAccount.html @@ -1,6 +1,6 @@ AvalancheAccount | @aleph-sdk/monorepo

Class AvalancheAccount

AvalancheAccount implements the Account class for the Avalanche protocol. It is used to represent an Avalanche account when publishing a message on the Aleph network.

-

Hierarchy

  • EVMAccount
    • AvalancheAccount

Constructors

constructor +

Hierarchy

  • EVMAccount
    • AvalancheAccount

Constructors

constructor

Properties

address keyPair? publicKey @@ -14,16 +14,16 @@ getRpcId getRpcUrl sign -

Constructors

constructor

  • new AvalancheAccount(signerOrWallet, address, publicKey?, rpcId?): AvalancheAccount

  • Parameters

    • signerOrWallet: KeyPair | KeyPair | Wallet | JsonRpcProvider | JsonRPCWallet
    • address: string
    • Optional publicKey: string
    • Optional rpcId: number

    Returns AvalancheAccount

Properties

Readonly address

address: string

Optional Readonly keyPair

keyPair?: KeyPair | KeyPair

publicKey

publicKey: undefined | string

Optional selectedRpcId

selectedRpcId?: RpcId

Optional wallet

wallet?: Wallet | JsonRPCWallet

Methods

askPubKey

  • askPubKey(): Promise<void>

  • Ask for a Provider Account a read Access to its encryption publicKey +

Constructors

constructor

  • new AvalancheAccount(signerOrWallet, address, publicKey?, rpcId?): AvalancheAccount

  • Parameters

    • signerOrWallet: KeyPair | KeyPair | Wallet | JsonRpcProvider | JsonRPCWallet
    • address: string
    • Optional publicKey: string
    • Optional rpcId: number

    Returns AvalancheAccount

Properties

Readonly address

address: string

Optional Readonly keyPair

keyPair?: KeyPair | KeyPair

publicKey

publicKey: undefined | string

Optional selectedRpcId

selectedRpcId?: RpcId

Optional wallet

wallet?: Wallet | JsonRPCWallet

Methods

askPubKey

  • askPubKey(): Promise<void>

  • Ask for a Provider Account a read Access to its encryption publicKey If the encryption public Key is already loaded, nothing happens

    This method will throw if:

    • The account was not instanced with a provider.
    • The user denied the encryption public key sharing.
    -

    Returns Promise<void>

changeNetwork

  • changeNetwork(chainOrRpc?): Promise<void>

  • Parameters

    • Optional chainOrRpc: RpcId | RpcType

    Returns Promise<void>

getALEPHBalance

  • getALEPHBalance(): Promise<Decimal>

  • Retrieves the ALEPH token balance for a specified wallet address.

    -

    Returns Promise<Decimal>

getChain

getChainId

  • getChainId(): Promise<number>

  • Returns Promise<number>

getRpcId

  • getRpcId(): Promise<RpcId>

  • Returns Promise<RpcId>

getRpcUrl

  • getRpcUrl(): string

  • Returns string

sign

  • sign(message): Promise<string>

  • The Sign method provides a way to sign a given Aleph message using an avalanche keypair. +

    Returns Promise<void>

changeNetwork

  • changeNetwork(chainOrRpc?): Promise<void>

  • Parameters

    • Optional chainOrRpc: RpcId | RpcType

    Returns Promise<void>

getALEPHBalance

  • getALEPHBalance(): Promise<Decimal>

  • Retrieves the ALEPH token balance for a specified wallet address.

    +

    Returns Promise<Decimal>

getChain

getChainId

  • getChainId(): Promise<number>

  • Returns Promise<number>

getRpcId

  • getRpcId(): Promise<RpcId>

  • Returns Promise<RpcId>

getRpcUrl

  • getRpcUrl(): string

  • Returns string

sign

  • sign(message): Promise<string>

  • The Sign method provides a way to sign a given Aleph message using an avalanche keypair. The full message is not used as the payload, only fields of the BaseMessage type are.

    The sign method of the keypair is used as the signature method.

    Parameters

    • message: SignableMessage

      The Aleph message to sign, using some of its fields.

      -

    Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

constructoraddresskeyPairpublicKeyselectedRpcIdwalletaskPubKeychangeNetworkgetALEPHBalancegetChaingetChainIdgetRpcIdgetRpcUrlsign

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

constructoraddresskeyPairpublicKeyselectedRpcIdwalletaskPubKeychangeNetworkgetALEPHBalancegetChaingetChainIdgetRpcIdgetRpcUrlsign

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/base_src.BaseAccount.html b/docs/classes/base_src.BaseAccount.html index a3b7412f..12564e35 100644 --- a/docs/classes/base_src.BaseAccount.html +++ b/docs/classes/base_src.BaseAccount.html @@ -1,6 +1,6 @@ BaseAccount | @aleph-sdk/monorepo

Class BaseAccount

BaseAccount implements the Account class for the Base protocol. It is used to represent a Base account when publishing a message on the Aleph network.

-

Hierarchy

  • ETHAccount
    • BaseAccount

Constructors

constructor +

Hierarchy

  • ETHAccount
    • BaseAccount

Constructors

constructor

Properties

address publicKey selectedRpcId? @@ -13,7 +13,7 @@ getRpcId getRpcUrl sign -

Constructors

constructor

  • new BaseAccount(wallet, address, publicKey?, rpcId?): BaseAccount

  • Parameters

    • wallet: Wallet | JsonRPCWallet
    • address: string
    • Optional publicKey: string
    • Optional rpcId: number

    Returns BaseAccount

Properties

Readonly address

address: string

publicKey

publicKey: undefined | string

Optional selectedRpcId

selectedRpcId?: RpcId

Readonly wallet

wallet: Wallet | JsonRPCWallet

Methods

askPubKey

  • askPubKey(): Promise<void>

  • Ask for a Provider Account a read Access to its encryption publicKey +

Constructors

constructor

  • new BaseAccount(wallet, address, publicKey?, rpcId?): BaseAccount

  • Parameters

    • wallet: Wallet | JsonRPCWallet
    • address: string
    • Optional publicKey: string
    • Optional rpcId: number

    Returns BaseAccount

Properties

Readonly address

address: string

publicKey

publicKey: undefined | string

Optional selectedRpcId

selectedRpcId?: RpcId

Readonly wallet

wallet: Wallet | JsonRPCWallet

Methods

askPubKey

  • askPubKey(): Promise<void>

  • Ask for a Provider Account a read Access to its encryption publicKey If the encryption public Key is already loaded, nothing happens

    This method will throw if:

      @@ -21,7 +21,7 @@
    • The user denied the encryption public key sharing.

    Returns Promise<void>

changeNetwork

  • changeNetwork(chainOrRpc?): Promise<void>

  • Parameters

    • Optional chainOrRpc: RpcId | RpcType

    Returns Promise<void>

getALEPHBalance

  • getALEPHBalance(): Promise<Decimal>

  • Retrieves the ALEPH token balance for a specified wallet address.

    -

    Returns Promise<Decimal>

getChain

getChainId

  • getChainId(): Promise<number>

  • Returns Promise<number>

getRpcId

  • getRpcId(): Promise<RpcId>

  • Returns Promise<RpcId>

getRpcUrl

  • getRpcUrl(): string

  • Returns string

sign

  • sign(message): Promise<string>

  • The Sign method provides a way to sign a given Aleph message using an ethereum account. +

    Returns Promise<Decimal>

getChain

getChainId

  • getChainId(): Promise<number>

  • Returns Promise<number>

getRpcId

  • getRpcId(): Promise<RpcId>

  • Returns Promise<RpcId>

getRpcUrl

  • getRpcUrl(): string

  • Returns string

sign

fetchAggregate

  • fetchAggregate<T>(address, key): Promise<T>

  • Fetches an aggregate value from the Aleph network. Aggregates are a key-value store on the Aleph network. Aggregates are bound by address and each address can have multiple keys. By default, only the address that signs the aggregate can modify it.

    Type Parameters

    • T

    Parameters

    • address: string

      The address of the aggregate's owner

    • key: string

      The key of the aggregate to fetch

      -

    Returns Promise<T>

fetchAggregates

  • fetchAggregates(address, keys?): Promise<Record<string, any>>

  • Fetches multiple aggregates from the Aleph network. Aggregates are a key-value store on the Aleph network. +

Returns Promise<T>

fetchAggregates

  • fetchAggregates(address, keys?): Promise<Record<string, any>>

  • Fetches multiple aggregates from the Aleph network. Aggregates are a key-value store on the Aleph network. Aggregates are bound by address and each address can have multiple keys. By default, only the address that signs the aggregate can modify it.

    Parameters

    • address: string

      The address of the aggregate's owner

    • Optional keys: string[]

      The keys of the aggregates to fetch

      -

    Returns Promise<Record<string, any>>

getMessage

  • getMessage<T, Content>(itemHash): Promise<PublishedMessage<MessageTypeMap<Content>[T]>>

  • Tries to fetch a specific message from the Aleph network. Throws an error if the message is not found or forgotten.

    +

Returns Promise<Record<string, any>>

getMessage

getMessageError

Returns Promise<PublishedMessage<MessageTypeMap<Content>[T]>>

getMessageError

getMessages

Returns Promise<null | MessageError>

getMessages

getPost

Returns Promise<MessagesQueryResponse>

getPost

getPosts

Returns Promise<PostResponse<T>>

getPosts

watchMessages

Returns Promise<PostQueryResponse<T>>

watchMessages

Settings

Member Visibility

Theme

On This Page

constructoraggregateClientforgetClientinstanceClientmessageClientpostClientprogramClientstoreClientdownloadFilefetchAggregatefetchAggregatesgetMessagegetMessageErrorgetMessagesgetPostgetPostswatchMessages

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<AlephSocket>

Settings

Member Visibility

Theme

On This Page

constructoraggregateClientforgetClientinstanceClientmessageClientpostClientprogramClientstoreClientdownloadFilefetchAggregatefetchAggregatesgetMessagegetMessageErrorgetMessagesgetPostgetPostswatchMessages

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/client_src.AuthenticatedAlephHttpClient.html b/docs/classes/client_src.AuthenticatedAlephHttpClient.html index eed42d17..52d59018 100644 --- a/docs/classes/client_src.AuthenticatedAlephHttpClient.html +++ b/docs/classes/client_src.AuthenticatedAlephHttpClient.html @@ -1,4 +1,4 @@ -AuthenticatedAlephHttpClient | @aleph-sdk/monorepo

Class AuthenticatedAlephHttpClient

Hierarchy (view full)

Constructors

constructor +AuthenticatedAlephHttpClient | @aleph-sdk/monorepo

Class AuthenticatedAlephHttpClient

Hierarchy (view full)

Constructors

constructor

Properties

account aggregateClient forgetClient @@ -22,37 +22,37 @@ getPost getPosts watchMessages -

Constructors

constructor

Properties

account

account: Account

aggregateClient

aggregateClient: AggregateMessageClient

forgetClient

forgetClient: ForgetMessageClient

instanceClient

instanceClient: InstanceMessageClient

messageClient

messageClient: BaseMessageClient

postClient

postClient: PostMessageClient

programClient

programClient: ProgramMessageClient

storeClient

storeClient: StoreMessageClient

Methods

createAggregate

  • createAggregate<Content>(config): Promise<AggregateMessage<Content>>

  • Create an AGGREGATE message. It is meant to be used as a quick access storage associated with an account.

    -

    Type Parameters

    • Content

    Parameters

    • config: Omit<AggregatePublishConfiguration<Content>, "account">

    Returns Promise<AggregateMessage<Content>>

createInstance

  • createInstance(config): Promise<InstanceMessage>

  • Create a VM instance on the network by posting an INSTANCE message. It will be rejected by the network if the account does not have enough funds.

    -

    Parameters

    • config: Omit<InstancePublishConfiguration, "account">

    Returns Promise<InstanceMessage>

createPost

  • createPost<Content>(config): Promise<PostMessage<Content>>

  • Create a POST message on the aleph.im network. It is associated with a channel and owned by an account.

    -

    Type Parameters

    • Content = any

    Parameters

    • config: Omit<PostPublishConfiguration<Content>, "account">

    Returns Promise<PostMessage<Content>>

createProgram

  • createProgram(config): Promise<ProgramMessage>

  • Post a (create) PROGRAM message.

    -

    Parameters

    • config: Omit<ProgramPublishConfiguration, "account">

    Returns Promise<ProgramMessage>

createStore

  • createStore(config): Promise<StoreMessage>

  • Create a STORE message to store a file on the aleph.im network. +

Constructors

constructor

Properties

account

account: Account

aggregateClient

aggregateClient: AggregateMessageClient

forgetClient

forgetClient: ForgetMessageClient

instanceClient

instanceClient: InstanceMessageClient

messageClient

messageClient: BaseMessageClient

postClient

postClient: PostMessageClient

programClient

programClient: ProgramMessageClient

storeClient

storeClient: StoreMessageClient

Methods

createAggregate

  • createAggregate<Content>(config): Promise<AggregateMessage<Content>>

  • Create an AGGREGATE message. It is meant to be used as a quick access storage associated with an account.

    +

    Type Parameters

    • Content

    Parameters

    • config: Omit<AggregatePublishConfiguration<Content>, "account">

    Returns Promise<AggregateMessage<Content>>

createInstance

  • createInstance(config): Promise<InstanceMessage>

  • Create a VM instance on the network by posting an INSTANCE message. It will be rejected by the network if the account does not have enough funds.

    +

    Parameters

    • config: Omit<InstancePublishConfiguration, "account">

    Returns Promise<InstanceMessage>

createPost

  • createPost<Content>(config): Promise<PostMessage<Content>>

  • Create a POST message on the aleph.im network. It is associated with a channel and owned by an account.

    +

    Type Parameters

    • Content = any

    Parameters

    • config: Omit<PostPublishConfiguration<Content>, "account">

    Returns Promise<PostMessage<Content>>

createProgram

  • createProgram(config): Promise<ProgramMessage>

  • Post a (create) PROGRAM message.

    +

    Parameters

    • config: Omit<ProgramPublishConfiguration, "account">

    Returns Promise<ProgramMessage>

createStore

  • createStore(config): Promise<StoreMessage>

  • Create a STORE message to store a file on the aleph.im network. Can be passed either a file path, an IPFS hash or the file's content as raw bytes.

    -

    Parameters

    • config: RequireOnlyOne<Omit<StorePublishConfiguration, "account">, "fileObject" | "fileHash">

    Returns Promise<StoreMessage>

downloadFile

  • downloadFile(file_hash): Promise<ArrayBuffer>

  • Downloads a file from the Aleph network.

    +

    Parameters

    • config: RequireOnlyOne<Omit<StorePublishConfiguration, "account">, "fileObject" | "fileHash">

    Returns Promise<StoreMessage>

downloadFile

  • downloadFile(file_hash): Promise<ArrayBuffer>

  • Downloads a file from the Aleph network.

    Parameters

    • file_hash: string

      The hash of the STORE message of the file to retrieve.

      -

    Returns Promise<ArrayBuffer>

fetchAggregate

  • fetchAggregate<T>(address, key): Promise<T>

  • Fetches an aggregate value from the Aleph network. Aggregates are a key-value store on the Aleph network. +

Returns Promise<ArrayBuffer>

fetchAggregate

  • fetchAggregate<T>(address, key): Promise<T>

  • Fetches an aggregate value from the Aleph network. Aggregates are a key-value store on the Aleph network. Aggregates are bound by address and each address can have multiple keys. By default, only the address that signs the aggregate can modify it.

    Type Parameters

    • T

    Parameters

    • address: string

      The address of the aggregate's owner

    • key: string

      The key of the aggregate to fetch

      -

    Returns Promise<T>

fetchAggregates

  • fetchAggregates(address, keys?): Promise<Record<string, any>>

  • Fetches multiple aggregates from the Aleph network. Aggregates are a key-value store on the Aleph network. +

Returns Promise<T>

fetchAggregates

forget

getMessage

Returns Promise<Record<string, any>>

forget

getMessage

getMessageError

Returns Promise<PublishedMessage<MessageTypeMap<Content>[T]>>

getMessageError

getMessages

Returns Promise<null | MessageError>

getMessages

getPost

Returns Promise<MessagesQueryResponse>

getPost

getPosts

Returns Promise<PostResponse<T>>

getPosts

watchMessages

Returns Promise<PostQueryResponse<T>>

watchMessages

Settings

Member Visibility

Theme

On This Page

constructoraccountaggregateClientforgetClientinstanceClientmessageClientpostClientprogramClientstoreClientcreateAggregatecreateInstancecreatePostcreateProgramcreateStoredownloadFilefetchAggregatefetchAggregatesforgetgetMessagegetMessageErrorgetMessagesgetPostgetPostswatchMessages

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<AlephSocket>

Settings

Member Visibility

Theme

On This Page

constructoraccountaggregateClientforgetClientinstanceClientmessageClientpostClientprogramClientstoreClientcreateAggregatecreateInstancecreatePostcreateProgramcreateStoredownloadFilefetchAggregatefetchAggregatesforgetgetMessagegetMessageErrorgetMessagesgetPostgetPostswatchMessages

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/cosmos_src.CosmosAccount.html b/docs/classes/cosmos_src.CosmosAccount.html index 62a03c7e..27df1b3a 100644 --- a/docs/classes/cosmos_src.CosmosAccount.html +++ b/docs/classes/cosmos_src.CosmosAccount.html @@ -1,11 +1,11 @@ CosmosAccount | @aleph-sdk/monorepo

Class CosmosAccount

CosmosAccount implements the Account class for the Cosmos protocol. It is used to represent a Cosmos account when publishing a message on the Aleph network.

-

Hierarchy

  • Account
    • CosmosAccount

Constructors

constructor +

Hierarchy

  • Account
    • CosmosAccount

Constructors

constructor

Properties

address

Methods

getChain sign -

Constructors

constructor

Properties

Readonly address

address: string

Methods

getChain

sign

  • sign(message): Promise<string>

  • The Sign method provides a way to sign a given Aleph message using a Cosmos account. +

Constructors

constructor

Properties

Readonly address

address: string

Methods

getChain

sign

  • sign(message): Promise<string>

  • The Sign method provides a way to sign a given Aleph message using a Cosmos account. The full message is not used as the payload, only fields of the BaseMessage type are.

    The signMessage method uses the amino SignDoc helpers to generate the signature

    Parameters

    • message: SignableMessage

      The Aleph message to sign, using some of its fields.

      -

    Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

constructoraddressgetChainsign

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

constructoraddressgetChainsign

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/dns_src.DomainConfigurationError.html b/docs/classes/dns_src.DomainConfigurationError.html index af1a2e43..fab8fbd6 100644 --- a/docs/classes/dns_src.DomainConfigurationError.html +++ b/docs/classes/dns_src.DomainConfigurationError.html @@ -1,2 +1,2 @@ -DomainConfigurationError | @aleph-sdk/monorepo

Class DomainConfigurationError

Hierarchy

  • Error
    • DomainConfigurationError

Constructors

constructor -

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor

Generated using TypeDoc

\ No newline at end of file +DomainConfigurationError | @aleph-sdk/monorepo

Class DomainConfigurationError

Hierarchy

  • Error
    • DomainConfigurationError

Constructors

constructor +

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/dns_src.DomainValidator.html b/docs/classes/dns_src.DomainValidator.html index 7abd726f..c6366572 100644 --- a/docs/classes/dns_src.DomainValidator.html +++ b/docs/classes/dns_src.DomainValidator.html @@ -1,4 +1,4 @@ -DomainValidator | @aleph-sdk/monorepo

Class DomainValidator

Constructors

constructor +DomainValidator | @aleph-sdk/monorepo

Class DomainValidator

Constructors

constructor

Methods

checkDomain getDnsLink getDnsLinks @@ -8,4 +8,4 @@ getRequiredDnsRules getResolverFor getTxtValues -

Constructors

constructor

Methods

checkDomain

  • checkDomain(hostname, target, owner?): Promise<Record<string, boolean>>

  • Parameters

    • hostname: string
    • target: TargetType
    • Optional owner: string

    Returns Promise<Record<string, boolean>>

getDnsLink

  • getDnsLink(hostname): Promise<null | string>

  • Parameters

    • hostname: string

    Returns Promise<null | string>

getDnsLinks

  • getDnsLinks(hostname): Promise<string[]>

  • Parameters

    • hostname: string

    Returns Promise<string[]>

getIPv4Addresses

  • getIPv4Addresses(hostname): Promise<string[]>

  • Parameters

    • hostname: string

    Returns Promise<string[]>

getIPv6Addresses

  • getIPv6Addresses(hostname): Promise<string[]>

  • Parameters

    • hostname: string

    Returns Promise<string[]>

getNameServers

  • getNameServers(hostname): Promise<string[]>

  • Parameters

    • hostname: string

    Returns Promise<string[]>

getRequiredDnsRules

  • getRequiredDnsRules(hostname, target, owner?): DNSRule[]

  • Parameters

    • hostname: string
    • target: TargetType
    • Optional owner: string

    Returns DNSRule[]

getResolverFor

  • getResolverFor(hostname): Promise<Resolver>

  • Parameters

    • hostname: string

    Returns Promise<Resolver>

getTxtValues

  • getTxtValues(hostname, delimiter?): Promise<string[]>

  • Parameters

    • hostname: string
    • Optional delimiter: string

    Returns Promise<string[]>

Settings

Member Visibility

Theme

On This Page

constructorcheckDomaingetDnsLinkgetDnsLinksgetIPv4AddressesgetIPv6AddressesgetNameServersgetRequiredDnsRulesgetResolverForgetTxtValues

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

checkDomain

  • checkDomain(hostname, target, owner?): Promise<Record<string, boolean>>

  • Parameters

    • hostname: string
    • target: TargetType
    • Optional owner: string

    Returns Promise<Record<string, boolean>>

getDnsLink

  • getDnsLink(hostname): Promise<null | string>

  • Parameters

    • hostname: string

    Returns Promise<null | string>

getDnsLinks

  • getDnsLinks(hostname): Promise<string[]>

  • Parameters

    • hostname: string

    Returns Promise<string[]>

getIPv4Addresses

  • getIPv4Addresses(hostname): Promise<string[]>

  • Parameters

    • hostname: string

    Returns Promise<string[]>

getIPv6Addresses

  • getIPv6Addresses(hostname): Promise<string[]>

  • Parameters

    • hostname: string

    Returns Promise<string[]>

getNameServers

  • getNameServers(hostname): Promise<string[]>

  • Parameters

    • hostname: string

    Returns Promise<string[]>

getRequiredDnsRules

  • getRequiredDnsRules(hostname, target, owner?): DNSRule[]

  • Parameters

    • hostname: string
    • target: TargetType
    • Optional owner: string

    Returns DNSRule[]

getResolverFor

  • getResolverFor(hostname): Promise<Resolver>

  • Parameters

    • hostname: string

    Returns Promise<Resolver>

getTxtValues

  • getTxtValues(hostname, delimiter?): Promise<string[]>

  • Parameters

    • hostname: string
    • Optional delimiter: string

    Returns Promise<string[]>

Settings

Member Visibility

Theme

On This Page

constructorcheckDomaingetDnsLinkgetDnsLinksgetIPv4AddressesgetIPv6AddressesgetNameServersgetRequiredDnsRulesgetResolverForgetTxtValues

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/ethereum_ledger_src.ETHLedgerAccount.html b/docs/classes/ethereum_ledger_src.ETHLedgerAccount.html index f730bc3a..a4df00d1 100644 --- a/docs/classes/ethereum_ledger_src.ETHLedgerAccount.html +++ b/docs/classes/ethereum_ledger_src.ETHLedgerAccount.html @@ -1,9 +1,9 @@ ETHLedgerAccount | @aleph-sdk/monorepo

Class ETHLedgerAccount

The ETHLedgerAccount represents an ETHAccount with Signing functionalities Instanciated from a Ledger device

-

Hierarchy

  • Account
    • ETHLedgerAccount

Constructors

constructor +

Hierarchy

  • Account
    • ETHLedgerAccount

Constructors

constructor

Properties

address

Methods

getChain sign -

Constructors

constructor

Properties

Readonly address

address: string

Methods

getChain

sign

  • sign(message): Promise<string>

  • Signs a message using the Ledger's Private Key

    +

Constructors

constructor

Properties

Readonly address

address: string

Methods

getChain

sign

  • sign(message): Promise<string>

  • Signs a message using the Ledger's Private Key

    Parameters

    • message: SignableMessage

      The message to signe

      -

    Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

constructoraddressgetChainsign

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

constructoraddressgetChainsign

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/ethereum_src.ETHAccount.html b/docs/classes/ethereum_src.ETHAccount.html index 23b73642..fb869124 100644 --- a/docs/classes/ethereum_src.ETHAccount.html +++ b/docs/classes/ethereum_src.ETHAccount.html @@ -1,6 +1,6 @@ ETHAccount | @aleph-sdk/monorepo

Class ETHAccount

ETHAccount implements the Account class for the Ethereum protocol. It is used to represent an ethereum account when publishing a message on the Aleph network.

-

Hierarchy

  • EVMAccount
    • ETHAccount

Constructors

constructor +

Hierarchy

  • EVMAccount
    • ETHAccount

Constructors

constructor

Properties

address publicKey selectedRpcId? @@ -13,16 +13,16 @@ getRpcId getRpcUrl sign -

Constructors

constructor

  • new ETHAccount(wallet, address, publicKey?, rpcId?): ETHAccount

  • Parameters

    • wallet: Wallet | JsonRPCWallet
    • address: string
    • Optional publicKey: string
    • Optional rpcId: number

    Returns ETHAccount

Properties

Readonly address

address: string

publicKey

publicKey: undefined | string

Optional selectedRpcId

selectedRpcId?: RpcId

Readonly wallet

wallet: Wallet | JsonRPCWallet

Methods

askPubKey

  • askPubKey(): Promise<void>

  • Ask for a Provider Account a read Access to its encryption publicKey +

Constructors

constructor

  • new ETHAccount(wallet, address, publicKey?, rpcId?): ETHAccount

  • Parameters

    • wallet: Wallet | JsonRPCWallet
    • address: string
    • Optional publicKey: string
    • Optional rpcId: number

    Returns ETHAccount

Properties

Readonly address

address: string

publicKey

publicKey: undefined | string

Optional selectedRpcId

selectedRpcId?: RpcId

Readonly wallet

wallet: Wallet | JsonRPCWallet

Methods

askPubKey

  • askPubKey(): Promise<void>

  • Ask for a Provider Account a read Access to its encryption publicKey If the encryption public Key is already loaded, nothing happens

    This method will throw if:

    • The account was not instanced with a provider.
    • The user denied the encryption public key sharing.
    -

    Returns Promise<void>

changeNetwork

  • changeNetwork(chainOrRpc?): Promise<void>

  • Parameters

    • Optional chainOrRpc: RpcId | RpcType

    Returns Promise<void>

getALEPHBalance

  • getALEPHBalance(): Promise<Decimal>

  • Retrieves the ALEPH token balance for a specified wallet address.

    -

    Returns Promise<Decimal>

getChain

getChainId

  • getChainId(): Promise<number>

  • Returns Promise<number>

getRpcId

  • getRpcId(): Promise<RpcId>

  • Returns Promise<RpcId>

getRpcUrl

  • getRpcUrl(): string

  • Returns string

sign

  • sign(message): Promise<string>

  • The Sign method provides a way to sign a given Aleph message using an ethereum account. +

    Returns Promise<void>

changeNetwork

  • changeNetwork(chainOrRpc?): Promise<void>

  • Parameters

    • Optional chainOrRpc: RpcId | RpcType

    Returns Promise<void>

getALEPHBalance

  • getALEPHBalance(): Promise<Decimal>

  • Retrieves the ALEPH token balance for a specified wallet address.

    +

    Returns Promise<Decimal>

getChain

getChainId

  • getChainId(): Promise<number>

  • Returns Promise<number>

getRpcId

  • getRpcId(): Promise<RpcId>

  • Returns Promise<RpcId>

getRpcUrl

  • getRpcUrl(): string

  • Returns string

sign

  • sign(message): Promise<string>

  • The Sign method provides a way to sign a given Aleph message using an ethereum account. The full message is not used as the payload, only fields of the BaseMessage type are.

    The signMessage method of the package 'ethers' is used as the signature method.

    Parameters

    • message: SignableMessage

      The Aleph message to sign, using some of its fields.

      -

    Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

constructoraddresspublicKeyselectedRpcIdwalletaskPubKeychangeNetworkgetALEPHBalancegetChaingetChainIdgetRpcIdgetRpcUrlsign

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

constructoraddresspublicKeyselectedRpcIdwalletaskPubKeychangeNetworkgetALEPHBalancegetChaingetChainIdgetRpcIdgetRpcUrlsign

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/evm_src.EVMAccount.html b/docs/classes/evm_src.EVMAccount.html index da0bf840..abcedd70 100644 --- a/docs/classes/evm_src.EVMAccount.html +++ b/docs/classes/evm_src.EVMAccount.html @@ -1,4 +1,4 @@ -EVMAccount | @aleph-sdk/monorepo

Class EVMAccountAbstract

Hierarchy

  • ECIESAccount
    • EVMAccount

Constructors

constructor +EVMAccount | @aleph-sdk/monorepo

Class EVMAccountAbstract

Hierarchy

  • ECIESAccount
    • EVMAccount

Constructors

constructor

Properties

address publicKey selectedRpcId? @@ -11,5 +11,5 @@ getRpcId getRpcUrl sign -

Constructors

Protected constructor

  • new EVMAccount(address, publicKey?): EVMAccount

  • Parameters

    • address: string
    • Optional publicKey: string

    Returns EVMAccount

Properties

Readonly address

address: string

publicKey

publicKey: undefined | string

Optional selectedRpcId

selectedRpcId?: RpcId

Optional wallet

wallet?: Wallet | JsonRPCWallet

Methods

Abstract askPubKey

  • askPubKey(): Promise<void>

  • Returns Promise<void>

changeNetwork

getALEPHBalance

  • getALEPHBalance(): Promise<Decimal>

  • Retrieves the ALEPH token balance for a specified wallet address.

    -

    Returns Promise<Decimal>

Abstract getChain

  • getChain(): Blockchain

  • Returns Blockchain

getChainId

getRpcId

getRpcUrl

Abstract sign

  • sign(message): Promise<string>

  • Parameters

    • message: SignableMessage

    Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

constructoraddresspublicKeyselectedRpcIdwalletaskPubKeychangeNetworkgetALEPHBalancegetChaingetChainIdgetRpcIdgetRpcUrlsign

Generated using TypeDoc

\ No newline at end of file +

Constructors

Protected constructor

  • new EVMAccount(address, publicKey?): EVMAccount

  • Parameters

    • address: string
    • Optional publicKey: string

    Returns EVMAccount

Properties

Readonly address

address: string

publicKey

publicKey: undefined | string

Optional selectedRpcId

selectedRpcId?: RpcId

Optional wallet

wallet?: Wallet | JsonRPCWallet

Methods

Abstract askPubKey

  • askPubKey(): Promise<void>

  • Returns Promise<void>

changeNetwork

getALEPHBalance

  • getALEPHBalance(): Promise<Decimal>

  • Retrieves the ALEPH token balance for a specified wallet address.

    +

    Returns Promise<Decimal>

Abstract getChain

  • getChain(): Blockchain

  • Returns Blockchain

getChainId

getRpcId

getRpcUrl

Abstract sign

  • sign(message): Promise<string>

  • Parameters

    • message: SignableMessage

    Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

constructoraddresspublicKeyselectedRpcIdwalletaskPubKeychangeNetworkgetALEPHBalancegetChaingetChainIdgetRpcIdgetRpcUrlsign

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/evm_src.EthereumMockProvider.html b/docs/classes/evm_src.EthereumMockProvider.html index 730f1233..e55130f9 100644 --- a/docs/classes/evm_src.EthereumMockProvider.html +++ b/docs/classes/evm_src.EthereumMockProvider.html @@ -1,4 +1,4 @@ -EthereumMockProvider | @aleph-sdk/monorepo

Class EthereumMockProvider

Implements

  • IMockProvider

Constructors

constructor +EthereumMockProvider | @aleph-sdk/monorepo

Class EthereumMockProvider

Implements

  • IMockProvider

Constructors

constructor

Properties

isMetaMask

Accessors

chainId selectedAddress @@ -7,4 +7,4 @@ getPrivateKey getSigner request -

Constructors

constructor

Properties

isMetaMask

isMetaMask: boolean = true

Accessors

chainId

selectedAddress

Methods

getAddress

getNetworkVersion

getPrivateKey

getSigner

request

  • request(__namedParameters): Promise<any>

  • Parameters

    • __namedParameters: {
          method: string;
          params?: any[];
      }
      • method: string
      • Optional params?: any[]

    Returns Promise<any>

Settings

Member Visibility

Theme

On This Page

constructorisMetaMaskchainIdselectedAddressgetAddressgetNetworkVersiongetPrivateKeygetSignerrequest

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

isMetaMask

isMetaMask: boolean = true

Accessors

chainId

selectedAddress

Methods

getAddress

getNetworkVersion

getPrivateKey

getSigner

request

  • request(__namedParameters): Promise<any>

  • Parameters

    • __namedParameters: {
          method: string;
          params?: any[];
      }
      • method: string
      • Optional params?: any[]

    Returns Promise<any>

Settings

Member Visibility

Theme

On This Page

constructorisMetaMaskchainIdselectedAddressgetAddressgetNetworkVersiongetPrivateKeygetSignerrequest

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/evm_src.JsonRPCWallet.html b/docs/classes/evm_src.JsonRPCWallet.html index 0c140dfb..08de5fb4 100644 --- a/docs/classes/evm_src.JsonRPCWallet.html +++ b/docs/classes/evm_src.JsonRPCWallet.html @@ -1,5 +1,5 @@ JsonRPCWallet | @aleph-sdk/monorepo

Class JsonRPCWallet

Wrapper for JSON RPC Providers (ex: Metamask).

-

Hierarchy

  • BaseProviderWallet
    • JsonRPCWallet

Constructors

constructor +

Hierarchy

  • BaseProviderWallet
    • JsonRPCWallet

Constructors

constructor

Properties

address? provider

Methods

changeNetwork @@ -9,4 +9,4 @@ isConnected isMetamask signMessage -

Constructors

constructor

Properties

Optional address

address?: string

Readonly provider

provider: JsonRpcProvider | Web3Provider

Methods

changeNetwork

connect

getCurrentChainId

  • getCurrentChainId(): Promise<number>

  • Returns Promise<number>

getPublicKey

isConnected

isMetamask

signMessage

  • signMessage(data): Promise<string>

  • Parameters

    • data: string | Buffer

    Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

constructoraddressproviderchangeNetworkconnectgetCurrentChainIdgetPublicKeyisConnectedisMetamasksignMessage

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Optional address

address?: string

Readonly provider

provider: JsonRpcProvider | Web3Provider

Methods

changeNetwork

connect

getCurrentChainId

  • getCurrentChainId(): Promise<number>

  • Returns Promise<number>

getPublicKey

isConnected

isMetamask

signMessage

  • signMessage(data): Promise<string>

  • Parameters

    • data: string | Buffer

    Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

constructoraddressproviderchangeNetworkconnectgetCurrentChainIdgetPublicKeyisConnectedisMetamasksignMessage

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/message_src.AggregateMessageClient.html b/docs/classes/message_src.AggregateMessageClient.html index 5ecc94b7..44ba3f60 100644 --- a/docs/classes/message_src.AggregateMessageClient.html +++ b/docs/classes/message_src.AggregateMessageClient.html @@ -1,14 +1,14 @@ -AggregateMessageClient | @aleph-sdk/monorepo

Class AggregateMessageClient

Constructors

constructor +AggregateMessageClient | @aleph-sdk/monorepo

Class AggregateMessageClient

Constructors

constructor

Properties

apiServer

Methods

get send -

Constructors

constructor

Properties

apiServer

apiServer: string

Methods

get

  • get<T>(configuration): Promise<Record<string, T>>

  • Retrieves an aggregate message on from the Aleph network. +

Constructors

constructor

Properties

apiServer

apiServer: string

Methods

get

  • get<T>(configuration): Promise<Record<string, T>>

  • Retrieves an aggregate message on from the Aleph network. It uses the address & key(s) provided in the configuration given as a parameter to retrieve the wanted message.

    Type Parameters

    • T = any

    Parameters

    Returns Promise<Record<string, T>>

send

  • send<T>(__namedParameters): Promise<AggregateMessage<T>>

  • Publishes an aggregate message to the Aleph network.

    +

Returns Promise<Record<string, T>>

send

Settings

Member Visibility

Theme

On This Page

constructorapiServergetsend

Generated using TypeDoc

\ No newline at end of file +

Type Parameters

Parameters

Returns Promise<AggregateMessage<T>>

Settings

Member Visibility

Theme

On This Page

constructorapiServergetsend

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/message_src.AlephNodeWebSocket.html b/docs/classes/message_src.AlephNodeWebSocket.html index ecec3092..5c286eb1 100644 --- a/docs/classes/message_src.AlephNodeWebSocket.html +++ b/docs/classes/message_src.AlephNodeWebSocket.html @@ -1,8 +1,8 @@ AlephNodeWebSocket | @aleph-sdk/monorepo

Class AlephNodeWebSocket

This class is used to manipulate Node Web Socket to list Aleph Messages

-

Constructors

constructor +

Constructors

constructor

Methods

clearData closeSocket getData getIsOpen getSocket -

Constructors

constructor

Methods

clearData

closeSocket

getData

getIsOpen

getSocket

Settings

Member Visibility

Theme

On This Page

constructorclearDatacloseSocketgetDatagetIsOpengetSocket

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

clearData

closeSocket

getData

getIsOpen

getSocket

Settings

Member Visibility

Theme

On This Page

constructorclearDatacloseSocketgetDatagetIsOpengetSocket

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/message_src.AlephWebSocket.html b/docs/classes/message_src.AlephWebSocket.html index d6a79fd3..b6f33da3 100644 --- a/docs/classes/message_src.AlephWebSocket.html +++ b/docs/classes/message_src.AlephWebSocket.html @@ -1,8 +1,8 @@ AlephWebSocket | @aleph-sdk/monorepo

Class AlephWebSocket

This class is used to manipulate Web Socket to list Aleph Messages

-

Constructors

constructor +

Constructors

constructor

Methods

clearData closeSocket getData getIsOpen getSocket -

Constructors

constructor

Methods

clearData

closeSocket

getData

getIsOpen

getSocket

Settings

Member Visibility

Theme

On This Page

constructorclearDatacloseSocketgetDatagetIsOpengetSocket

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

clearData

closeSocket

getData

getIsOpen

getSocket

Settings

Member Visibility

Theme

On This Page

constructorclearDatacloseSocketgetDatagetIsOpengetSocket

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/message_src.BadSignatureError.html b/docs/classes/message_src.BadSignatureError.html index 3f1bb6b2..b95d8574 100644 --- a/docs/classes/message_src.BadSignatureError.html +++ b/docs/classes/message_src.BadSignatureError.html @@ -1,2 +1,2 @@ -BadSignatureError | @aleph-sdk/monorepo

Class BadSignatureError

Hierarchy

  • Error
    • BadSignatureError

Constructors

constructor -

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor

Generated using TypeDoc

\ No newline at end of file +BadSignatureError | @aleph-sdk/monorepo

Class BadSignatureError

Hierarchy

  • Error
    • BadSignatureError

Constructors

constructor +

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/message_src.BaseMessageClient.html b/docs/classes/message_src.BaseMessageClient.html index 0590ba75..e30cca1a 100644 --- a/docs/classes/message_src.BaseMessageClient.html +++ b/docs/classes/message_src.BaseMessageClient.html @@ -1,14 +1,14 @@ -BaseMessageClient | @aleph-sdk/monorepo

Class BaseMessageClient

Constructors

constructor +BaseMessageClient | @aleph-sdk/monorepo

Class BaseMessageClient

Constructors

constructor

Properties

apiServer wsServer

Methods

get getAll getError getMessagesSocket -

Constructors

constructor

Properties

apiServer

apiServer: string

wsServer

wsServer: string

Methods

get

Constructors

constructor

Properties

apiServer

apiServer: string

wsServer

wsServer: string

Methods

get

getAll

Returns Promise<PublishedMessage<MessageTypeMap<Content>[T]>>

getAll

getError

  • getError(item_hash): Promise<null | MessageError>

  • Retrieves the error of a rejected message

    +

Returns Promise<MessagesQueryResponse>

getError

getMessagesSocket

Settings

Member Visibility

Theme

On This Page

constructorapiServerwsServergetgetAllgetErrorgetMessagesSocket

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<null | MessageError>

getMessagesSocket

Settings

Member Visibility

Theme

On This Page

constructorapiServerwsServergetgetAllgetErrorgetMessagesSocket

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/message_src.BroadcastError.html b/docs/classes/message_src.BroadcastError.html index da6811cc..4cff7c02 100644 --- a/docs/classes/message_src.BroadcastError.html +++ b/docs/classes/message_src.BroadcastError.html @@ -1,3 +1,3 @@ -BroadcastError | @aleph-sdk/monorepo

Class BroadcastError

Hierarchy (view full)

Constructors

constructor +BroadcastError | @aleph-sdk/monorepo

Class BroadcastError

Hierarchy (view full)

Constructors

constructor

Properties

errors -

Constructors

constructor

Properties

errors

errors: string[]

Settings

Member Visibility

Theme

On This Page

constructorerrors

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

errors

errors: string[]

Settings

Member Visibility

Theme

On This Page

constructorerrors

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/message_src.BuiltMessage.html b/docs/classes/message_src.BuiltMessage.html index 5923fbae..7bc84b19 100644 --- a/docs/classes/message_src.BuiltMessage.html +++ b/docs/classes/message_src.BuiltMessage.html @@ -1,4 +1,4 @@ -BuiltMessage | @aleph-sdk/monorepo

Class BuiltMessage<C>

Type Parameters

Hierarchy (view full)

Constructors

constructor +BuiltMessage | @aleph-sdk/monorepo

Class BuiltMessage<C>

Type Parameters

Hierarchy (view full)

Constructors

constructor

Properties

chain channel? content @@ -7,4 +7,4 @@ time type

Methods

isOfType -

Constructors

constructor

Properties

chain

chain: Blockchain

Optional channel

channel?: string

content

content: C

item_type

item_type: ItemType

sender

sender: string

time

time: number

type

type: keyof MessageTypeMap<C>

Methods

isOfType

Settings

Member Visibility

Theme

On This Page

constructorchainchannelcontentitem_typesendertimetypeisOfType

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

chain

chain: Blockchain

Optional channel

channel?: string

content

content: C

item_type

item_type: ItemType

sender

sender: string

time

time: number

type

type: keyof MessageTypeMap<C>

Methods

isOfType

Settings

Member Visibility

Theme

On This Page

constructorchainchannelcontentitem_typesendertimetypeisOfType

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/message_src.DomainConfigurationError.html b/docs/classes/message_src.DomainConfigurationError.html index 5f6d51ca..c8ff8602 100644 --- a/docs/classes/message_src.DomainConfigurationError.html +++ b/docs/classes/message_src.DomainConfigurationError.html @@ -1,2 +1,2 @@ -DomainConfigurationError | @aleph-sdk/monorepo

Class DomainConfigurationError

Hierarchy

  • Error
    • DomainConfigurationError

Constructors

constructor -

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor

Generated using TypeDoc

\ No newline at end of file +DomainConfigurationError | @aleph-sdk/monorepo

Class DomainConfigurationError

Hierarchy

  • Error
    • DomainConfigurationError

Constructors

constructor +

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/message_src.FileTooLarge.html b/docs/classes/message_src.FileTooLarge.html index d4b86d2e..fc49b433 100644 --- a/docs/classes/message_src.FileTooLarge.html +++ b/docs/classes/message_src.FileTooLarge.html @@ -1,2 +1,2 @@ -FileTooLarge | @aleph-sdk/monorepo

Class FileTooLarge

Hierarchy

  • Error
    • FileTooLarge

Constructors

constructor -

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor

Generated using TypeDoc

\ No newline at end of file +FileTooLarge | @aleph-sdk/monorepo

Class FileTooLarge

Hierarchy

  • Error
    • FileTooLarge

Constructors

constructor +

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/message_src.ForgetMessageClient.html b/docs/classes/message_src.ForgetMessageClient.html index a6d4a38a..2877ba20 100644 --- a/docs/classes/message_src.ForgetMessageClient.html +++ b/docs/classes/message_src.ForgetMessageClient.html @@ -1,10 +1,10 @@ -ForgetMessageClient | @aleph-sdk/monorepo

Class ForgetMessageClient

Constructors

constructor +ForgetMessageClient | @aleph-sdk/monorepo

Class ForgetMessageClient

Constructors

constructor

Properties

apiServer

Methods

send -

Constructors

constructor

Properties

apiServer

apiServer: string

Methods

send

  • send(configuration): Promise<ForgetMessage>

  • Submit a forget object to remove content from a Post message on the network.

    +

Constructors

constructor

Properties

apiServer

apiServer: string

Methods

send

  • send(configuration): Promise<ForgetMessage>

  • Submit a forget object to remove content from a Post message on the network.

    Account submitting the forget message. Should either be: The sender of the original message to forget. the sender of the VM that created the message. The address the original message was attributed to.

    Parameters

    Returns Promise<ForgetMessage>

Settings

Member Visibility

Theme

On This Page

constructorapiServersend

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<ForgetMessage>

Settings

Member Visibility

Theme

On This Page

constructorapiServersend

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/message_src.ForgottenMessageError.html b/docs/classes/message_src.ForgottenMessageError.html index cb91c838..e40ec609 100644 --- a/docs/classes/message_src.ForgottenMessageError.html +++ b/docs/classes/message_src.ForgottenMessageError.html @@ -1,2 +1,2 @@ -ForgottenMessageError | @aleph-sdk/monorepo

Class ForgottenMessageError

Hierarchy (view full)

Constructors

constructor -

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor

Generated using TypeDoc

\ No newline at end of file +ForgottenMessageError | @aleph-sdk/monorepo

Class ForgottenMessageError

Hierarchy (view full)

Constructors

constructor +

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/message_src.HashedMessage.html b/docs/classes/message_src.HashedMessage.html index 3a57aee6..70659909 100644 --- a/docs/classes/message_src.HashedMessage.html +++ b/docs/classes/message_src.HashedMessage.html @@ -1,4 +1,4 @@ -HashedMessage | @aleph-sdk/monorepo

Class HashedMessage<C>

Type Parameters

Hierarchy (view full)

Constructors

constructor +HashedMessage | @aleph-sdk/monorepo

Class HashedMessage<C>

Type Parameters

Hierarchy (view full)

Constructors

constructor

Properties

chain channel? content @@ -10,4 +10,4 @@ type

Methods

getVerificationBuffer isOfType -

Constructors

constructor

Properties

chain

chain: Blockchain

Optional channel

channel?: string

content

content: C

Optional item_content

item_content?: string

item_hash

item_hash: string

item_type

item_type: ItemType

sender

sender: string

time

time: number

type

type: keyof MessageTypeMap<C>

Methods

getVerificationBuffer

isOfType

Settings

Member Visibility

Theme

On This Page

constructorchainchannelcontentitem_contentitem_hashitem_typesendertimetypegetVerificationBufferisOfType

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

chain

chain: Blockchain

Optional channel

channel?: string

content

content: C

Optional item_content

item_content?: string

item_hash

item_hash: string

item_type

item_type: ItemType

sender

sender: string

time

time: number

type

type: keyof MessageTypeMap<C>

Methods

getVerificationBuffer

isOfType

Settings

Member Visibility

Theme

On This Page

constructorchainchannelcontentitem_contentitem_hashitem_typesendertimetypegetVerificationBufferisOfType

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/message_src.InstanceMessageClient.html b/docs/classes/message_src.InstanceMessageClient.html index 21a07109..9dae7483 100644 --- a/docs/classes/message_src.InstanceMessageClient.html +++ b/docs/classes/message_src.InstanceMessageClient.html @@ -1,4 +1,4 @@ -InstanceMessageClient | @aleph-sdk/monorepo

Class InstanceMessageClient

Constructors

constructor +InstanceMessageClient | @aleph-sdk/monorepo

Class InstanceMessageClient

Constructors

constructor

Properties

apiServer

Methods

send -

Constructors

constructor

Properties

apiServer

apiServer: string

Methods

send

Settings

Member Visibility

Theme

On This Page

constructorapiServersend

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

apiServer

apiServer: string

Methods

send

Settings

Member Visibility

Theme

On This Page

constructorapiServersend

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/message_src.InsufficientFundsError.html b/docs/classes/message_src.InsufficientFundsError.html index da3c45e5..422626fa 100644 --- a/docs/classes/message_src.InsufficientFundsError.html +++ b/docs/classes/message_src.InsufficientFundsError.html @@ -1,4 +1,4 @@ -InsufficientFundsError | @aleph-sdk/monorepo

Class InsufficientFundsError

Hierarchy

  • Error
    • InsufficientFundsError

Constructors

constructor +InsufficientFundsError | @aleph-sdk/monorepo

Class InsufficientFundsError

Hierarchy

  • Error
    • InsufficientFundsError

Constructors

constructor

Properties

available_funds required_funds -

Constructors

constructor

Properties

available_funds

available_funds: number

required_funds

required_funds: number

Settings

Member Visibility

Theme

On This Page

constructoravailable_fundsrequired_funds

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

available_funds

available_funds: number

required_funds

required_funds: number

Settings

Member Visibility

Theme

On This Page

constructoravailable_fundsrequired_funds

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/message_src.InvalidMessageError.html b/docs/classes/message_src.InvalidMessageError.html index 3d423eab..44c5c00a 100644 --- a/docs/classes/message_src.InvalidMessageError.html +++ b/docs/classes/message_src.InvalidMessageError.html @@ -1,3 +1,3 @@ -InvalidMessageError | @aleph-sdk/monorepo

Class InvalidMessageError

Hierarchy (view full)

Constructors

constructor +InvalidMessageError | @aleph-sdk/monorepo

Class InvalidMessageError

Hierarchy (view full)

Constructors

constructor

Properties

errors -

Constructors

constructor

Properties

errors

errors: string[]

Settings

Member Visibility

Theme

On This Page

constructorerrors

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

errors

errors: string[]

Settings

Member Visibility

Theme

On This Page

constructorerrors

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/message_src.MessageNotFoundError.html b/docs/classes/message_src.MessageNotFoundError.html index 2d820040..a16c2d9d 100644 --- a/docs/classes/message_src.MessageNotFoundError.html +++ b/docs/classes/message_src.MessageNotFoundError.html @@ -1,2 +1,2 @@ -MessageNotFoundError | @aleph-sdk/monorepo

Class MessageNotFoundError

Hierarchy (view full)

Constructors

constructor -

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor

Generated using TypeDoc

\ No newline at end of file +MessageNotFoundError | @aleph-sdk/monorepo

Class MessageNotFoundError

Hierarchy (view full)

Constructors

constructor +

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/message_src.PostMessageClient.html b/docs/classes/message_src.PostMessageClient.html index bdcfde1c..13fff700 100644 --- a/docs/classes/message_src.PostMessageClient.html +++ b/docs/classes/message_src.PostMessageClient.html @@ -1,13 +1,13 @@ -PostMessageClient | @aleph-sdk/monorepo

Class PostMessageClient

Constructors

constructor +PostMessageClient | @aleph-sdk/monorepo

Class PostMessageClient

Constructors

constructor

Properties

apiServer

Methods

get getAll send -

Constructors

constructor

Properties

apiServer

apiServer: string

Methods

get

getAll

send

  • send<T>(__namedParameters): Promise<PostMessage<T>>

  • Publishes a post message to the Aleph network.

    +

Constructors

constructor

Properties

apiServer

apiServer: string

Methods

get

getAll

send

  • send<T>(__namedParameters): Promise<PostMessage<T>>

  • Publishes a post message to the Aleph network.

    Type Parameters

    • T

      The type of the content of the message.

    Parameters

    Returns Promise<PostMessage<T>>

    The message that was published.

    Throws

    InvalidMessageError if the message is not compliant with the Aleph protocol.

    Throws

    BroadcastError if the message could not be broadcast for any other reason.

    -

Settings

Member Visibility

Theme

On This Page

constructorapiServergetgetAllsend

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorapiServergetgetAllsend

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/message_src.ProgramMessageClient.html b/docs/classes/message_src.ProgramMessageClient.html index a053e2bd..adbc886e 100644 --- a/docs/classes/message_src.ProgramMessageClient.html +++ b/docs/classes/message_src.ProgramMessageClient.html @@ -1,7 +1,7 @@ -ProgramMessageClient | @aleph-sdk/monorepo

Class ProgramMessageClient

Constructors

constructor +ProgramMessageClient | @aleph-sdk/monorepo

Class ProgramMessageClient

Constructors

constructor

Properties

apiServer baseMessageClient storeMessageClient

Methods

publish spawn -

Constructors

constructor

Properties

apiServer

apiServer: string

Protected baseMessageClient

baseMessageClient: BaseMessageClient

Protected storeMessageClient

storeMessageClient: StoreMessageClient

Methods

publish

spawn

Settings

Member Visibility

Theme

On This Page

constructorapiServerbaseMessageClientstoreMessageClientpublishspawn

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

apiServer

apiServer: string

Protected baseMessageClient

baseMessageClient: BaseMessageClient

Protected storeMessageClient

storeMessageClient: StoreMessageClient

Methods

publish

spawn

Settings

Member Visibility

Theme

On This Page

constructorapiServerbaseMessageClientstoreMessageClientpublishspawn

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/message_src.PublishedMessage.html b/docs/classes/message_src.PublishedMessage.html index 47cbf0af..2d7a2143 100644 --- a/docs/classes/message_src.PublishedMessage.html +++ b/docs/classes/message_src.PublishedMessage.html @@ -1,4 +1,4 @@ -PublishedMessage | @aleph-sdk/monorepo

Class PublishedMessage<C>

Type Parameters

Hierarchy (view full)

Constructors

constructor +PublishedMessage | @aleph-sdk/monorepo

Class PublishedMessage<C>

Type Parameters

Hierarchy (view full)

Constructors

constructor

Properties

chain channel? confirmations @@ -14,5 +14,5 @@

Methods

getBroadcastable getVerificationBuffer isOfType -

Constructors

constructor

Properties

chain

chain: Blockchain

Optional channel

channel?: string

confirmations

confirmations: MessageConfirmation[]

confirmed

confirmed: boolean

content

content: C

Optional item_content

item_content?: string

item_hash

item_hash: string

item_type

item_type: ItemType

sender

sender: string

signature

signature: string

time

time: number

type

type: keyof MessageTypeMap<C>

Methods

getBroadcastable

getVerificationBuffer

isOfType

Settings

Member Visibility

Theme

On This Page

constructorchainchannelconfirmationsconfirmedcontentitem_contentitem_hashitem_typesendersignaturetimetypegetBroadcastablegetVerificationBufferisOfType

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

chain

chain: Blockchain

Optional channel

channel?: string

confirmations

confirmations: MessageConfirmation[]

confirmed

confirmed: boolean

content

content: C

Optional item_content

item_content?: string

item_hash

item_hash: string

item_type

item_type: ItemType

sender

sender: string

signature

signature: string

time

time: number

type

type: keyof MessageTypeMap<C>

Methods

getBroadcastable

getVerificationBuffer

isOfType

Settings

Member Visibility

Theme

On This Page

constructorchainchannelconfirmationsconfirmedcontentitem_contentitem_hashitem_typesendersignaturetimetypegetBroadcastablegetVerificationBufferisOfType

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/message_src.QueryError.html b/docs/classes/message_src.QueryError.html index 8e43b84a..16907a1b 100644 --- a/docs/classes/message_src.QueryError.html +++ b/docs/classes/message_src.QueryError.html @@ -1,2 +1,2 @@ -QueryError | @aleph-sdk/monorepo

Class QueryError

Hierarchy (view full)

Constructors

constructor -

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor

Generated using TypeDoc

\ No newline at end of file +QueryError | @aleph-sdk/monorepo

Class QueryError

Hierarchy (view full)

Constructors

constructor +

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

constructor

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/message_src.SignedMessage.html b/docs/classes/message_src.SignedMessage.html index 60197338..580a6be8 100644 --- a/docs/classes/message_src.SignedMessage.html +++ b/docs/classes/message_src.SignedMessage.html @@ -1,4 +1,4 @@ -SignedMessage | @aleph-sdk/monorepo

Class SignedMessage<C>

Type Parameters

Hierarchy (view full)

Constructors

constructor +SignedMessage | @aleph-sdk/monorepo

Class SignedMessage<C>

Type Parameters

Hierarchy (view full)

Constructors

constructor

Properties

chain channel? content @@ -12,5 +12,5 @@

Methods

getBroadcastable getVerificationBuffer isOfType -

Constructors

constructor

Properties

chain

chain: Blockchain

Optional channel

channel?: string

content

content: C

Optional item_content

item_content?: string

item_hash

item_hash: string

item_type

item_type: ItemType

sender

sender: string

signature

signature: string

time

time: number

type

type: keyof MessageTypeMap<C>

Methods

getBroadcastable

  • getBroadcastable(): Omit<SignedMessage<C>, "getVerificationBuffer" | "content" | "isOfType" | "getBroadcastable">

  • Returns a message that can be broadcast to the network

    -

    Returns Omit<SignedMessage<C>, "getVerificationBuffer" | "content" | "isOfType" | "getBroadcastable">

getVerificationBuffer

isOfType

Settings

Member Visibility

Theme

On This Page

constructorchainchannelcontentitem_contentitem_hashitem_typesendersignaturetimetypegetBroadcastablegetVerificationBufferisOfType

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

chain

chain: Blockchain

Optional channel

channel?: string

content

content: C

Optional item_content

item_content?: string

item_hash

item_hash: string

item_type

item_type: ItemType

sender

sender: string

signature

signature: string

time

time: number

type

type: keyof MessageTypeMap<C>

Methods

getBroadcastable

  • getBroadcastable(): Omit<SignedMessage<C>, "getVerificationBuffer" | "content" | "isOfType" | "getBroadcastable">

  • Returns a message that can be broadcast to the network

    +

    Returns Omit<SignedMessage<C>, "getVerificationBuffer" | "content" | "isOfType" | "getBroadcastable">

getVerificationBuffer

isOfType

Settings

Member Visibility

Theme

On This Page

constructorchainchannelcontentitem_contentitem_hashitem_typesendersignaturetimetypegetBroadcastablegetVerificationBufferisOfType

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/message_src.StoreMessageClient.html b/docs/classes/message_src.StoreMessageClient.html index e1f5a642..bf7b7e66 100644 --- a/docs/classes/message_src.StoreMessageClient.html +++ b/docs/classes/message_src.StoreMessageClient.html @@ -1,4 +1,4 @@ -StoreMessageClient | @aleph-sdk/monorepo

Class StoreMessageClient

Constructors

constructor +StoreMessageClient | @aleph-sdk/monorepo

Class StoreMessageClient

Constructors

constructor

Properties

apiServer

Methods

download getHash @@ -6,12 +6,12 @@ processFileObject send uploadStore -

Constructors

constructor

Properties

apiServer

apiServer: string

Methods

download

  • download(fileHash): Promise<ArrayBuffer>

  • Retrieves a file from the network.

    +

Constructors

constructor

Properties

apiServer

apiServer: string

Methods

download

  • download(fileHash): Promise<ArrayBuffer>

  • Retrieves a file from the network.

    Parameters

    • fileHash: string

      The item_hash of the STORE message of the file to retrieve.

      -

    Returns Promise<ArrayBuffer>

Protected getHash

  • getHash(buffer, storageEngine, fileHash, apiServer): Promise<string>

  • Parameters

    • buffer: Buffer | Uint8Array
    • storageEngine: ItemType
    • fileHash: undefined | string
    • apiServer: string

    Returns Promise<string>

pin

  • pin(spc): Promise<StoreMessage>

  • Publishes a store message, containing a hash to pin an IPFS file. +

Returns Promise<ArrayBuffer>

Protected getHash

  • getHash(buffer, storageEngine, fileHash, apiServer): Promise<string>

  • Parameters

    • buffer: Buffer | Uint8Array
    • storageEngine: ItemType
    • fileHash: undefined | string
    • apiServer: string

    Returns Promise<string>

pin

Protected processFileObject

  • processFileObject(fileObject): Promise<Buffer | Uint8Array>

  • Parameters

    • fileObject: undefined | null | Buffer | Uint8Array | Blob | File

    Returns Promise<Buffer | Uint8Array>

send

  • send(spc): Promise<StoreMessage>

  • Publishes a store message, containing a File. +

Returns Promise<StoreMessage>

Protected processFileObject

send

Protected uploadStore

Settings

Member Visibility

Theme

On This Page

constructorapiServerdownloadgetHashpinprocessFileObjectsenduploadStore

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<StoreMessage>

Protected uploadStore

Settings

Member Visibility

Theme

On This Page

constructorapiServerdownloadgetHashpinprocessFileObjectsenduploadStore

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/nuls2_src.NULS2Account.html b/docs/classes/nuls2_src.NULS2Account.html index 996e6474..ced2e127 100644 --- a/docs/classes/nuls2_src.NULS2Account.html +++ b/docs/classes/nuls2_src.NULS2Account.html @@ -1,6 +1,6 @@ NULS2Account | @aleph-sdk/monorepo

Class NULS2Account

NULS2Account implements the Account class for the NULS2 protocol. It is used to represent a NULS2 account when publishing a message on the Aleph network.

-

Hierarchy

  • ECIESAccount
    • NULS2Account

Constructors

constructor +

Hierarchy

  • ECIESAccount
    • NULS2Account

Constructors

constructor

Properties

address publicKey

Methods

askPubKey @@ -11,23 +11,23 @@ addressFromHash magicHash publicKeyToHash -

Constructors

constructor

Properties

Readonly address

address: string

publicKey

publicKey: undefined | string

Methods

askPubKey

  • askPubKey(): Promise<void>

  • Ask for a Provider Account a read Access to its encryption publicKey. +

Constructors

constructor

Properties

Readonly address

address: string

publicKey

publicKey: undefined | string

Methods

askPubKey

  • askPubKey(): Promise<void>

  • Ask for a Provider Account a read Access to its encryption publicKey. As NULS2 currently doesn't support instantiation through a provider, this method has no effect.

    -

    Returns Promise<void>

decrypt

  • decrypt(encryptedContent): Promise<Buffer>

  • Decrypt a given content using a NULS2 account.

    +

    Returns Promise<void>

decrypt

  • decrypt(encryptedContent): Promise<Buffer>

  • Decrypt a given content using a NULS2 account.

    Parameters

    • encryptedContent: string | Buffer

      The encrypted content to decrypt.

      -

    Returns Promise<Buffer>

encrypt

  • encrypt(content, delegateSupport?): Promise<Buffer>

  • Encrypt a content using the user's public key for a NULS2 account.

    +

Returns Promise<Buffer>

encrypt

  • encrypt(content, delegateSupport?): Promise<Buffer>

  • Encrypt a content using the user's public key for a NULS2 account.

    Parameters

    • content: Buffer

      The content to encrypt.

    • Optional delegateSupport: string | ECIESAccount

      Optional, if you want to encrypt data for another ECIESAccount (Can also be directly a public key)

      -

    Returns Promise<Buffer>

getChain

sign

  • sign(message): Promise<string>

  • The Sign method provides a way to sign a given Aleph message using a NULS2 account. +

Returns Promise<Buffer>

getChain

sign

Static addressFromHash

Returns Promise<string>

Static addressFromHash

Static magicHash

Returns string

Static magicHash

Static publicKeyToHash

Returns Buffer

Static publicKeyToHash

Settings

Member Visibility

Theme

On This Page

constructoraddresspublicKeyaskPubKeydecryptencryptgetChainsignaddressFromHashmagicHashpublicKeyToHash

Generated using TypeDoc

\ No newline at end of file +
  • __namedParameters: ChainNAddress = ...

    • Returns Buffer

    Settings

    Member Visibility

    Theme

    On This Page

    constructoraddresspublicKeyaskPubKeydecryptencryptgetChainsignaddressFromHashmagicHashpublicKeyToHash

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/solana_src.SOLAccount.html b/docs/classes/solana_src.SOLAccount.html index 3b82e71f..fb8b61ee 100644 --- a/docs/classes/solana_src.SOLAccount.html +++ b/docs/classes/solana_src.SOLAccount.html @@ -1,13 +1,13 @@ SOLAccount | @aleph-sdk/monorepo

    Class SOLAccount

    SOLAccount implements the Account class for the Solana protocol. It is used to represent a solana account when publishing a message on the Aleph network.

    -

    Hierarchy

    • Account
      • SOLAccount

    Constructors

    constructor +

    Hierarchy

    • Account
      • SOLAccount

    Constructors

    constructor

    Properties

    address isKeypair

    Methods

    getChain sign -

    Constructors

    constructor

    Properties

    Readonly address

    address: string

    isKeypair

    isKeypair: boolean

    Methods

    getChain

    sign

    • sign(message): Promise<string>

    • The Sign method provides a way to sign a given Aleph message using an solana account. +

    Constructors

    constructor

    Properties

    Readonly address

    address: string

    isKeypair

    isKeypair: boolean

    Methods

    getChain

    sign

    • sign(message): Promise<string>

    • The Sign method provides a way to sign a given Aleph message using an solana account. The full message is not used as the payload, only fields of the BaseMessage type are.

      nacl is used to sign the payload with the account's private key. The final message's signature is composed of the signed payload and the user's public key.

      Parameters

      • message: SignableMessage

        The Aleph message to sign, using some of its fields.

        -

      Returns Promise<string>

    Settings

    Member Visibility

    Theme

    On This Page

    constructoraddressisKeypairgetChainsign

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<string>

    Settings

    Member Visibility

    Theme

    On This Page

    constructoraddressisKeypairgetChainsign

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/substrate_src.DOTAccount.html b/docs/classes/substrate_src.DOTAccount.html index 5c816156..daf49cd1 100644 --- a/docs/classes/substrate_src.DOTAccount.html +++ b/docs/classes/substrate_src.DOTAccount.html @@ -1,11 +1,11 @@ DOTAccount | @aleph-sdk/monorepo

    Class DOTAccount

    DOTAccount implements the Account class for the substrate protocol. It is used to represent a substrate account when publishing a message on the Aleph network.

    -

    Hierarchy

    • Account
      • DOTAccount

    Constructors

    constructor +

    Hierarchy

    • Account
      • DOTAccount

    Constructors

    constructor

    Properties

    address

    Methods

    getChain sign -

    Constructors

    constructor

    Properties

    Readonly address

    address: string

    Methods

    getChain

    sign

    • sign(message): Promise<string>

    • The Sign method provides a way to sign a given Aleph message using a substrate account. +

    Constructors

    constructor

    Properties

    Readonly address

    address: string

    Methods

    getChain

    sign

    • sign(message): Promise<string>

    • The Sign method provides a way to sign a given Aleph message using a substrate account. The full message is not used as the payload, only fields of the BaseMessage type are.

      The sign method of the package 'polkadot' is used as the signature method.

      Parameters

      • message: SignableMessage

        The Aleph message to sign, using some of its fields.

        -

      Returns Promise<string>

    Settings

    Member Visibility

    Theme

    On This Page

    constructoraddressgetChainsign

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<string>

    Settings

    Member Visibility

    Theme

    On This Page

    constructoraddressgetChainsign

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/superfluid_src.SuperfluidAccount.html b/docs/classes/superfluid_src.SuperfluidAccount.html index bbcfbec5..e223ce60 100644 --- a/docs/classes/superfluid_src.SuperfluidAccount.html +++ b/docs/classes/superfluid_src.SuperfluidAccount.html @@ -1,6 +1,6 @@ SuperfluidAccount | @aleph-sdk/monorepo

    Class SuperfluidAccount

    SuperfluidAccount implements the Account class for the Superfluid protocol, now for AVAX and BASE chains. It is used to represent a Superfluid account when publishing a message on the Aleph network.

    -

    Hierarchy

    • EVMAccount
      • SuperfluidAccount

    Constructors

    constructor +

    Hierarchy

    • EVMAccount
      • SuperfluidAccount

    Constructors

    constructor

    Properties

    address publicKey selectedRpcId? @@ -17,13 +17,13 @@ increaseALEPHFlow init sign -

    Constructors

    constructor

    Properties

    Readonly address

    address: string

    publicKey

    publicKey: undefined | string

    Optional selectedRpcId

    selectedRpcId?: RpcId

    wallet

    wallet: JsonRPCWallet

    Methods

    askPubKey

    changeNetwork

    • changeNetwork(chainOrRpc?): Promise<void>

    • Parameters

      • Optional chainOrRpc: RpcId | RpcType

      Returns Promise<void>

    decreaseALEPHFlow

    • decreaseALEPHFlow(receiver, alephPerHour): Promise<void>

    • Decrease the ALEPH flow rate to a given receiver. Deletes the flow if the new flow rate is 0.

      +

    Constructors

    constructor

    Properties

    Readonly address

    address: string

    publicKey

    publicKey: undefined | string

    Optional selectedRpcId

    selectedRpcId?: RpcId

    wallet

    wallet: JsonRPCWallet

    Methods

    askPubKey

    changeNetwork

    • changeNetwork(chainOrRpc?): Promise<void>

    • Parameters

      • Optional chainOrRpc: RpcId | RpcType

      Returns Promise<void>

    decreaseALEPHFlow

    • decreaseALEPHFlow(receiver, alephPerHour): Promise<void>

    • Decrease the ALEPH flow rate to a given receiver. Deletes the flow if the new flow rate is 0.

      Parameters

      • receiver: string

        The receiver address.

      • alephPerHour: number | Decimal

        The amount of ALEPH per hour to decrease the flow by.

        -

      Returns Promise<void>

    getALEPHBalance

    • getALEPHBalance(): Promise<Decimal>

    • Get the ALEPH balance of the account.

      -

      Returns Promise<Decimal>

    getALEPHFlow

    • getALEPHFlow(receiver): Promise<Decimal>

    • Get the ALEPH flow rate to a given receiver in ALEPH per hour.

      +

    Returns Promise<void>

    getALEPHBalance

    • getALEPHBalance(): Promise<Decimal>

    • Get the ALEPH balance of the account.

      +

      Returns Promise<Decimal>

    getALEPHFlow

    • getALEPHFlow(receiver): Promise<Decimal>

    • Get the ALEPH flow rate to a given receiver in ALEPH per hour.

      Parameters

      • receiver: string

        The receiver address.

        -

      Returns Promise<Decimal>

    getChain

    getChainId

    • getChainId(): Promise<number>

    • Returns Promise<number>

    getRpcId

    • getRpcId(): Promise<RpcId>

    • Returns Promise<RpcId>

    getRpcUrl

    • getRpcUrl(): string

    • Returns string

    increaseALEPHFlow

    • increaseALEPHFlow(receiver, alephPerHour): Promise<void>

    • Increase the ALEPH flow rate to a given receiver. Creates a new flow if none exists.

      +

    Returns Promise<Decimal>

    getChain

    getChainId

    getRpcId

    getRpcUrl

    increaseALEPHFlow

    init

    sign

    Settings

    Member Visibility

    Theme

    On This Page

    constructoraddresspublicKeyselectedRpcIdwalletaskPubKeychangeNetworkdecreaseALEPHFlowgetALEPHBalancegetALEPHFlowgetChaingetChainIdgetRpcIdgetRpcUrlincreaseALEPHFlowinitsign

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    init

    sign

    Settings

    Member Visibility

    Theme

    On This Page

    constructoraddresspublicKeyselectedRpcIdwalletaskPubKeychangeNetworkdecreaseALEPHFlowgetALEPHBalancegetALEPHFlowgetChaingetChainIdgetRpcIdgetRpcUrlincreaseALEPHFlowinitsign

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/tezos_src.TEZOSAccount.html b/docs/classes/tezos_src.TEZOSAccount.html index 1bf417ee..8fee4424 100644 --- a/docs/classes/tezos_src.TEZOSAccount.html +++ b/docs/classes/tezos_src.TEZOSAccount.html @@ -1,6 +1,6 @@ TEZOSAccount | @aleph-sdk/monorepo

    Class TEZOSAccount

    XTZAccount implements the Account class for the Tezos protocol. It is used to represent a Tezos account when publishing a message on the Aleph network.

    -

    Hierarchy

    • Account
      • TEZOSAccount

    Constructors

    constructor +

    Hierarchy

    • Account
      • TEZOSAccount

    Constructors

    constructor

    Properties

    address dAppUrl

    Methods

    GetPublicKey @@ -10,9 +10,9 @@
  • wallet: BeaconWallet | InMemorySigner

    The signer containing the private key used to sign the message.

  • Optional dAppUrl: string

    The URL of the dApp that is publishing the message. Defaults to "aleph.im". Used by wallets to display the requester of the signature.

    -

    • Returns TEZOSAccount

    Properties

    Readonly address

    address: string

    dAppUrl

    dAppUrl: string

    Methods

    GetPublicKey

    getChain

    sign

    • sign(message): Promise<string>

    • The Sign method provides a way to sign a given Aleph message using a Tezos account. +

    Returns TEZOSAccount

    Properties

    Readonly address

    address: string

    dAppUrl

    dAppUrl: string

    Methods

    GetPublicKey

    getChain

    sign

    • sign(message): Promise<string>

    • The Sign method provides a way to sign a given Aleph message using a Tezos account. The full message is not used as the payload, only fields of the BaseMessage type are.

      nacl is used to sign the payload with the account's private key. The final message's signature is composed of the signed payload and the user's public key.

      Parameters

      • message: SignableMessage

        The Aleph message to sign, using some of its fields.

        -

      Returns Promise<string>

    Settings

    Member Visibility

    Theme

    On This Page

    constructoraddressdAppUrlGetPublicKeygetChainsign

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<string>

    Settings

    Member Visibility

    Theme

    On This Page

    constructoraddressdAppUrlGetPublicKeygetChainsign

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/avalanche_src.ChainType.html b/docs/enums/avalanche_src.ChainType.html index b8f7b802..92649215 100644 --- a/docs/enums/avalanche_src.ChainType.html +++ b/docs/enums/avalanche_src.ChainType.html @@ -1,3 +1,3 @@ -ChainType | @aleph-sdk/monorepo

    Enumeration ChainType

    Enumeration Members

    C_CHAIN +ChainType | @aleph-sdk/monorepo

    Enumeration ChainType

    Enumeration Members

    C_CHAIN X_CHAIN -

    Enumeration Members

    C_CHAIN

    C_CHAIN: "C"

    X_CHAIN

    X_CHAIN: "X"

    Settings

    Member Visibility

    Theme

    On This Page

    C_CHAINX_CHAIN

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    C_CHAIN

    C_CHAIN: "C"

    X_CHAIN

    X_CHAIN: "X"

    Settings

    Member Visibility

    Theme

    On This Page

    C_CHAINX_CHAIN

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/core_src.Blockchain.html b/docs/enums/core_src.Blockchain.html index 9a532d1e..115dc8ef 100644 --- a/docs/enums/core_src.Blockchain.html +++ b/docs/enums/core_src.Blockchain.html @@ -1,4 +1,4 @@ -Blockchain | @aleph-sdk/monorepo

    Enumeration Blockchain

    Enumeration Members

    AVAX +Blockchain | @aleph-sdk/monorepo

    Enumeration Blockchain

    Enumeration Members

    AVAX BASE CSDK DOT @@ -7,4 +7,4 @@ NULS2 SOL TEZOS -

    Enumeration Members

    AVAX

    AVAX: "AVAX"

    BASE

    BASE: "BASE"

    CSDK

    CSDK: "CSDK"

    DOT

    DOT: "DOT"

    ETH

    ETH: "ETH"

    NULS

    NULS: "NULS"

    NULS2

    NULS2: "NULS2"

    SOL

    SOL: "SOL"

    TEZOS

    TEZOS: "TEZOS"

    Settings

    Member Visibility

    Theme

    On This Page

    AVAXBASECSDKDOTETHNULSNULS2SOLTEZOS

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    AVAX

    AVAX: "AVAX"

    BASE

    BASE: "BASE"

    CSDK

    CSDK: "CSDK"

    DOT

    DOT: "DOT"

    ETH

    ETH: "ETH"

    NULS

    NULS: "NULS"

    NULS2

    NULS2: "NULS2"

    SOL

    SOL: "SOL"

    TEZOS

    TEZOS: "TEZOS"

    Settings

    Member Visibility

    Theme

    On This Page

    AVAXBASECSDKDOTETHNULSNULS2SOLTEZOS

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/dns_src.TargetType.html b/docs/enums/dns_src.TargetType.html index 5c34775c..b4e9b7e2 100644 --- a/docs/enums/dns_src.TargetType.html +++ b/docs/enums/dns_src.TargetType.html @@ -1,4 +1,4 @@ -TargetType | @aleph-sdk/monorepo

    Enumeration TargetType

    Enumeration Members

    INSTANCE +TargetType | @aleph-sdk/monorepo

    Enumeration TargetType

    Enumeration Members

    INSTANCE IPFS PROGRAM -

    Enumeration Members

    INSTANCE

    INSTANCE: "instance"

    IPFS

    IPFS: "ipfs"

    PROGRAM

    PROGRAM: "program"

    Settings

    Member Visibility

    Theme

    On This Page

    INSTANCEIPFSPROGRAM

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    INSTANCE

    INSTANCE: "instance"

    IPFS

    IPFS: "ipfs"

    PROGRAM

    PROGRAM: "program"

    Settings

    Member Visibility

    Theme

    On This Page

    INSTANCEIPFSPROGRAM

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/evm_src.RpcId.html b/docs/enums/evm_src.RpcId.html index 5c4b91dd..1e595072 100644 --- a/docs/enums/evm_src.RpcId.html +++ b/docs/enums/evm_src.RpcId.html @@ -1,4 +1,4 @@ -RpcId | @aleph-sdk/monorepo

    Enumeration RpcId

    Enumeration Members

    AVAX +RpcId | @aleph-sdk/monorepo

    Enumeration RpcId

    Enumeration Members

    AVAX AVAX_TESTNET BASE BASE_TESTNET @@ -7,4 +7,4 @@ ETH_FLASHBOTS ETH_SEPOLIA POLYGON -

    Enumeration Members

    AVAX

    AVAX: 3

    AVAX_TESTNET

    AVAX_TESTNET: 4

    BASE

    BASE: 5

    BASE_TESTNET

    BASE_TESTNET: 6

    BSC

    BSC: 8

    ETH

    ETH: 0

    ETH_FLASHBOTS

    ETH_FLASHBOTS: 1

    ETH_SEPOLIA

    ETH_SEPOLIA: 2

    POLYGON

    POLYGON: 7

    Settings

    Member Visibility

    Theme

    On This Page

    AVAXAVAX_TESTNETBASEBASE_TESTNETBSCETHETH_FLASHBOTSETH_SEPOLIAPOLYGON

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    AVAX

    AVAX: 3

    AVAX_TESTNET

    AVAX_TESTNET: 4

    BASE

    BASE: 5

    BASE_TESTNET

    BASE_TESTNET: 6

    BSC

    BSC: 8

    ETH

    ETH: 0

    ETH_FLASHBOTS

    ETH_FLASHBOTS: 1

    ETH_SEPOLIA

    ETH_SEPOLIA: 2

    POLYGON

    POLYGON: 7

    Settings

    Member Visibility

    Theme

    On This Page

    AVAXAVAX_TESTNETBASEBASE_TESTNETBSCETHETH_FLASHBOTSETH_SEPOLIAPOLYGON

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/message_src.Encoding.html b/docs/enums/message_src.Encoding.html index 6434e36f..e0d5def5 100644 --- a/docs/enums/message_src.Encoding.html +++ b/docs/enums/message_src.Encoding.html @@ -1,4 +1,4 @@ -Encoding | @aleph-sdk/monorepo

    Enumeration Encoding

    Enumeration Members

    plain +Encoding | @aleph-sdk/monorepo

    Enumeration Encoding

    Enumeration Members

    plain squashfs zip -

    Enumeration Members

    plain

    plain: "plain"

    squashfs

    squashfs: "squashfs"

    zip

    zip: "zip"

    Settings

    Member Visibility

    Theme

    On This Page

    plainsquashfszip

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    plain

    plain: "plain"

    squashfs

    squashfs: "squashfs"

    zip

    zip: "zip"

    Settings

    Member Visibility

    Theme

    On This Page

    plainsquashfszip

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/message_src.HypervisorType.html b/docs/enums/message_src.HypervisorType.html index 76ce1760..dca6396d 100644 --- a/docs/enums/message_src.HypervisorType.html +++ b/docs/enums/message_src.HypervisorType.html @@ -1,3 +1,3 @@ -HypervisorType | @aleph-sdk/monorepo

    Enumeration HypervisorType

    Enumeration Members

    firecracker +HypervisorType | @aleph-sdk/monorepo

    Enumeration HypervisorType

    Enumeration Members

    firecracker qemu -

    Enumeration Members

    firecracker

    firecracker: "firecracker"

    qemu

    qemu: "qemu"

    Settings

    Member Visibility

    Theme

    On This Page

    firecrackerqemu

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    firecracker

    firecracker: "firecracker"

    qemu

    qemu: "qemu"

    Settings

    Member Visibility

    Theme

    On This Page

    firecrackerqemu

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/message_src.InterfaceType.html b/docs/enums/message_src.InterfaceType.html index 23bebada..eb36c837 100644 --- a/docs/enums/message_src.InterfaceType.html +++ b/docs/enums/message_src.InterfaceType.html @@ -1,3 +1,3 @@ -InterfaceType | @aleph-sdk/monorepo

    Enumeration InterfaceType

    Enumeration Members

    asgi +InterfaceType | @aleph-sdk/monorepo

    Enumeration InterfaceType

    Enumeration Members

    asgi binary -

    Enumeration Members

    asgi

    asgi: "asgi"

    binary

    binary: "binary"

    Settings

    Member Visibility

    Theme

    On This Page

    asgibinary

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    asgi

    asgi: "asgi"

    binary

    binary: "binary"

    Settings

    Member Visibility

    Theme

    On This Page

    asgibinary

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/message_src.ItemType.html b/docs/enums/message_src.ItemType.html index dacb0721..f1763aaf 100644 --- a/docs/enums/message_src.ItemType.html +++ b/docs/enums/message_src.ItemType.html @@ -1,4 +1,4 @@ -ItemType | @aleph-sdk/monorepo

    Enumeration ItemType

    Enumeration Members

    inline +ItemType | @aleph-sdk/monorepo

    Enumeration ItemType

    Enumeration Members

    inline ipfs storage -

    Enumeration Members

    inline

    inline: "inline"

    ipfs

    ipfs: "ipfs"

    storage

    storage: "storage"

    Settings

    Member Visibility

    Theme

    On This Page

    inlineipfsstorage

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    inline

    inline: "inline"

    ipfs

    ipfs: "ipfs"

    storage

    storage: "storage"

    Settings

    Member Visibility

    Theme

    On This Page

    inlineipfsstorage

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/message_src.MachineType.html b/docs/enums/message_src.MachineType.html index 8cfa3ca9..341a05a3 100644 --- a/docs/enums/message_src.MachineType.html +++ b/docs/enums/message_src.MachineType.html @@ -1,3 +1,3 @@ -MachineType | @aleph-sdk/monorepo

    Enumeration MachineType

    Enumeration Members

    vm_function +MachineType | @aleph-sdk/monorepo

    Enumeration MachineType

    Enumeration Members

    vm_function vm_instance -

    Enumeration Members

    vm_function

    vm_function: "vm-function"

    vm_instance

    vm_instance: "vm-instance"

    Settings

    Member Visibility

    Theme

    On This Page

    vm_functionvm_instance

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    vm_function

    vm_function: "vm-function"

    vm_instance

    vm_instance: "vm-instance"

    Settings

    Member Visibility

    Theme

    On This Page

    vm_functionvm_instance

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/message_src.MessageStatus.html b/docs/enums/message_src.MessageStatus.html index 9c5d0b35..c6570fbd 100644 --- a/docs/enums/message_src.MessageStatus.html +++ b/docs/enums/message_src.MessageStatus.html @@ -1,5 +1,5 @@ -MessageStatus | @aleph-sdk/monorepo

    Enumeration MessageStatus

    Enumeration Members

    forgotten +MessageStatus | @aleph-sdk/monorepo

    Enumeration MessageStatus

    Enumeration Members

    forgotten pending processed rejected -

    Enumeration Members

    forgotten

    forgotten: "forgotten"

    pending

    pending: "pending"

    processed

    processed: "processed"

    rejected

    rejected: "rejected"

    Settings

    Member Visibility

    Theme

    On This Page

    forgottenpendingprocessedrejected

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    forgotten

    forgotten: "forgotten"

    pending

    pending: "pending"

    processed

    processed: "processed"

    rejected

    rejected: "rejected"

    Settings

    Member Visibility

    Theme

    On This Page

    forgottenpendingprocessedrejected

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/message_src.MessageType.html b/docs/enums/message_src.MessageType.html index 81c719b3..5651769c 100644 --- a/docs/enums/message_src.MessageType.html +++ b/docs/enums/message_src.MessageType.html @@ -1,9 +1,9 @@ MessageType | @aleph-sdk/monorepo

    Enumeration MessageType

    Message types supported by Aleph

    Warning: Program is currently not supported by the TS sdk.

    -

    Enumeration Members

    aggregate +

    Enumeration Members

    aggregate forget instance post program store -

    Enumeration Members

    aggregate

    aggregate: "AGGREGATE"

    forget

    forget: "FORGET"

    instance

    instance: "INSTANCE"

    post

    post: "POST"

    program

    program: "PROGRAM"

    store

    store: "STORE"

    Settings

    Member Visibility

    Theme

    On This Page

    aggregateforgetinstancepostprogramstore

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    aggregate

    aggregate: "AGGREGATE"

    forget

    forget: "FORGET"

    instance

    instance: "INSTANCE"

    post

    post: "POST"

    program

    program: "PROGRAM"

    store

    store: "STORE"

    Settings

    Member Visibility

    Theme

    On This Page

    aggregateforgetinstancepostprogramstore

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/message_src.PaymentType.html b/docs/enums/message_src.PaymentType.html index 41cf2eac..174b90d3 100644 --- a/docs/enums/message_src.PaymentType.html +++ b/docs/enums/message_src.PaymentType.html @@ -1,4 +1,4 @@ PaymentType | @aleph-sdk/monorepo

    Enumeration PaymentType

    Payment Type concerning payment solution

    -

    Enumeration Members

    hold +

    Enumeration Members

    hold superfluid -

    Enumeration Members

    hold

    hold: "hold"

    superfluid

    superfluid: "superfluid"

    Settings

    Member Visibility

    Theme

    On This Page

    holdsuperfluid

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    hold

    hold: "hold"

    superfluid

    superfluid: "superfluid"

    Settings

    Member Visibility

    Theme

    On This Page

    holdsuperfluid

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/message_src.VolumePersistence.html b/docs/enums/message_src.VolumePersistence.html index aaad7d8c..f02a1058 100644 --- a/docs/enums/message_src.VolumePersistence.html +++ b/docs/enums/message_src.VolumePersistence.html @@ -1,3 +1,3 @@ -VolumePersistence | @aleph-sdk/monorepo

    Enumeration VolumePersistence

    Enumeration Members

    host +VolumePersistence | @aleph-sdk/monorepo

    Enumeration VolumePersistence

    Enumeration Members

    host store -

    Enumeration Members

    host

    host: "host"

    store

    store: "store"

    Settings

    Member Visibility

    Theme

    On This Page

    hoststore

    Generated using TypeDoc

    \ No newline at end of file +

    Enumeration Members

    host

    host: "host"

    store

    store: "store"

    Settings

    Member Visibility

    Theme

    On This Page

    hoststore

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/avalanche_src.digestMessage.html b/docs/functions/avalanche_src.digestMessage.html index 8761cfc4..1a9b1664 100644 --- a/docs/functions/avalanche_src.digestMessage.html +++ b/docs/functions/avalanche_src.digestMessage.html @@ -1 +1 @@ -digestMessage | @aleph-sdk/monorepo

    Function digestMessage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +digestMessage | @aleph-sdk/monorepo

    Function digestMessage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/avalanche_src.getAccountFromProvider.html b/docs/functions/avalanche_src.getAccountFromProvider.html index 62d2fd67..703610cb 100644 --- a/docs/functions/avalanche_src.getAccountFromProvider.html +++ b/docs/functions/avalanche_src.getAccountFromProvider.html @@ -1,3 +1,3 @@ getAccountFromProvider | @aleph-sdk/monorepo

    Function getAccountFromProvider

    • getAccountFromProvider(provider, requestedRpc?): Promise<AvalancheAccount>

    • Get an account from a Web3 provider (ex: Metamask)

      Parameters

      • provider: Web3Provider | ExternalProvider
      • requestedRpc: ChangeRpcParam = RpcId.AVAX

        Use this params to change the RPC endpoint;

        -

      Returns Promise<AvalancheAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<AvalancheAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/avalanche_src.getEVMAddress.html b/docs/functions/avalanche_src.getEVMAddress.html index f5a69e85..b4321f37 100644 --- a/docs/functions/avalanche_src.getEVMAddress.html +++ b/docs/functions/avalanche_src.getEVMAddress.html @@ -4,4 +4,4 @@ the function throws an error.

    Parameters

    Returns string

    A Promise that resolves to the EVM-style address of the account

    Throws

    An error if the current signer is not associated with the C-Chain

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/avalanche_src.getKeyPair.html b/docs/functions/avalanche_src.getKeyPair.html index 7598f250..6687d21a 100644 --- a/docs/functions/avalanche_src.getKeyPair.html +++ b/docs/functions/avalanche_src.getKeyPair.html @@ -1 +1 @@ -getKeyPair | @aleph-sdk/monorepo

    Function getKeyPair

    • getKeyPair(privateKey?, chain?): Promise<KeyPair>

    • Parameters

      • Optional privateKey: string
      • chain: ChainType = ChainType.C_CHAIN

      Returns Promise<KeyPair>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +getKeyPair | @aleph-sdk/monorepo

    Function getKeyPair

    • getKeyPair(privateKey?, chain?): Promise<KeyPair>

    • Parameters

      • Optional privateKey: string
      • chain: ChainType = ChainType.C_CHAIN

      Returns Promise<KeyPair>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/avalanche_src.importAccountFromMnemonic.html b/docs/functions/avalanche_src.importAccountFromMnemonic.html index afd8b3c2..c98f79f2 100644 --- a/docs/functions/avalanche_src.importAccountFromMnemonic.html +++ b/docs/functions/avalanche_src.importAccountFromMnemonic.html @@ -3,4 +3,4 @@

    Parameters

    Returns Promise<AvalancheAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<AvalancheAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/avalanche_src.importAccountFromPrivateKey.html b/docs/functions/avalanche_src.importAccountFromPrivateKey.html index b73575b8..11859f1d 100644 --- a/docs/functions/avalanche_src.importAccountFromPrivateKey.html +++ b/docs/functions/avalanche_src.importAccountFromPrivateKey.html @@ -2,4 +2,4 @@

    It creates an Avalanche keypair containing information about the account, extracted in the AvalancheAccount constructor.

    Parameters

    Returns Promise<AvalancheAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<AvalancheAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/avalanche_src.newAccount.html b/docs/functions/avalanche_src.newAccount.html index f42cdf57..2e288320 100644 --- a/docs/functions/avalanche_src.newAccount.html +++ b/docs/functions/avalanche_src.newAccount.html @@ -1,2 +1,2 @@ newAccount | @aleph-sdk/monorepo

    Function newAccount

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<{
        account: AvalancheAccount;
        privateKey: string;
    }>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/avalanche_src.verifyAvalanche.html b/docs/functions/avalanche_src.verifyAvalanche.html index 85c681a8..068fca13 100644 --- a/docs/functions/avalanche_src.verifyAvalanche.html +++ b/docs/functions/avalanche_src.verifyAvalanche.html @@ -3,4 +3,4 @@

    Parameters

    Returns Promise<boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/base_src.getAccountFromProvider.html b/docs/functions/base_src.getAccountFromProvider.html index 6ab5b6d9..76d45ab5 100644 --- a/docs/functions/base_src.getAccountFromProvider.html +++ b/docs/functions/base_src.getAccountFromProvider.html @@ -1,3 +1,3 @@ getAccountFromProvider | @aleph-sdk/monorepo

    Function getAccountFromProvider

    • getAccountFromProvider(provider, requestedRpc?): Promise<BaseAccount>

    • Get an account from a Web3 provider (ex: Metamask)

      Parameters

      • provider: Web3Provider | ExternalProvider
      • requestedRpc: ChangeRpcParam = RpcId.BASE

        Use this params to change the RPC endpoint;

        -

      Returns Promise<BaseAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<BaseAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/base_src.importAccountFromMnemonic.html b/docs/functions/base_src.importAccountFromMnemonic.html index 7d99cb70..2281560d 100644 --- a/docs/functions/base_src.importAccountFromMnemonic.html +++ b/docs/functions/base_src.importAccountFromMnemonic.html @@ -2,4 +2,4 @@

    It creates an Base wallet containing information about the account, extracted in the BaseAccount constructor.

    Parameters

    Returns BaseAccount

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns BaseAccount

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/base_src.importAccountFromPrivateKey.html b/docs/functions/base_src.importAccountFromPrivateKey.html index 2e33433f..84824f78 100644 --- a/docs/functions/base_src.importAccountFromPrivateKey.html +++ b/docs/functions/base_src.importAccountFromPrivateKey.html @@ -1,4 +1,4 @@ importAccountFromPrivateKey | @aleph-sdk/monorepo

    Function importAccountFromPrivateKey

    • importAccountFromPrivateKey(privateKey): BaseAccount

    • Imports an Base account given a private key and the 'ethers' package.

      It creates an Base wallet containing information about the account, extracted in the BaseAccount constructor.

      Parameters

      • privateKey: string

        The private key of the account to import.

        -

      Returns BaseAccount

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns BaseAccount

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/base_src.newAccount.html b/docs/functions/base_src.newAccount.html index 9b5ae5ec..c9ef3697 100644 --- a/docs/functions/base_src.newAccount.html +++ b/docs/functions/base_src.newAccount.html @@ -1,2 +1,2 @@ newAccount | @aleph-sdk/monorepo

    Function newAccount

    • newAccount(derivationPath?): {
          account: BaseAccount;
          mnemonic: string;
      }

    • Creates a new Base account using a generated mnemonic following BIP 39 standard.

      -

      Parameters

      • derivationPath: string = "m/44'/60'/0'/0/0"

      Returns {
          account: BaseAccount;
          mnemonic: string;
      }

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns {
        account: BaseAccount;
        mnemonic: string;
    }

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/core_src.delay.html b/docs/functions/core_src.delay.html index c2aec202..6949d3dd 100644 --- a/docs/functions/core_src.delay.html +++ b/docs/functions/core_src.delay.html @@ -1 +1 @@ -delay | @aleph-sdk/monorepo

    Function delay

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +delay | @aleph-sdk/monorepo

    Function delay

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/core_src.getSocketPath.html b/docs/functions/core_src.getSocketPath.html index 47776cc1..8fd18dc6 100644 --- a/docs/functions/core_src.getSocketPath.html +++ b/docs/functions/core_src.getSocketPath.html @@ -1,3 +1,3 @@ getSocketPath | @aleph-sdk/monorepo

    Function getSocketPath

    • getSocketPath(): string | undefined

    • Returns the content of the ALEPH_API_UNIX_SOCKET environment variable or undefined.

      -

      Returns string | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns string | undefined

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/core_src.gigabyteToMebibyte.html b/docs/functions/core_src.gigabyteToMebibyte.html index 3e685075..5b3ebf59 100644 --- a/docs/functions/core_src.gigabyteToMebibyte.html +++ b/docs/functions/core_src.gigabyteToMebibyte.html @@ -1 +1 @@ -gigabyteToMebibyte | @aleph-sdk/monorepo

    Function gigabyteToMebibyte

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +gigabyteToMebibyte | @aleph-sdk/monorepo

    Function gigabyteToMebibyte

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/core_src.isNode.html b/docs/functions/core_src.isNode.html index e753b8af..a90d26db 100644 --- a/docs/functions/core_src.isNode.html +++ b/docs/functions/core_src.isNode.html @@ -2,4 +2,4 @@ if there is Node version in the environnement variable AND if window is already defined

    -

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/core_src.stripTrailingSlash.html b/docs/functions/core_src.stripTrailingSlash.html index ef6cf016..f7797089 100644 --- a/docs/functions/core_src.stripTrailingSlash.html +++ b/docs/functions/core_src.stripTrailingSlash.html @@ -1,2 +1,2 @@ stripTrailingSlash | @aleph-sdk/monorepo

    Function stripTrailingSlash

    • stripTrailingSlash(url): string

    • Strips any remaining trailing slashes or whitespaces at the end of a provided url

      -

      Parameters

      • url: string

      Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/cosmos_src.importAccountFromMnemonic.html b/docs/functions/cosmos_src.importAccountFromMnemonic.html index 18541363..bb4d043d 100644 --- a/docs/functions/cosmos_src.importAccountFromMnemonic.html +++ b/docs/functions/cosmos_src.importAccountFromMnemonic.html @@ -1,4 +1,4 @@ importAccountFromMnemonic | @aleph-sdk/monorepo

    Function importAccountFromMnemonic

    • importAccountFromMnemonic(mnemonic, options?): Promise<CosmosAccount>

    • Imports a Cosmos Account using a mnemonic

      Parameters

      • mnemonic: string

        The mnemonic to import

      • Optional options: Partial<Secp256k1HdWalletOptions>

        The options to generate the wallet

        -

      Returns Promise<CosmosAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<CosmosAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/cosmos_src.importAccountFromPrivateKey.html b/docs/functions/cosmos_src.importAccountFromPrivateKey.html index f8e63ef2..099ad0bc 100644 --- a/docs/functions/cosmos_src.importAccountFromPrivateKey.html +++ b/docs/functions/cosmos_src.importAccountFromPrivateKey.html @@ -1,4 +1,4 @@ importAccountFromPrivateKey | @aleph-sdk/monorepo

    Function importAccountFromPrivateKey

    • importAccountFromPrivateKey(privateKey, prefix?): Promise<CosmosAccount>

    • Import a Cosmos Account using a private Key

      Parameters

      • privateKey: string

        The private key to import

      • Optional prefix: string

        The prefix of the network

        -

      Returns Promise<CosmosAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<CosmosAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/cosmos_src.newAccount.html b/docs/functions/cosmos_src.newAccount.html index a51824ee..b371f803 100644 --- a/docs/functions/cosmos_src.newAccount.html +++ b/docs/functions/cosmos_src.newAccount.html @@ -1,4 +1,4 @@ newAccount | @aleph-sdk/monorepo

    Function newAccount

    • newAccount(length?, options?): Promise<{
          account: CosmosAccount;
          mnemonic: string;
      }>

    • Creates a new random Cosmos Account from a randomly generated mnemonic

      Parameters

      • Optional length: 12 | 15 | 18 | 21 | 24

        The length of the mnemonic

      • Optional options: Partial<Secp256k1HdWalletOptions>

        The options to generate the wallet

        -

      Returns Promise<{
          account: CosmosAccount;
          mnemonic: string;
      }>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<{
        account: CosmosAccount;
        mnemonic: string;
    }>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/cosmos_src.verifyCosmos.html b/docs/functions/cosmos_src.verifyCosmos.html index d314bf13..1f09bd56 100644 --- a/docs/functions/cosmos_src.verifyCosmos.html +++ b/docs/functions/cosmos_src.verifyCosmos.html @@ -2,4 +2,4 @@ This method rely on the ethers.utils.verifyMessage() implementation.

    Parameters

    Returns Promise<boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<boolean>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/dns_src.hostnameFromUrl.html b/docs/functions/dns_src.hostnameFromUrl.html index 53bc8b9a..49f71582 100644 --- a/docs/functions/dns_src.hostnameFromUrl.html +++ b/docs/functions/dns_src.hostnameFromUrl.html @@ -1 +1 @@ -hostnameFromUrl | @aleph-sdk/monorepo

    Function hostnameFromUrl

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +hostnameFromUrl | @aleph-sdk/monorepo

    Function hostnameFromUrl

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/ethereum_ledger_src.GetAccountFromLedger.html b/docs/functions/ethereum_ledger_src.GetAccountFromLedger.html index 2c3a6505..3d784ec9 100644 --- a/docs/functions/ethereum_ledger_src.GetAccountFromLedger.html +++ b/docs/functions/ethereum_ledger_src.GetAccountFromLedger.html @@ -1,2 +1,2 @@ GetAccountFromLedger | @aleph-sdk/monorepo

    Function GetAccountFromLedger

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<ETHLedgerAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/ethereum_ledger_src.getTransport.html b/docs/functions/ethereum_ledger_src.getTransport.html index d385d466..de8af27f 100644 --- a/docs/functions/ethereum_ledger_src.getTransport.html +++ b/docs/functions/ethereum_ledger_src.getTransport.html @@ -1 +1 @@ -getTransport | @aleph-sdk/monorepo

    Function getTransport

    • getTransport(overrideEnvironment?): Promise<Transport>

    • Parameters

      • Optional overrideEnvironment: JSExecutionEnvironment

      Returns Promise<Transport>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +getTransport | @aleph-sdk/monorepo

    Function getTransport

    • getTransport(overrideEnvironment?): Promise<Transport>

    • Parameters

      • Optional overrideEnvironment: JSExecutionEnvironment

      Returns Promise<Transport>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/ethereum_src.getAccountFromProvider.html b/docs/functions/ethereum_src.getAccountFromProvider.html index 8cf310b2..b8290fb9 100644 --- a/docs/functions/ethereum_src.getAccountFromProvider.html +++ b/docs/functions/ethereum_src.getAccountFromProvider.html @@ -1,3 +1,3 @@ getAccountFromProvider | @aleph-sdk/monorepo

    Function getAccountFromProvider

    • getAccountFromProvider(provider, requestedRpc?): Promise<ETHAccount>

    • Get an account from a Web3 provider (ex: Metamask)

      Parameters

      • provider: Web3Provider | ExternalProvider
      • requestedRpc: ChangeRpcParam = RpcId.ETH

        Use this params to change the RPC endpoint;

        -

      Returns Promise<ETHAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<ETHAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/ethereum_src.importAccountFromMnemonic.html b/docs/functions/ethereum_src.importAccountFromMnemonic.html index 3aca29cc..33afddc1 100644 --- a/docs/functions/ethereum_src.importAccountFromMnemonic.html +++ b/docs/functions/ethereum_src.importAccountFromMnemonic.html @@ -2,4 +2,4 @@

    It creates an ethereum wallet containing information about the account, extracted in the ETHAccount constructor.

    Parameters

    Returns ETHAccount

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns ETHAccount

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/ethereum_src.importAccountFromPrivateKey.html b/docs/functions/ethereum_src.importAccountFromPrivateKey.html index 62aac122..f130abe7 100644 --- a/docs/functions/ethereum_src.importAccountFromPrivateKey.html +++ b/docs/functions/ethereum_src.importAccountFromPrivateKey.html @@ -1,4 +1,4 @@ importAccountFromPrivateKey | @aleph-sdk/monorepo

    Function importAccountFromPrivateKey

    • importAccountFromPrivateKey(privateKey): ETHAccount

    • Imports an ethereum account given a private key and the 'ethers' package.

      It creates an ethereum wallet containing information about the account, extracted in the ETHAccount constructor.

      Parameters

      • privateKey: string

        The private key of the account to import.

        -

      Returns ETHAccount

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns ETHAccount

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/ethereum_src.newAccount.html b/docs/functions/ethereum_src.newAccount.html index 0cab158b..6eaa2094 100644 --- a/docs/functions/ethereum_src.newAccount.html +++ b/docs/functions/ethereum_src.newAccount.html @@ -1,2 +1,2 @@ newAccount | @aleph-sdk/monorepo

    Function newAccount

    • newAccount(derivationPath?): {
          account: ETHAccount;
          mnemonic: string;
      }

    • Creates a new ethereum account using a generated mnemonic following BIP 39 standard.

      -

      Parameters

      • derivationPath: string = "m/44'/60'/0'/0/0"

      Returns {
          account: ETHAccount;
          mnemonic: string;
      }

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns {
        account: ETHAccount;
        mnemonic: string;
    }

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/evm_src.alephToWei.html b/docs/functions/evm_src.alephToWei.html index 4f876120..cb5c3d69 100644 --- a/docs/functions/evm_src.alephToWei.html +++ b/docs/functions/evm_src.alephToWei.html @@ -1 +1 @@ -alephToWei | @aleph-sdk/monorepo

    Function alephToWei

    • alephToWei(alephAmount): BigNumber

    • Parameters

      • alephAmount: number | Decimal

      Returns BigNumber

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +alephToWei | @aleph-sdk/monorepo

    Function alephToWei

    • alephToWei(alephAmount): BigNumber

    • Parameters

      • alephAmount: number | Decimal

      Returns BigNumber

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/evm_src.createEphemeralEth.html b/docs/functions/evm_src.createEphemeralEth.html index fbba914e..3672beb4 100644 --- a/docs/functions/evm_src.createEphemeralEth.html +++ b/docs/functions/evm_src.createEphemeralEth.html @@ -1 +1 @@ -createEphemeralEth | @aleph-sdk/monorepo

    Function createEphemeralEth

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +createEphemeralEth | @aleph-sdk/monorepo

    Function createEphemeralEth

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/evm_src.decToHex.html b/docs/functions/evm_src.decToHex.html index 56eb11e5..cc0d5bb3 100644 --- a/docs/functions/evm_src.decToHex.html +++ b/docs/functions/evm_src.decToHex.html @@ -1 +1 @@ -decToHex | @aleph-sdk/monorepo

    Function decToHex

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +decToHex | @aleph-sdk/monorepo

    Function decToHex

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/evm_src.findChainDataByChainId.html b/docs/functions/evm_src.findChainDataByChainId.html index 6a0f3191..40a35de0 100644 --- a/docs/functions/evm_src.findChainDataByChainId.html +++ b/docs/functions/evm_src.findChainDataByChainId.html @@ -1 +1 @@ -findChainDataByChainId | @aleph-sdk/monorepo

    Function findChainDataByChainId

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +findChainDataByChainId | @aleph-sdk/monorepo

    Function findChainDataByChainId

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/evm_src.findChainMetadataByChainId.html b/docs/functions/evm_src.findChainMetadataByChainId.html index 9e378fcd..80962acd 100644 --- a/docs/functions/evm_src.findChainMetadataByChainId.html +++ b/docs/functions/evm_src.findChainMetadataByChainId.html @@ -1 +1 @@ -findChainMetadataByChainId | @aleph-sdk/monorepo

    Function findChainMetadataByChainId

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +findChainMetadataByChainId | @aleph-sdk/monorepo

    Function findChainMetadataByChainId

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/evm_src.hexToDec.html b/docs/functions/evm_src.hexToDec.html index 4041f7cb..37a51f89 100644 --- a/docs/functions/evm_src.hexToDec.html +++ b/docs/functions/evm_src.hexToDec.html @@ -1 +1 @@ -hexToDec | @aleph-sdk/monorepo

    Function hexToDec

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +hexToDec | @aleph-sdk/monorepo

    Function hexToDec

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/evm_src.verifyEthereum.html b/docs/functions/evm_src.verifyEthereum.html index ddad89d5..f4b0da85 100644 --- a/docs/functions/evm_src.verifyEthereum.html +++ b/docs/functions/evm_src.verifyEthereum.html @@ -3,4 +3,4 @@

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/evm_src.weiToAleph.html b/docs/functions/evm_src.weiToAleph.html index 640d11ed..ff36b23e 100644 --- a/docs/functions/evm_src.weiToAleph.html +++ b/docs/functions/evm_src.weiToAleph.html @@ -1 +1 @@ -weiToAleph | @aleph-sdk/monorepo

    Function weiToAleph

    • weiToAleph(weiAmount): Decimal

    • Parameters

      • weiAmount: string | BigNumber

      Returns Decimal

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +weiToAleph | @aleph-sdk/monorepo

    Function weiToAleph

    • weiToAleph(weiAmount): Decimal

    • Parameters

      • weiAmount: string | BigNumber

      Returns Decimal

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/message_src.PostMessageBuilder.html b/docs/functions/message_src.PostMessageBuilder.html index d180d305..c97492a3 100644 --- a/docs/functions/message_src.PostMessageBuilder.html +++ b/docs/functions/message_src.PostMessageBuilder.html @@ -1 +1 @@ -PostMessageBuilder | @aleph-sdk/monorepo

    Function PostMessageBuilder

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PostMessageBuilder | @aleph-sdk/monorepo

    Function PostMessageBuilder

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/message_src.broadcast.html b/docs/functions/message_src.broadcast.html index 5d902746..886b1763 100644 --- a/docs/functions/message_src.broadcast.html +++ b/docs/functions/message_src.broadcast.html @@ -1 +1 @@ -broadcast | @aleph-sdk/monorepo

    Function broadcast

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +broadcast | @aleph-sdk/monorepo

    Function broadcast

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/message_src.buildAggregateMessage.html b/docs/functions/message_src.buildAggregateMessage.html index 472c52bc..99d626de 100644 --- a/docs/functions/message_src.buildAggregateMessage.html +++ b/docs/functions/message_src.buildAggregateMessage.html @@ -1 +1 @@ -buildAggregateMessage | @aleph-sdk/monorepo

    Function buildAggregateMessage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +buildAggregateMessage | @aleph-sdk/monorepo

    Function buildAggregateMessage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/message_src.buildForgetMessage.html b/docs/functions/message_src.buildForgetMessage.html index fefa0030..5caeac73 100644 --- a/docs/functions/message_src.buildForgetMessage.html +++ b/docs/functions/message_src.buildForgetMessage.html @@ -1 +1 @@ -buildForgetMessage | @aleph-sdk/monorepo

    Function buildForgetMessage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +buildForgetMessage | @aleph-sdk/monorepo

    Function buildForgetMessage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/message_src.buildInstanceMessage.html b/docs/functions/message_src.buildInstanceMessage.html index 20167368..10a93097 100644 --- a/docs/functions/message_src.buildInstanceMessage.html +++ b/docs/functions/message_src.buildInstanceMessage.html @@ -1 +1 @@ -buildInstanceMessage | @aleph-sdk/monorepo

    Function buildInstanceMessage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +buildInstanceMessage | @aleph-sdk/monorepo

    Function buildInstanceMessage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/message_src.buildProgramMessage.html b/docs/functions/message_src.buildProgramMessage.html index d2b2d334..9f144260 100644 --- a/docs/functions/message_src.buildProgramMessage.html +++ b/docs/functions/message_src.buildProgramMessage.html @@ -1 +1 @@ -buildProgramMessage | @aleph-sdk/monorepo

    Function buildProgramMessage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +buildProgramMessage | @aleph-sdk/monorepo

    Function buildProgramMessage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/message_src.buildStoreMessage.html b/docs/functions/message_src.buildStoreMessage.html index 5b10aecb..78f16c97 100644 --- a/docs/functions/message_src.buildStoreMessage.html +++ b/docs/functions/message_src.buildStoreMessage.html @@ -1 +1 @@ -buildStoreMessage | @aleph-sdk/monorepo

    Function buildStoreMessage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +buildStoreMessage | @aleph-sdk/monorepo

    Function buildStoreMessage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/message_src.getMessagesSocket.html b/docs/functions/message_src.getMessagesSocket.html index fc2da759..554d89b2 100644 --- a/docs/functions/message_src.getMessagesSocket.html +++ b/docs/functions/message_src.getMessagesSocket.html @@ -1,4 +1,4 @@ getMessagesSocket | @aleph-sdk/monorepo

    Function getMessagesSocket

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns AlephSocket

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/message_src.prepareAlephMessage.html b/docs/functions/message_src.prepareAlephMessage.html index 6a54f824..fa71f897 100644 --- a/docs/functions/message_src.prepareAlephMessage.html +++ b/docs/functions/message_src.prepareAlephMessage.html @@ -1,3 +1,3 @@ prepareAlephMessage | @aleph-sdk/monorepo

    Function prepareAlephMessage

    • prepareAlephMessage<C>(configuration): Promise<HashedMessage<C>>

    • This function is used to update the Aleph message's fields and then publish it to the targeted storage engine.

      Type Parameters

      Parameters

      • configuration: PutConfiguration<C>

        The configuration used to update & publish the message.

        -

      Returns Promise<HashedMessage<C>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<HashedMessage<C>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/message_src.pushFileToStorageEngine.html b/docs/functions/message_src.pushFileToStorageEngine.html index cd1e71fe..871dd6d7 100644 --- a/docs/functions/message_src.pushFileToStorageEngine.html +++ b/docs/functions/message_src.pushFileToStorageEngine.html @@ -1 +1 @@ -pushFileToStorageEngine | @aleph-sdk/monorepo

    Function pushFileToStorageEngine

    • pushFileToStorageEngine(configuration): Promise<string>

    • Parameters

      • configuration: PushFileConfiguration

      Returns Promise<string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +pushFileToStorageEngine | @aleph-sdk/monorepo

    Function pushFileToStorageEngine

    • pushFileToStorageEngine(configuration): Promise<string>

    • Parameters

      • configuration: PushFileConfiguration

      Returns Promise<string>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/nuls2_src.importAccountFromMnemonic.html b/docs/functions/nuls2_src.importAccountFromMnemonic.html index 057056c8..dfdfbe48 100644 --- a/docs/functions/nuls2_src.importAccountFromMnemonic.html +++ b/docs/functions/nuls2_src.importAccountFromMnemonic.html @@ -1,4 +1,4 @@ importAccountFromMnemonic | @aleph-sdk/monorepo

    Function importAccountFromMnemonic

    • importAccountFromMnemonic(mnemonic, __namedParameters?): Promise<NULS2Account>

    • Imports a NULS2 account given a mnemonic.

      It creates an NULS2 account containing information about the account, extracted in the NULS2Account constructor.

      Parameters

      • mnemonic: string

        The mnemonic of the account to import.

        -
      • __namedParameters: NULS2ImportConfig = ...

      Returns Promise<NULS2Account>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • __namedParameters: NULS2ImportConfig = ...

    • Returns Promise<NULS2Account>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/nuls2_src.importAccountFromPrivateKey.html b/docs/functions/nuls2_src.importAccountFromPrivateKey.html index c85fbff8..9dabad61 100644 --- a/docs/functions/nuls2_src.importAccountFromPrivateKey.html +++ b/docs/functions/nuls2_src.importAccountFromPrivateKey.html @@ -1,4 +1,4 @@ importAccountFromPrivateKey | @aleph-sdk/monorepo

    Function importAccountFromPrivateKey

    • importAccountFromPrivateKey(privateKey, __namedParameters?): Promise<NULS2Account>

    • Imports a NULS2 account given a private key.

      It creates an NULS2 account containing information about the account, extracted in the NULS2Account constructor.

      Parameters

      • privateKey: string

        The mnemonic of the account to import.

        -
      • __namedParameters: NULS2ImportConfig = ...

      Returns Promise<NULS2Account>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • __namedParameters: NULS2ImportConfig = ...

    • Returns Promise<NULS2Account>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/nuls2_src.newAccount.html b/docs/functions/nuls2_src.newAccount.html index b03e09d6..32dd3eca 100644 --- a/docs/functions/nuls2_src.newAccount.html +++ b/docs/functions/nuls2_src.newAccount.html @@ -1,2 +1,2 @@ newAccount | @aleph-sdk/monorepo

    Function newAccount

    • newAccount(__namedParameters?): Promise<{
          account: NULS2Account;
          mnemonic: string;
      }>

    • Creates a new NULS2 account using a randomly generated private key.

      -

      Parameters

      Returns Promise<{
          account: NULS2Account;
          mnemonic: string;
      }>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<{
        account: NULS2Account;
        mnemonic: string;
    }>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/solana_src.getAccountFromProvider.html b/docs/functions/solana_src.getAccountFromProvider.html index 365a6b01..032f00c4 100644 --- a/docs/functions/solana_src.getAccountFromProvider.html +++ b/docs/functions/solana_src.getAccountFromProvider.html @@ -1,2 +1,2 @@ getAccountFromProvider | @aleph-sdk/monorepo

    Function getAccountFromProvider

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<SOLAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/solana_src.importAccountFromPrivateKey.html b/docs/functions/solana_src.importAccountFromPrivateKey.html index 3e603e1f..e552ecfa 100644 --- a/docs/functions/solana_src.importAccountFromPrivateKey.html +++ b/docs/functions/solana_src.importAccountFromPrivateKey.html @@ -1,4 +1,4 @@ importAccountFromPrivateKey | @aleph-sdk/monorepo

    Function importAccountFromPrivateKey

    • importAccountFromPrivateKey(privateKey): SOLAccount

    • Imports a solana account given a private key and the Keypair solana/web3.js package's class.

      It creates a solana wallet containing information about the account, extracted in the SOLAccount constructor.

      Parameters

      • privateKey: Uint8Array

        The private key of the account to import.

        -

      Returns SOLAccount

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns SOLAccount

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/solana_src.newAccount.html b/docs/functions/solana_src.newAccount.html index d42ddbb3..683ad654 100644 --- a/docs/functions/solana_src.newAccount.html +++ b/docs/functions/solana_src.newAccount.html @@ -1,2 +1,2 @@ newAccount | @aleph-sdk/monorepo

    Function newAccount

    • newAccount(): {
          account: SOLAccount;
          privateKey: Uint8Array;
      }

    • Creates a new solana account using a randomly generated solana keypair.

      -

      Returns {
          account: SOLAccount;
          privateKey: Uint8Array;
      }

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns {
        account: SOLAccount;
        privateKey: Uint8Array;
    }

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/solana_src.verifySolana.html b/docs/functions/solana_src.verifySolana.html index 21bab4f9..2363fef0 100644 --- a/docs/functions/solana_src.verifySolana.html +++ b/docs/functions/solana_src.verifySolana.html @@ -2,4 +2,4 @@ This method rely on the nacl.sign.detached.verify() implementation.

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/substrate_src.getAccountFromProvider.html b/docs/functions/substrate_src.getAccountFromProvider.html index b52052ba..b0fa972f 100644 --- a/docs/functions/substrate_src.getAccountFromProvider.html +++ b/docs/functions/substrate_src.getAccountFromProvider.html @@ -1,4 +1,4 @@ getAccountFromProvider | @aleph-sdk/monorepo

    Function getAccountFromProvider

    • getAccountFromProvider(address?): Promise<DOTAccount>

    • Get an account from polkadot.js provider This function can only be called inside a browser.

      Parameters

      • Optional address: string

        that can refer an account to connect, by default connect account number 0

        -

      Returns Promise<DOTAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<DOTAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/substrate_src.importAccountFromMnemonic.html b/docs/functions/substrate_src.importAccountFromMnemonic.html index a1443cd0..86e47f65 100644 --- a/docs/functions/substrate_src.importAccountFromMnemonic.html +++ b/docs/functions/substrate_src.importAccountFromMnemonic.html @@ -1,4 +1,4 @@ importAccountFromMnemonic | @aleph-sdk/monorepo

    Function importAccountFromMnemonic

    • importAccountFromMnemonic(mnemonic): Promise<DOTAccount>

    • Imports a substrate account given a mnemonic and the 'polkadot' package.

      It creates an substrate wallet containing information about the account, extracted in the DOTAccount constructor.

      Parameters

      • mnemonic: string

        The mnemonic of the account to import.

        -

      Returns Promise<DOTAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<DOTAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/substrate_src.importAccountFromPrivateKey.html b/docs/functions/substrate_src.importAccountFromPrivateKey.html index 92b2b755..b86170c5 100644 --- a/docs/functions/substrate_src.importAccountFromPrivateKey.html +++ b/docs/functions/substrate_src.importAccountFromPrivateKey.html @@ -1,4 +1,4 @@ importAccountFromPrivateKey | @aleph-sdk/monorepo

    Function importAccountFromPrivateKey

    • importAccountFromPrivateKey(privateKey): Promise<DOTAccount>

    • Imports a substrate account given a private key and the 'polkadot/keyring' package's class.

      It creates a substrate wallet containing information about the account, extracted in the DOTAccount constructor.

      Parameters

      • privateKey: string

        The private key of the account to import.

        -

      Returns Promise<DOTAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<DOTAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/substrate_src.newAccount.html b/docs/functions/substrate_src.newAccount.html index d0bea3cc..42864826 100644 --- a/docs/functions/substrate_src.newAccount.html +++ b/docs/functions/substrate_src.newAccount.html @@ -1,2 +1,2 @@ newAccount | @aleph-sdk/monorepo

    Function newAccount

    • newAccount(): Promise<{
          account: DOTAccount;
          mnemonic: string;
      }>

    • Creates a new substrate account using a randomly generated substrate keyring.

      -

      Returns Promise<{
          account: DOTAccount;
          mnemonic: string;
      }>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<{
        account: DOTAccount;
        mnemonic: string;
    }>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/superfluid_src.createFromEVMAccount.html b/docs/functions/superfluid_src.createFromEVMAccount.html index db3fc1d0..f827d75d 100644 --- a/docs/functions/superfluid_src.createFromEVMAccount.html +++ b/docs/functions/superfluid_src.createFromEVMAccount.html @@ -1 +1 @@ -createFromEVMAccount | @aleph-sdk/monorepo

    Function createFromEVMAccount

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +createFromEVMAccount | @aleph-sdk/monorepo

    Function createFromEVMAccount

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/superfluid_src.getAccountFromProvider.html b/docs/functions/superfluid_src.getAccountFromProvider.html index 63601ebd..3c9cd90b 100644 --- a/docs/functions/superfluid_src.getAccountFromProvider.html +++ b/docs/functions/superfluid_src.getAccountFromProvider.html @@ -1 +1 @@ -getAccountFromProvider | @aleph-sdk/monorepo

    Function getAccountFromProvider

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +getAccountFromProvider | @aleph-sdk/monorepo

    Function getAccountFromProvider

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/superfluid_src.isAccountSupported.html b/docs/functions/superfluid_src.isAccountSupported.html index e9d59d12..5615dd7e 100644 --- a/docs/functions/superfluid_src.isAccountSupported.html +++ b/docs/functions/superfluid_src.isAccountSupported.html @@ -1 +1 @@ -isAccountSupported | @aleph-sdk/monorepo

    Function isAccountSupported

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +isAccountSupported | @aleph-sdk/monorepo

    Function isAccountSupported

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/superfluid_src.isBlockchainSupported.html b/docs/functions/superfluid_src.isBlockchainSupported.html index 0ae665bd..fce267fb 100644 --- a/docs/functions/superfluid_src.isBlockchainSupported.html +++ b/docs/functions/superfluid_src.isBlockchainSupported.html @@ -1 +1 @@ -isBlockchainSupported | @aleph-sdk/monorepo

    Function isBlockchainSupported

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +isBlockchainSupported | @aleph-sdk/monorepo

    Function isBlockchainSupported

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/tezos_src.ImportAccountFromBeaconWallet.html b/docs/functions/tezos_src.ImportAccountFromBeaconWallet.html index c2ffd0e1..a4955a07 100644 --- a/docs/functions/tezos_src.ImportAccountFromBeaconWallet.html +++ b/docs/functions/tezos_src.ImportAccountFromBeaconWallet.html @@ -1,2 +1,2 @@ ImportAccountFromBeaconWallet | @aleph-sdk/monorepo

    Function ImportAccountFromBeaconWallet

    • ImportAccountFromBeaconWallet(wallet): Promise<TEZOSAccount>

    • Imports a Tezos account given a beacon wallet integration, using the @taquito/beacon-wallet BeaconWallet class.

      -

      Parameters

      • wallet: BeaconWallet

      Returns Promise<TEZOSAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<TEZOSAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/tezos_src.ImportAccountFromFundraiserInfo.html b/docs/functions/tezos_src.ImportAccountFromFundraiserInfo.html index 0202e3d1..4c060bf3 100644 --- a/docs/functions/tezos_src.ImportAccountFromFundraiserInfo.html +++ b/docs/functions/tezos_src.ImportAccountFromFundraiserInfo.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<TEZOSAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<TEZOSAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/tezos_src.importAccountFromPrivateKey.html b/docs/functions/tezos_src.importAccountFromPrivateKey.html index af5b8fea..f32601e9 100644 --- a/docs/functions/tezos_src.importAccountFromPrivateKey.html +++ b/docs/functions/tezos_src.importAccountFromPrivateKey.html @@ -1,4 +1,4 @@ importAccountFromPrivateKey | @aleph-sdk/monorepo

    Function importAccountFromPrivateKey

    • importAccountFromPrivateKey(privateKey, passphrase?): Promise<TEZOSAccount>

    • Imports a Tezos account given a private key, using the @taquito/signer InMemorySigner class.

      Parameters

      • privateKey: string

        The private key of the account to import.

      • Optional passphrase: string

        The password, if the key is encrypted.

        -

      Returns Promise<TEZOSAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<TEZOSAccount>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/tezos_src.newAccount.html b/docs/functions/tezos_src.newAccount.html index 4b4d8b35..8cf1d2f4 100644 --- a/docs/functions/tezos_src.newAccount.html +++ b/docs/functions/tezos_src.newAccount.html @@ -1,2 +1,2 @@ newAccount | @aleph-sdk/monorepo

    Function newAccount

    • newAccount(): Promise<{
          privateKey: Uint8Array;
          signerAccount: TEZOSAccount;
      }>

    • Creates a new Tezos account (tz1) using a randomly generated Tezos keypair.

      -

      Returns Promise<{
          privateKey: Uint8Array;
          signerAccount: TEZOSAccount;
      }>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<{
        privateKey: Uint8Array;
        signerAccount: TEZOSAccount;
    }>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/tezos_src.verifyTezos.html b/docs/functions/tezos_src.verifyTezos.html index 9c1d26d7..3ec35a9f 100644 --- a/docs/functions/tezos_src.verifyTezos.html +++ b/docs/functions/tezos_src.verifyTezos.html @@ -2,4 +2,4 @@ This method rely on the verifySignature() implementation from taquito/utils.

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/message_src.MessageTypeMap.html b/docs/interfaces/message_src.MessageTypeMap.html index 521d54ae..1c5b9d66 100644 --- a/docs/interfaces/message_src.MessageTypeMap.html +++ b/docs/interfaces/message_src.MessageTypeMap.html @@ -1,9 +1,9 @@ MessageTypeMap | @aleph-sdk/monorepo

    Interface MessageTypeMap<Content>

    Message types supported by Aleph Some message types come with a content field that can is of a generic type.

    -
    interface MessageTypeMap<Content> {
        AGGREGATE: AggregateContent<Content>;
        FORGET: ForgetContent;
        INSTANCE: InstanceContent;
        POST: PostContent<Content>;
        PROGRAM: ProgramContent;
        STORE: StoreContent;
        [key: string]: MessageContent;
    }

    Type Parameters

    • Content = any

    Indexable

    [key: string]: MessageContent

    Properties

    AGGREGATE +
    interface MessageTypeMap<Content> {
        AGGREGATE: AggregateContent<Content>;
        FORGET: ForgetContent;
        INSTANCE: InstanceContent;
        POST: PostContent<Content>;
        PROGRAM: ProgramContent;
        STORE: StoreContent;
        [key: string]: MessageContent;
    }

    Type Parameters

    • Content = any

    Indexable

    [key: string]: MessageContent

    Properties

    AGGREGATE FORGET INSTANCE POST PROGRAM STORE -

    Properties

    AGGREGATE

    AGGREGATE: AggregateContent<Content>

    FORGET

    FORGET: ForgetContent

    INSTANCE

    INSTANCE: InstanceContent

    POST

    POST: PostContent<Content>

    PROGRAM

    PROGRAM: ProgramContent

    STORE

    STORE: StoreContent

    Settings

    Member Visibility

    Theme

    On This Page

    AGGREGATEFORGETINSTANCEPOSTPROGRAMSTORE

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    AGGREGATE

    AGGREGATE: AggregateContent<Content>

    FORGET

    FORGET: ForgetContent

    INSTANCE

    INSTANCE: InstanceContent

    POST

    POST: PostContent<Content>

    PROGRAM

    PROGRAM: ProgramContent

    STORE

    STORE: StoreContent

    Settings

    Member Visibility

    Theme

    On This Page

    AGGREGATEFORGETINSTANCEPOSTPROGRAMSTORE

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/account_src.html b/docs/modules/account_src.html index 4f2e0c05..44582548 100644 --- a/docs/modules/account_src.html +++ b/docs/modules/account_src.html @@ -1,4 +1,4 @@ -account/src | @aleph-sdk/monorepo

    Module account/src

    Index

    Classes

    Account +account/src | @aleph-sdk/monorepo

    Module account/src

    Index

    Classes

    Account BaseProviderWallet ECIESAccount

    Type Aliases

    EphAccount diff --git a/docs/modules/avalanche_src.html b/docs/modules/avalanche_src.html index 55ce24a2..fb0dd350 100644 --- a/docs/modules/avalanche_src.html +++ b/docs/modules/avalanche_src.html @@ -1,4 +1,4 @@ -avalanche/src | @aleph-sdk/monorepo

    Module avalanche/src

    Index

    Enumerations

    ChainType +avalanche/src | @aleph-sdk/monorepo

    Module avalanche/src

    Index

    Enumerations

    ChainType

    Classes

    AvalancheAccount

    Functions

    digestMessage getAccountFromProvider diff --git a/docs/modules/base_src.html b/docs/modules/base_src.html index d96afe7b..503cc308 100644 --- a/docs/modules/base_src.html +++ b/docs/modules/base_src.html @@ -1,4 +1,4 @@ -base/src | @aleph-sdk/monorepo

    Module base/src

    Index

    Classes

    BaseAccount +base/src | @aleph-sdk/monorepo

    Module base/src

    Index

    Classes

    BaseAccount

    Functions

    getAccountFromProvider importAccountFromMnemonic importAccountFromPrivateKey diff --git a/docs/modules/client_src.html b/docs/modules/client_src.html index 69a4462f..e1b29d4f 100644 --- a/docs/modules/client_src.html +++ b/docs/modules/client_src.html @@ -1,3 +1,3 @@ -client/src | @aleph-sdk/monorepo

    Module client/src

    Index

    Classes

    AlephHttpClient +client/src | @aleph-sdk/monorepo

    Module client/src

    Index

    Classes

    AlephHttpClient AuthenticatedAlephHttpClient

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/core_src.html b/docs/modules/core_src.html index 06561850..443aa790 100644 --- a/docs/modules/core_src.html +++ b/docs/modules/core_src.html @@ -1,4 +1,4 @@ -core/src | @aleph-sdk/monorepo

    Module core/src

    Index

    Enumerations

    Blockchain +core/src | @aleph-sdk/monorepo

    Module core/src

    Index

    Enumerations

    Blockchain

    Type Aliases

    JSExecutionEnvironment RequireOnlyOne

    Variables

    DEFAULT_API_V2 diff --git a/docs/modules/cosmos_src.html b/docs/modules/cosmos_src.html index 8160fff0..320ae8d5 100644 --- a/docs/modules/cosmos_src.html +++ b/docs/modules/cosmos_src.html @@ -1,4 +1,4 @@ -cosmos/src | @aleph-sdk/monorepo

    Module cosmos/src

    Index

    Classes

    CosmosAccount +cosmos/src | @aleph-sdk/monorepo

    Module cosmos/src

    Index

    Classes

    CosmosAccount

    Functions

    importAccountFromMnemonic importAccountFromPrivateKey newAccount diff --git a/docs/modules/dns_src.html b/docs/modules/dns_src.html index 47ce273f..4eae98a2 100644 --- a/docs/modules/dns_src.html +++ b/docs/modules/dns_src.html @@ -1,4 +1,4 @@ -dns/src | @aleph-sdk/monorepo

    Module dns/src

    Index

    Enumerations

    TargetType +dns/src | @aleph-sdk/monorepo

    Module dns/src

    Index

    Enumerations

    TargetType

    Classes

    DomainConfigurationError DomainValidator

    Variables

    DNS_INSTANCE_DOMAIN diff --git a/docs/modules/ethereum_ledger_src.html b/docs/modules/ethereum_ledger_src.html index 267355b7..5df6da49 100644 --- a/docs/modules/ethereum_ledger_src.html +++ b/docs/modules/ethereum_ledger_src.html @@ -1,4 +1,4 @@ -ethereum-ledger/src | @aleph-sdk/monorepo

    Module ethereum-ledger/src

    Index

    Classes

    ETHLedgerAccount +ethereum-ledger/src | @aleph-sdk/monorepo

    Module ethereum-ledger/src

    Index

    Classes

    ETHLedgerAccount

    Functions

    GetAccountFromLedger getTransport

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/ethereum_src.html b/docs/modules/ethereum_src.html index 47fb4a51..0584d76e 100644 --- a/docs/modules/ethereum_src.html +++ b/docs/modules/ethereum_src.html @@ -1,4 +1,4 @@ -ethereum/src | @aleph-sdk/monorepo

    Module ethereum/src

    Index

    Classes

    ETHAccount +ethereum/src | @aleph-sdk/monorepo

    Module ethereum/src

    Index

    Classes

    ETHAccount

    Functions

    getAccountFromProvider importAccountFromMnemonic importAccountFromPrivateKey diff --git a/docs/modules/evm_src.html b/docs/modules/evm_src.html index 3db10682..c5832f10 100644 --- a/docs/modules/evm_src.html +++ b/docs/modules/evm_src.html @@ -1,4 +1,4 @@ -evm/src | @aleph-sdk/monorepo

    Module evm/src

    Index

    Enumerations

    RpcId +evm/src | @aleph-sdk/monorepo

    Module evm/src

    Index

    Enumerations

    RpcId

    Classes

    EVMAccount EthereumMockProvider JsonRPCWallet diff --git a/docs/modules/message_src.html b/docs/modules/message_src.html index 8121dc91..1d1c6d4c 100644 --- a/docs/modules/message_src.html +++ b/docs/modules/message_src.html @@ -1,4 +1,4 @@ -message/src | @aleph-sdk/monorepo

    Module message/src

    Index

    Enumerations

    Encoding +message/src | @aleph-sdk/monorepo

    Module message/src

    Index

    Enumerations

    Encoding HypervisorType InterfaceType ItemType diff --git a/docs/modules/nuls2_src.html b/docs/modules/nuls2_src.html index 1dc810df..ab772cdb 100644 --- a/docs/modules/nuls2_src.html +++ b/docs/modules/nuls2_src.html @@ -1,4 +1,4 @@ -nuls2/src | @aleph-sdk/monorepo

    Module nuls2/src

    Index

    Classes

    NULS2Account +nuls2/src | @aleph-sdk/monorepo

    Module nuls2/src

    Index

    Classes

    NULS2Account

    Type Aliases

    ChainNAddress NULS2ImportConfig

    Functions

    importAccountFromMnemonic diff --git a/docs/modules/solana_src.html b/docs/modules/solana_src.html index 542165f6..16ac1707 100644 --- a/docs/modules/solana_src.html +++ b/docs/modules/solana_src.html @@ -1,4 +1,4 @@ -solana/src | @aleph-sdk/monorepo

    Module solana/src

    Index

    Classes

    SOLAccount +solana/src | @aleph-sdk/monorepo

    Module solana/src

    Index

    Classes

    SOLAccount

    Functions

    getAccountFromProvider importAccountFromPrivateKey newAccount diff --git a/docs/modules/substrate_src.html b/docs/modules/substrate_src.html index 3fb32fd2..440d2fc5 100644 --- a/docs/modules/substrate_src.html +++ b/docs/modules/substrate_src.html @@ -1,4 +1,4 @@ -substrate/src | @aleph-sdk/monorepo

    Module substrate/src

    Index

    Classes

    DOTAccount +substrate/src | @aleph-sdk/monorepo

    Module substrate/src

    Index

    Classes

    DOTAccount

    Functions

    getAccountFromProvider importAccountFromMnemonic importAccountFromPrivateKey diff --git a/docs/modules/superfluid_src.html b/docs/modules/superfluid_src.html index c5f27606..45e3bcf9 100644 --- a/docs/modules/superfluid_src.html +++ b/docs/modules/superfluid_src.html @@ -1,4 +1,4 @@ -superfluid/src | @aleph-sdk/monorepo

    Module superfluid/src

    Index

    Classes

    SuperfluidAccount +superfluid/src | @aleph-sdk/monorepo

    Module superfluid/src

    Index

    Classes

    SuperfluidAccount

    Functions

    createFromEVMAccount getAccountFromProvider isAccountSupported diff --git a/docs/modules/tezos_src.html b/docs/modules/tezos_src.html index 7fd2e08d..f29a7b59 100644 --- a/docs/modules/tezos_src.html +++ b/docs/modules/tezos_src.html @@ -1,4 +1,4 @@ -tezos/src | @aleph-sdk/monorepo

    Module tezos/src

    Index

    Classes

    TEZOSAccount +tezos/src | @aleph-sdk/monorepo

    Module tezos/src

    Index

    Classes

    TEZOSAccount

    Variables

    STANDARD_DAPP_URL

    Functions

    ImportAccountFromBeaconWallet ImportAccountFromFundraiserInfo diff --git a/docs/types/account_src.EphAccount.html b/docs/types/account_src.EphAccount.html index 1b0d1202..f73c5310 100644 --- a/docs/types/account_src.EphAccount.html +++ b/docs/types/account_src.EphAccount.html @@ -1 +1 @@ -EphAccount | @aleph-sdk/monorepo

    Type alias EphAccount

    EphAccount: {
        address: string;
        mnemonic: string;
        privateKey: string;
        publicKey: string;
    }

    Type declaration

    • address: string
    • mnemonic: string
    • privateKey: string
    • publicKey: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EphAccount | @aleph-sdk/monorepo

    Type alias EphAccount

    EphAccount: {
        address: string;
        mnemonic: string;
        privateKey: string;
        publicKey: string;
    }

    Type declaration

    • address: string
    • mnemonic: string
    • privateKey: string
    • publicKey: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/account_src.SignableMessage.html b/docs/types/account_src.SignableMessage.html index d20a91e8..67742921 100644 --- a/docs/types/account_src.SignableMessage.html +++ b/docs/types/account_src.SignableMessage.html @@ -1 +1 @@ -SignableMessage | @aleph-sdk/monorepo

    Type alias SignableMessage

    SignableMessage: {
        getVerificationBuffer: (() => Buffer);
        sender: string;
        time: number;
    }

    Type declaration

    • getVerificationBuffer: (() => Buffer)
        • (): Buffer

        • Returns Buffer

    • sender: string
    • time: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +SignableMessage | @aleph-sdk/monorepo

    Type alias SignableMessage

    SignableMessage: {
        getVerificationBuffer: (() => Buffer);
        sender: string;
        time: number;
    }

    Type declaration

    • getVerificationBuffer: (() => Buffer)
        • (): Buffer

        • Returns Buffer

    • sender: string
    • time: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/core_src.JSExecutionEnvironment.html b/docs/types/core_src.JSExecutionEnvironment.html index 9bd5c9d3..cb04918b 100644 --- a/docs/types/core_src.JSExecutionEnvironment.html +++ b/docs/types/core_src.JSExecutionEnvironment.html @@ -1 +1 @@ -JSExecutionEnvironment | @aleph-sdk/monorepo

    Type alias JSExecutionEnvironment

    JSExecutionEnvironment: "node" | "browser"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +JSExecutionEnvironment | @aleph-sdk/monorepo

    Type alias JSExecutionEnvironment

    JSExecutionEnvironment: "node" | "browser"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/core_src.RequireOnlyOne.html b/docs/types/core_src.RequireOnlyOne.html index 626d1b94..6a272d32 100644 --- a/docs/types/core_src.RequireOnlyOne.html +++ b/docs/types/core_src.RequireOnlyOne.html @@ -1,3 +1,3 @@ RequireOnlyOne | @aleph-sdk/monorepo

    Type alias RequireOnlyOne<T, Keys>

    RequireOnlyOne<T, Keys>: Pick<T, Exclude<keyof T, Keys>> & {
        [K in Keys]-?: Required<Pick<T, K>> & Partial<Record<Exclude<Keys, K>, undefined>>
    }[Keys]

    This type implementation allows to specify for a given T type two field with only one that have to be field. You can find more about this here: https://learn.microsoft.com/en-us/javascript/api/@azure/keyvault-certificates/requireatleastone?view=azure-node-latest

    -

    Type Parameters

    • T
    • Keys extends keyof T = keyof T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • T
    • Keys extends keyof T = keyof T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/evm_src.ChainMetadataType.html b/docs/types/evm_src.ChainMetadataType.html index 6699a663..bb2b606c 100644 --- a/docs/types/evm_src.ChainMetadataType.html +++ b/docs/types/evm_src.ChainMetadataType.html @@ -1 +1 @@ -ChainMetadataType | @aleph-sdk/monorepo

    Type alias ChainMetadataType

    ChainMetadataType: RpcType & {
        superTokenAddress?: string;
        tokenAddress?: string;
    }

    Type declaration

    • Optional superTokenAddress?: string
    • Optional tokenAddress?: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ChainMetadataType | @aleph-sdk/monorepo

    Type alias ChainMetadataType

    ChainMetadataType: RpcType & {
        superTokenAddress?: string;
        tokenAddress?: string;
    }

    Type declaration

    • Optional superTokenAddress?: string
    • Optional tokenAddress?: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/evm_src.ChangeRpcParam.html b/docs/types/evm_src.ChangeRpcParam.html index 86d40776..d162fd51 100644 --- a/docs/types/evm_src.ChangeRpcParam.html +++ b/docs/types/evm_src.ChangeRpcParam.html @@ -1 +1 @@ -ChangeRpcParam | @aleph-sdk/monorepo

    Type alias ChangeRpcParam

    ChangeRpcParam: RpcType | RpcId

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ChangeRpcParam | @aleph-sdk/monorepo

    Type alias ChangeRpcParam

    ChangeRpcParam: RpcType | RpcId

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/evm_src.RpcType.html b/docs/types/evm_src.RpcType.html index 588cc17f..e7c69e11 100644 --- a/docs/types/evm_src.RpcType.html +++ b/docs/types/evm_src.RpcType.html @@ -1 +1 @@ -RpcType | @aleph-sdk/monorepo

    Type alias RpcType

    RpcType: {
        blockExplorerUrls: string[];
        chainId: string;
        chainName: string;
        nativeCurrency: {
            decimals: number;
            name: string;
            symbol: string;
        };
        rpcUrls: string[];
    }

    Type declaration

    • blockExplorerUrls: string[]
    • chainId: string
    • chainName: string
    • nativeCurrency: {
          decimals: number;
          name: string;
          symbol: string;
      }
      • decimals: number
      • name: string
      • symbol: string
    • rpcUrls: string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +RpcType | @aleph-sdk/monorepo

    Type alias RpcType

    RpcType: {
        blockExplorerUrls: string[];
        chainId: string;
        chainName: string;
        nativeCurrency: {
            decimals: number;
            name: string;
            symbol: string;
        };
        rpcUrls: string[];
    }

    Type declaration

    • blockExplorerUrls: string[]
    • chainId: string
    • chainName: string
    • nativeCurrency: {
          decimals: number;
          name: string;
          symbol: string;
      }
      • decimals: number
      • name: string
      • symbol: string
    • rpcUrls: string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.AbstractVolume.html b/docs/types/message_src.AbstractVolume.html index 5d229cb6..17f374f4 100644 --- a/docs/types/message_src.AbstractVolume.html +++ b/docs/types/message_src.AbstractVolume.html @@ -1 +1 @@ -AbstractVolume | @aleph-sdk/monorepo

    Type alias AbstractVolume

    AbstractVolume: {
        comment?: string[];
        is_read_only: (() => boolean);
        mount?: string[];
    }

    Type declaration

    • Optional comment?: string[]
    • is_read_only: (() => boolean)
        • (): boolean

        • Returns boolean

    • Optional mount?: string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +AbstractVolume | @aleph-sdk/monorepo

    Type alias AbstractVolume

    AbstractVolume: {
        comment?: string[];
        is_read_only: (() => boolean);
        mount?: string[];
    }

    Type declaration

    • Optional comment?: string[]
    • is_read_only: (() => boolean)
        • (): boolean

        • Returns boolean

    • Optional mount?: string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.AggregateContent.html b/docs/types/message_src.AggregateContent.html index 37fee758..a2f47ee4 100644 --- a/docs/types/message_src.AggregateContent.html +++ b/docs/types/message_src.AggregateContent.html @@ -1 +1 @@ -AggregateContent | @aleph-sdk/monorepo

    Type alias AggregateContent<T>

    AggregateContent<T>: BaseContent & {
        content: T;
        key: string | AggregateContentKey;
    }

    Type Parameters

    • T

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +AggregateContent | @aleph-sdk/monorepo

    Type alias AggregateContent<T>

    AggregateContent<T>: BaseContent & {
        content: T;
        key: string | AggregateContentKey;
    }

    Type Parameters

    • T

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.AggregateContentKey.html b/docs/types/message_src.AggregateContentKey.html index 281a5ee3..0a43583f 100644 --- a/docs/types/message_src.AggregateContentKey.html +++ b/docs/types/message_src.AggregateContentKey.html @@ -1 +1 @@ -AggregateContentKey | @aleph-sdk/monorepo

    Type alias AggregateContentKey

    AggregateContentKey: {
        name: string;
    }

    Type declaration

    • name: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +AggregateContentKey | @aleph-sdk/monorepo

    Type alias AggregateContentKey

    AggregateContentKey: {
        name: string;
    }

    Type declaration

    • name: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.AggregateGetConfiguration.html b/docs/types/message_src.AggregateGetConfiguration.html index 4498602c..684f0e02 100644 --- a/docs/types/message_src.AggregateGetConfiguration.html +++ b/docs/types/message_src.AggregateGetConfiguration.html @@ -1 +1 @@ -AggregateGetConfiguration | @aleph-sdk/monorepo

    Type alias AggregateGetConfiguration

    AggregateGetConfiguration: {
        address: string;
        keys?: string[];
    }

    Type declaration

    • address: string
    • Optional keys?: string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +AggregateGetConfiguration | @aleph-sdk/monorepo

    Type alias AggregateGetConfiguration

    AggregateGetConfiguration: {
        address: string;
        keys?: string[];
    }

    Type declaration

    • address: string
    • Optional keys?: string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.AggregateGetResponse.html b/docs/types/message_src.AggregateGetResponse.html index ce023721..95979bfd 100644 --- a/docs/types/message_src.AggregateGetResponse.html +++ b/docs/types/message_src.AggregateGetResponse.html @@ -1 +1 @@ -AggregateGetResponse | @aleph-sdk/monorepo

    Type alias AggregateGetResponse<T>

    AggregateGetResponse<T>: {
        data: T;
    }

    Type Parameters

    • T

    Type declaration

    • data: T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +AggregateGetResponse | @aleph-sdk/monorepo

    Type alias AggregateGetResponse<T>

    AggregateGetResponse<T>: {
        data: T;
    }

    Type Parameters

    • T

    Type declaration

    • data: T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.AggregateMessage.html b/docs/types/message_src.AggregateMessage.html index 59d180e4..5a26fd19 100644 --- a/docs/types/message_src.AggregateMessage.html +++ b/docs/types/message_src.AggregateMessage.html @@ -1 +1 @@ -AggregateMessage | @aleph-sdk/monorepo

    Type alias AggregateMessage<T>

    AggregateMessage<T>: SignedMessage<AggregateContent<T>>

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +AggregateMessage | @aleph-sdk/monorepo

    Type alias AggregateMessage<T>

    AggregateMessage<T>: SignedMessage<AggregateContent<T>>

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.AggregatePublishConfiguration.html b/docs/types/message_src.AggregatePublishConfiguration.html index a9d885a0..51f33fa6 100644 --- a/docs/types/message_src.AggregatePublishConfiguration.html +++ b/docs/types/message_src.AggregatePublishConfiguration.html @@ -1 +1 @@ -AggregatePublishConfiguration | @aleph-sdk/monorepo

    Type alias AggregatePublishConfiguration<T>

    AggregatePublishConfiguration<T>: {
        account: Account;
        address?: string;
        channel?: string;
        content: T;
        key: string | AggregateContentKey;
        storageEngine?: ItemType;
        sync?: boolean;
    }

    Type Parameters

    • T

    Type declaration

    • account: Account
    • Optional address?: string
    • Optional channel?: string
    • content: T
    • key: string | AggregateContentKey
    • Optional storageEngine?: ItemType
    • Optional sync?: boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +AggregatePublishConfiguration | @aleph-sdk/monorepo

    Type alias AggregatePublishConfiguration<T>

    AggregatePublishConfiguration<T>: {
        account: Account;
        address?: string;
        channel?: string;
        content: T;
        key: string | AggregateContentKey;
        storageEngine?: ItemType;
        sync?: boolean;
    }

    Type Parameters

    • T

    Type declaration

    • account: Account
    • Optional address?: string
    • Optional channel?: string
    • content: T
    • key: string | AggregateContentKey
    • Optional storageEngine?: ItemType
    • Optional sync?: boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.AlephSocket.html b/docs/types/message_src.AlephSocket.html index 2ed5f6c7..c025a4d5 100644 --- a/docs/types/message_src.AlephSocket.html +++ b/docs/types/message_src.AlephSocket.html @@ -1 +1 @@ -AlephSocket | @aleph-sdk/monorepo

    Type alias AlephSocket

    AlephSocket: AlephWebSocket | AlephNodeWebSocket

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +AlephSocket | @aleph-sdk/monorepo

    Type alias AlephSocket

    AlephSocket: AlephWebSocket | AlephNodeWebSocket

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.BaseContent.html b/docs/types/message_src.BaseContent.html index 0c98fa3f..c370f1ca 100644 --- a/docs/types/message_src.BaseContent.html +++ b/docs/types/message_src.BaseContent.html @@ -1 +1 @@ -BaseContent | @aleph-sdk/monorepo

    Type alias BaseContent

    BaseContent: {
        address: string;
        time: number;
    }

    Type declaration

    • address: string
    • time: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +BaseContent | @aleph-sdk/monorepo

    Type alias BaseContent

    BaseContent: {
        address: string;
        time: number;
    }

    Type declaration

    • address: string
    • time: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.BaseExecutableContent.html b/docs/types/message_src.BaseExecutableContent.html index 44ea9a11..141047f7 100644 --- a/docs/types/message_src.BaseExecutableContent.html +++ b/docs/types/message_src.BaseExecutableContent.html @@ -8,4 +8,4 @@ requirements: System properties required volumes: Volumes to mount on the filesystem replaces: Previous version to replace. Must be signed by the same address"

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.BaseMessageProps.html b/docs/types/message_src.BaseMessageProps.html index 9f8d2c11..5270b6e5 100644 --- a/docs/types/message_src.BaseMessageProps.html +++ b/docs/types/message_src.BaseMessageProps.html @@ -1 +1 @@ -BaseMessageProps | @aleph-sdk/monorepo

    Type alias BaseMessageProps<C>

    BaseMessageProps<C>: {
        chain: Blockchain;
        channel?: string;
        content: C;
        item_type: ItemType;
        sender: string;
        time: number;
        type: keyof MessageTypeMap<C>;
    }

    Type Parameters

    Type declaration

    • chain: Blockchain
    • Optional channel?: string
    • content: C
    • item_type: ItemType
    • sender: string
    • time: number
    • type: keyof MessageTypeMap<C>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +BaseMessageProps | @aleph-sdk/monorepo

    Type alias BaseMessageProps<C>

    BaseMessageProps<C>: {
        chain: Blockchain;
        channel?: string;
        content: C;
        item_type: ItemType;
        sender: string;
        time: number;
        type: keyof MessageTypeMap<C>;
    }

    Type Parameters

    Type declaration

    • chain: Blockchain
    • Optional channel?: string
    • content: C
    • item_type: ItemType
    • sender: string
    • time: number
    • type: keyof MessageTypeMap<C>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.ChainRef.html b/docs/types/message_src.ChainRef.html index 17fbf72e..92a2933a 100644 --- a/docs/types/message_src.ChainRef.html +++ b/docs/types/message_src.ChainRef.html @@ -1,2 +1,2 @@ ChainRef | @aleph-sdk/monorepo

    Type alias ChainRef

    ChainRef: {
        chain: string;
        channel?: string;
        item_content: string;
        item_hash: string;
        item_type: string;
        sender: string;
        signature: string;
        time: number;
        type: post;
    }

    Some POST messages have a 'ref' field referencing other content

    -

    Type declaration

    • chain: string
    • Optional channel?: string
    • item_content: string
    • item_hash: string
    • item_type: string
    • sender: string
    • signature: string
    • time: number
    • type: post

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • chain: string
    • Optional channel?: string
    • item_content: string
    • item_hash: string
    • item_type: string
    • sender: string
    • signature: string
    • time: number
    • type: post

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.CodeContent.html b/docs/types/message_src.CodeContent.html index 9a512d25..32a0476b 100644 --- a/docs/types/message_src.CodeContent.html +++ b/docs/types/message_src.CodeContent.html @@ -1 +1 @@ -CodeContent | @aleph-sdk/monorepo

    Type alias CodeContent

    CodeContent: {
        args?: string[];
        encoding: Encoding;
        entrypoint: string;
        interface?: InterfaceType;
        ref: string;
        use_latest: boolean;
    }

    Type declaration

    • Optional args?: string[]
    • encoding: Encoding
    • entrypoint: string
    • Optional interface?: InterfaceType
    • ref: string
    • use_latest: boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +CodeContent | @aleph-sdk/monorepo

    Type alias CodeContent

    CodeContent: {
        args?: string[];
        encoding: Encoding;
        entrypoint: string;
        interface?: InterfaceType;
        ref: string;
        use_latest: boolean;
    }

    Type declaration

    • Optional args?: string[]
    • encoding: Encoding
    • entrypoint: string
    • Optional interface?: InterfaceType
    • ref: string
    • use_latest: boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.CpuProperties.html b/docs/types/message_src.CpuProperties.html index 35f803a3..631adf62 100644 --- a/docs/types/message_src.CpuProperties.html +++ b/docs/types/message_src.CpuProperties.html @@ -1,3 +1,3 @@ CpuProperties | @aleph-sdk/monorepo

    Type alias CpuProperties

    CpuProperties: {
        architecture?: "x86_64" | "arm64";
        features?: string[];
        vendor?: "AuthenticAMD" | "GenuineIntel" | string;
    }

    architecture: CPU architecture vendor: CPU vendor. Allows other vendors.

    -

    Type declaration

    • Optional architecture?: "x86_64" | "arm64"
    • Optional features?: string[]
    • Optional vendor?: "AuthenticAMD" | "GenuineIntel" | string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • Optional architecture?: "x86_64" | "arm64"
    • Optional features?: string[]
    • Optional vendor?: "AuthenticAMD" | "GenuineIntel" | string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.DataContent.html b/docs/types/message_src.DataContent.html index 5a2f7f37..daac1a3b 100644 --- a/docs/types/message_src.DataContent.html +++ b/docs/types/message_src.DataContent.html @@ -1,2 +1,2 @@ DataContent | @aleph-sdk/monorepo

    Type alias DataContent

    DataContent: {
        encoding: Encoding;
        mount: string;
        ref: string;
        use_latest: boolean;
    }

    Data to use during computation

    -

    Type declaration

    • encoding: Encoding
    • mount: string
    • ref: string
    • use_latest: boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • encoding: Encoding
    • mount: string
    • ref: string
    • use_latest: boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.EphemeralVolume.html b/docs/types/message_src.EphemeralVolume.html index 78976620..2c8c4bb9 100644 --- a/docs/types/message_src.EphemeralVolume.html +++ b/docs/types/message_src.EphemeralVolume.html @@ -1,2 +1,2 @@ EphemeralVolume | @aleph-sdk/monorepo

    Type alias EphemeralVolume

    EphemeralVolume: AbstractVolume & {
        ephemeral: true;
        is_read_only: (() => false);
        size_mib: number;
    }

    Ephemeral volumes provide temporary disk storage to a VM during its execution without requiring more memory.

    -

    Type declaration

    • ephemeral: true
    • is_read_only: (() => false)
        • (): false

        • Returns false

    • size_mib: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • ephemeral: true
    • is_read_only: (() => false)
        • (): false

        • Returns false

    • size_mib: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.Export.html b/docs/types/message_src.Export.html index 1e7ec1aa..5ab5d463 100644 --- a/docs/types/message_src.Export.html +++ b/docs/types/message_src.Export.html @@ -1,2 +1,2 @@ Export | @aleph-sdk/monorepo

    Type alias Export

    Export: {
        encoding: Encoding;
        mount: string;
    }

    Data to export after computation

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.ForgetContent.html b/docs/types/message_src.ForgetContent.html index 5a62a31a..3cc1c190 100644 --- a/docs/types/message_src.ForgetContent.html +++ b/docs/types/message_src.ForgetContent.html @@ -1 +1 @@ -ForgetContent | @aleph-sdk/monorepo

    Type alias ForgetContent

    ForgetContent: BaseContent & {
        hashes: string[];
        reason?: string;
    }

    Type declaration

    • hashes: string[]
    • Optional reason?: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ForgetContent | @aleph-sdk/monorepo

    Type alias ForgetContent

    ForgetContent: BaseContent & {
        hashes: string[];
        reason?: string;
    }

    Type declaration

    • hashes: string[]
    • Optional reason?: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.ForgetMessage.html b/docs/types/message_src.ForgetMessage.html index 315623d8..80cf629f 100644 --- a/docs/types/message_src.ForgetMessage.html +++ b/docs/types/message_src.ForgetMessage.html @@ -1 +1 @@ -ForgetMessage | @aleph-sdk/monorepo

    Type alias ForgetMessage

    ForgetMessage: SignedMessage<ForgetContent>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ForgetMessage | @aleph-sdk/monorepo

    Type alias ForgetMessage

    ForgetMessage: SignedMessage<ForgetContent>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.ForgetPublishConfiguration.html b/docs/types/message_src.ForgetPublishConfiguration.html index 3a5a436c..23825ad5 100644 --- a/docs/types/message_src.ForgetPublishConfiguration.html +++ b/docs/types/message_src.ForgetPublishConfiguration.html @@ -6,4 +6,4 @@

    hashes: The Hashes of the Aleph's message to forget.

    reason: An optional reason to justify this action (default value: "None").

    sync: If true, the function will wait for the message to be confirmed by the API server.

    -

    Type declaration

    • account: Account
    • Optional address?: string
    • Optional channel?: string
    • hashes: string[]
    • Optional reason?: string
    • Optional storageEngine?: ItemType
    • Optional sync?: boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • account: Account
    • Optional address?: string
    • Optional channel?: string
    • hashes: string[]
    • Optional reason?: string
    • Optional storageEngine?: ItemType
    • Optional sync?: boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.FunctionEnvironment.html b/docs/types/message_src.FunctionEnvironment.html index 62e7484c..cd86cfb8 100644 --- a/docs/types/message_src.FunctionEnvironment.html +++ b/docs/types/message_src.FunctionEnvironment.html @@ -3,4 +3,4 @@ internet: Allow internet access aleph_api: Allow access to the Aleph API shared_cache: Allow access to the shared redis cache

    -

    Type declaration

    • aleph_api: boolean
    • internet: boolean
    • reproducible: false
    • shared_cache: boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • aleph_api: boolean
    • internet: boolean
    • reproducible: false
    • shared_cache: boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.FunctionRuntime.html b/docs/types/message_src.FunctionRuntime.html index 1fcfd2ea..282f253c 100644 --- a/docs/types/message_src.FunctionRuntime.html +++ b/docs/types/message_src.FunctionRuntime.html @@ -1,2 +1,2 @@ FunctionRuntime | @aleph-sdk/monorepo

    Type alias FunctionRuntime

    FunctionRuntime: {
        comment: string;
        ref: string;
        use_latest: boolean;
    }

    Execution runtime (rootfs with Python interpreter)

    -

    Type declaration

    • comment: string
    • ref: string
    • use_latest: boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • comment: string
    • ref: string
    • use_latest: boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.FunctionTriggers.html b/docs/types/message_src.FunctionTriggers.html index 4a72c8b7..e37883c5 100644 --- a/docs/types/message_src.FunctionTriggers.html +++ b/docs/types/message_src.FunctionTriggers.html @@ -1,2 +1,2 @@ FunctionTriggers | @aleph-sdk/monorepo

    Type alias FunctionTriggers

    FunctionTriggers: {
        http: boolean;
        message?: Record<string, unknown>[];
        persistent?: boolean;
    }

    Signals that trigger an execution

    -

    Type declaration

    • http: boolean
    • Optional message?: Record<string, unknown>[]
    • Optional persistent?: boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • http: boolean
    • Optional message?: Record<string, unknown>[]
    • Optional persistent?: boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.GetMessageConfiguration.html b/docs/types/message_src.GetMessageConfiguration.html index 7918a492..3d260678 100644 --- a/docs/types/message_src.GetMessageConfiguration.html +++ b/docs/types/message_src.GetMessageConfiguration.html @@ -1 +1 @@ -GetMessageConfiguration | @aleph-sdk/monorepo

    Type alias GetMessageConfiguration

    GetMessageConfiguration: {
        hash: string;
        messageType?: MessageType;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +GetMessageConfiguration | @aleph-sdk/monorepo

    Type alias GetMessageConfiguration

    GetMessageConfiguration: {
        hash: string;
        messageType?: MessageType;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.GetMessageParams.html b/docs/types/message_src.GetMessageParams.html index 0899f6fe..03198747 100644 --- a/docs/types/message_src.GetMessageParams.html +++ b/docs/types/message_src.GetMessageParams.html @@ -1 +1 @@ -GetMessageParams | @aleph-sdk/monorepo

    Type alias GetMessageParams

    GetMessageParams: {
        channels?: string[];
        hashes: string[];
        messageType?: MessageType;
    }

    Type declaration

    • Optional channels?: string[]
    • hashes: string[]
    • Optional messageType?: MessageType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +GetMessageParams | @aleph-sdk/monorepo

    Type alias GetMessageParams

    GetMessageParams: {
        channels?: string[];
        hashes: string[];
        messageType?: MessageType;
    }

    Type declaration

    • Optional channels?: string[]
    • hashes: string[]
    • Optional messageType?: MessageType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.GetMessagesConfiguration.html b/docs/types/message_src.GetMessagesConfiguration.html index 618a47fb..8ec7afe1 100644 --- a/docs/types/message_src.GetMessagesConfiguration.html +++ b/docs/types/message_src.GetMessagesConfiguration.html @@ -1 +1 @@ -GetMessagesConfiguration | @aleph-sdk/monorepo

    Type alias GetMessagesConfiguration

    GetMessagesConfiguration: {
        addresses?: string[];
        chains?: Blockchain[];
        channels?: string[];
        contentKeys?: string[];
        contentTypes?: string[];
        endDate?: Date;
        hashes?: string[];
        messageTypes?: MessageType[];
        page?: number;
        pageSize?: number;
        refs?: string[];
        startDate?: Date;
        tags?: string[];
    }

    Type declaration

    • Optional addresses?: string[]
    • Optional chains?: Blockchain[]
    • Optional channels?: string[]
    • Optional contentKeys?: string[]
    • Optional contentTypes?: string[]
    • Optional endDate?: Date
    • Optional hashes?: string[]
    • Optional messageTypes?: MessageType[]
    • Optional page?: number
    • Optional pageSize?: number
    • Optional refs?: string[]
    • Optional startDate?: Date
    • Optional tags?: string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +GetMessagesConfiguration | @aleph-sdk/monorepo

    Type alias GetMessagesConfiguration

    GetMessagesConfiguration: {
        addresses?: string[];
        chains?: Blockchain[];
        channels?: string[];
        contentKeys?: string[];
        contentTypes?: string[];
        endDate?: Date;
        hashes?: string[];
        messageTypes?: MessageType[];
        page?: number;
        pageSize?: number;
        refs?: string[];
        startDate?: Date;
        tags?: string[];
    }

    Type declaration

    • Optional addresses?: string[]
    • Optional chains?: Blockchain[]
    • Optional channels?: string[]
    • Optional contentKeys?: string[]
    • Optional contentTypes?: string[]
    • Optional endDate?: Date
    • Optional hashes?: string[]
    • Optional messageTypes?: MessageType[]
    • Optional page?: number
    • Optional pageSize?: number
    • Optional refs?: string[]
    • Optional startDate?: Date
    • Optional tags?: string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.GetMessagesParams.html b/docs/types/message_src.GetMessagesParams.html index a1599e05..eac457db 100644 --- a/docs/types/message_src.GetMessagesParams.html +++ b/docs/types/message_src.GetMessagesParams.html @@ -1 +1 @@ -GetMessagesParams | @aleph-sdk/monorepo

    Type alias GetMessagesParams

    GetMessagesParams: {
        addresses?: string;
        chains?: string;
        channels?: string;
        contentKeys?: string;
        contentTypes?: string;
        endDate?: number;
        hashes?: string;
        msgTypes?: string;
        page?: number;
        pageSize?: number;
        refs?: string;
        startDate?: number;
        tags?: string;
    }

    Type declaration

    • Optional addresses?: string
    • Optional chains?: string
    • Optional channels?: string
    • Optional contentKeys?: string
    • Optional contentTypes?: string
    • Optional endDate?: number
    • Optional hashes?: string
    • Optional msgTypes?: string
    • Optional page?: number
    • Optional pageSize?: number
    • Optional refs?: string
    • Optional startDate?: number
    • Optional tags?: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +GetMessagesParams | @aleph-sdk/monorepo

    Type alias GetMessagesParams

    GetMessagesParams: {
        addresses?: string;
        chains?: string;
        channels?: string;
        contentKeys?: string;
        contentTypes?: string;
        endDate?: number;
        hashes?: string;
        msgTypes?: string;
        page?: number;
        pageSize?: number;
        refs?: string;
        startDate?: number;
        tags?: string;
    }

    Type declaration

    • Optional addresses?: string
    • Optional chains?: string
    • Optional channels?: string
    • Optional contentKeys?: string
    • Optional contentTypes?: string
    • Optional endDate?: number
    • Optional hashes?: string
    • Optional msgTypes?: string
    • Optional page?: number
    • Optional pageSize?: number
    • Optional refs?: string
    • Optional startDate?: number
    • Optional tags?: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.GetMessagesSocketConfiguration.html b/docs/types/message_src.GetMessagesSocketConfiguration.html index d611c8cd..f11b8d97 100644 --- a/docs/types/message_src.GetMessagesSocketConfiguration.html +++ b/docs/types/message_src.GetMessagesSocketConfiguration.html @@ -1 +1 @@ -GetMessagesSocketConfiguration | @aleph-sdk/monorepo

    Type alias GetMessagesSocketConfiguration

    GetMessagesSocketConfiguration: {
        addresses?: string[];
        apiServer?: string;
        chains?: Blockchain[];
        channels?: string[];
        contentKeys?: string[];
        contentTypes?: string[];
        endDate?: Date;
        hashes?: string[];
        history?: number;
        messageType?: MessageType;
        refs?: string[];
        startDate?: Date;
        tags?: string[];
    }

    Type declaration

    • Optional addresses?: string[]
    • Optional apiServer?: string
    • Optional chains?: Blockchain[]
    • Optional channels?: string[]
    • Optional contentKeys?: string[]
    • Optional contentTypes?: string[]
    • Optional endDate?: Date
    • Optional hashes?: string[]
    • Optional history?: number
    • Optional messageType?: MessageType
    • Optional refs?: string[]
    • Optional startDate?: Date
    • Optional tags?: string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +GetMessagesSocketConfiguration | @aleph-sdk/monorepo

    Type alias GetMessagesSocketConfiguration

    GetMessagesSocketConfiguration: {
        addresses?: string[];
        apiServer?: string;
        chains?: Blockchain[];
        channels?: string[];
        contentKeys?: string[];
        contentTypes?: string[];
        endDate?: Date;
        hashes?: string[];
        history?: number;
        messageType?: MessageType;
        refs?: string[];
        startDate?: Date;
        tags?: string[];
    }

    Type declaration

    • Optional addresses?: string[]
    • Optional apiServer?: string
    • Optional chains?: Blockchain[]
    • Optional channels?: string[]
    • Optional contentKeys?: string[]
    • Optional contentTypes?: string[]
    • Optional endDate?: Date
    • Optional hashes?: string[]
    • Optional history?: number
    • Optional messageType?: MessageType
    • Optional refs?: string[]
    • Optional startDate?: Date
    • Optional tags?: string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.GetMessagesSocketParams.html b/docs/types/message_src.GetMessagesSocketParams.html index 43ac0631..9661e545 100644 --- a/docs/types/message_src.GetMessagesSocketParams.html +++ b/docs/types/message_src.GetMessagesSocketParams.html @@ -1 +1 @@ -GetMessagesSocketParams | @aleph-sdk/monorepo

    Type alias GetMessagesSocketParams

    GetMessagesSocketParams: {
        addresses?: string;
        chains?: string;
        channels?: string;
        contentKeys?: string;
        contentTypes?: string;
        endDate?: number;
        hashes?: string;
        history?: number;
        msgType?: string;
        refs?: string;
        startDate?: number;
        tags?: string;
    }

    Type declaration

    • Optional addresses?: string
    • Optional chains?: string
    • Optional channels?: string
    • Optional contentKeys?: string
    • Optional contentTypes?: string
    • Optional endDate?: number
    • Optional hashes?: string
    • Optional history?: number
    • Optional msgType?: string
    • Optional refs?: string
    • Optional startDate?: number
    • Optional tags?: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +GetMessagesSocketParams | @aleph-sdk/monorepo

    Type alias GetMessagesSocketParams

    GetMessagesSocketParams: {
        addresses?: string;
        chains?: string;
        channels?: string;
        contentKeys?: string;
        contentTypes?: string;
        endDate?: number;
        hashes?: string;
        history?: number;
        msgType?: string;
        refs?: string;
        startDate?: number;
        tags?: string;
    }

    Type declaration

    • Optional addresses?: string
    • Optional chains?: string
    • Optional channels?: string
    • Optional contentKeys?: string
    • Optional contentTypes?: string
    • Optional endDate?: number
    • Optional hashes?: string
    • Optional history?: number
    • Optional msgType?: string
    • Optional refs?: string
    • Optional startDate?: number
    • Optional tags?: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.HashedMessageProps.html b/docs/types/message_src.HashedMessageProps.html index 610c7828..34a5a434 100644 --- a/docs/types/message_src.HashedMessageProps.html +++ b/docs/types/message_src.HashedMessageProps.html @@ -1 +1 @@ -HashedMessageProps | @aleph-sdk/monorepo

    Type alias HashedMessageProps<C>

    HashedMessageProps<C>: BaseMessageProps<C> & {
        item_content?: string;
        item_hash: string;
    }

    Type Parameters

    Type declaration

    • Optional item_content?: string
    • item_hash: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +HashedMessageProps | @aleph-sdk/monorepo

    Type alias HashedMessageProps<C>

    HashedMessageProps<C>: BaseMessageProps<C> & {
        item_content?: string;
        item_hash: string;
    }

    Type Parameters

    Type declaration

    • Optional item_content?: string
    • item_hash: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.HostRequirements.html b/docs/types/message_src.HostRequirements.html index 8bd27f27..a864cf0e 100644 --- a/docs/types/message_src.HostRequirements.html +++ b/docs/types/message_src.HostRequirements.html @@ -1,3 +1,3 @@ HostRequirements | @aleph-sdk/monorepo

    Type alias HostRequirements

    HostRequirements: {
        cpu?: CpuProperties;
        node?: NodeRequirements;
    }

    cpu: Required CPU properties node: Required Compute Resource Node properties

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.ImmutableVolume.html b/docs/types/message_src.ImmutableVolume.html index fe73df7f..8a8d2d01 100644 --- a/docs/types/message_src.ImmutableVolume.html +++ b/docs/types/message_src.ImmutableVolume.html @@ -2,4 +2,4 @@ They can be shared by multiple programs and updated independently of the code of the program.

    You can use them to store Python libraries that your program depends on, use them in multiple programs and update them independently of other programs.

    -

    Type declaration

    • is_read_only: (() => true)
        • (): true

        • Returns true

    • ref: string
    • use_latest: boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • is_read_only: (() => true)
        • (): true

        • Returns true

    • ref: string
    • use_latest: boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.InstanceContent.html b/docs/types/message_src.InstanceContent.html index 1a10ec36..fd425498 100644 --- a/docs/types/message_src.InstanceContent.html +++ b/docs/types/message_src.InstanceContent.html @@ -1,3 +1,3 @@ InstanceContent | @aleph-sdk/monorepo

    Type alias InstanceContent

    InstanceContent: BaseExecutableContent & {
        rootfs: RootfsVolume;
    }

    Message content for scheduling a VM instance on the network.

    rootfs: Root filesystem of the system, will be booted by the kernel"

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.InstanceEnvironment.html b/docs/types/message_src.InstanceEnvironment.html index 5ddcca6f..b23972f1 100644 --- a/docs/types/message_src.InstanceEnvironment.html +++ b/docs/types/message_src.InstanceEnvironment.html @@ -5,4 +5,4 @@ shared_cache: Allow access to the shared redis cache hypervisor: Hypervisor to use for the execution, can be Firecracker or Qemu trusted_execution: Sets the execution as confidential

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.InstanceMessage.html b/docs/types/message_src.InstanceMessage.html index 0fade43b..523b9a0f 100644 --- a/docs/types/message_src.InstanceMessage.html +++ b/docs/types/message_src.InstanceMessage.html @@ -1 +1 @@ -InstanceMessage | @aleph-sdk/monorepo

    Type alias InstanceMessage

    InstanceMessage: SignedMessage<InstanceContent>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +InstanceMessage | @aleph-sdk/monorepo

    Type alias InstanceMessage

    InstanceMessage: SignedMessage<InstanceContent>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.InstancePublishConfiguration.html b/docs/types/message_src.InstancePublishConfiguration.html index 9c2591e2..baf4c328 100644 --- a/docs/types/message_src.InstancePublishConfiguration.html +++ b/docs/types/message_src.InstancePublishConfiguration.html @@ -1 +1 @@ -InstancePublishConfiguration | @aleph-sdk/monorepo

    Type alias InstancePublishConfiguration

    InstancePublishConfiguration: {
        account: Account;
        authorized_keys?: string[];
        channel?: string;
        environment?: Partial<InstanceEnvironment>;
        image?: string;
        metadata?: Record<string, unknown>;
        payment?: Payment;
        requirements?: HostRequirements;
        resources?: Partial<MachineResources>;
        storageEngine?: ipfs | storage;
        sync?: boolean;
        variables?: Record<string, string>;
        volumes?: MachineVolume[];
    }

    Type declaration

    • account: Account
    • Optional authorized_keys?: string[]
    • Optional channel?: string
    • Optional environment?: Partial<InstanceEnvironment>
    • Optional image?: string
    • Optional metadata?: Record<string, unknown>
    • Optional payment?: Payment
    • Optional requirements?: HostRequirements
    • Optional resources?: Partial<MachineResources>
    • Optional storageEngine?: ipfs | storage
    • Optional sync?: boolean
    • Optional variables?: Record<string, string>
    • Optional volumes?: MachineVolume[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +InstancePublishConfiguration | @aleph-sdk/monorepo

    Type alias InstancePublishConfiguration

    InstancePublishConfiguration: {
        account: Account;
        authorized_keys?: string[];
        channel?: string;
        environment?: Partial<InstanceEnvironment>;
        image?: string;
        metadata?: Record<string, unknown>;
        payment?: Payment;
        requirements?: HostRequirements;
        resources?: Partial<MachineResources>;
        storageEngine?: ipfs | storage;
        sync?: boolean;
        variables?: Record<string, string>;
        volumes?: MachineVolume[];
    }

    Type declaration

    • account: Account
    • Optional authorized_keys?: string[]
    • Optional channel?: string
    • Optional environment?: Partial<InstanceEnvironment>
    • Optional image?: string
    • Optional metadata?: Record<string, unknown>
    • Optional payment?: Payment
    • Optional requirements?: HostRequirements
    • Optional resources?: Partial<MachineResources>
    • Optional storageEngine?: ipfs | storage
    • Optional sync?: boolean
    • Optional variables?: Record<string, string>
    • Optional volumes?: MachineVolume[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.ItemHash.html b/docs/types/message_src.ItemHash.html index 6894d087..6ca9b043 100644 --- a/docs/types/message_src.ItemHash.html +++ b/docs/types/message_src.ItemHash.html @@ -1 +1 @@ -ItemHash | @aleph-sdk/monorepo

    Type alias ItemHash

    ItemHash: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ItemHash | @aleph-sdk/monorepo

    Type alias ItemHash

    ItemHash: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.MachineResources.html b/docs/types/message_src.MachineResources.html index c8dc631f..38883056 100644 --- a/docs/types/message_src.MachineResources.html +++ b/docs/types/message_src.MachineResources.html @@ -2,4 +2,4 @@

    vcpus: Number of virtual CPUs memory: Memory in MiB seconds: Timeout in seconds

    -

    Type declaration

    • memory: number
    • seconds: number
    • vcpus: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • memory: number
    • seconds: number
    • vcpus: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.MachineVolume.html b/docs/types/message_src.MachineVolume.html index 2c210ff2..5b6d04e7 100644 --- a/docs/types/message_src.MachineVolume.html +++ b/docs/types/message_src.MachineVolume.html @@ -1 +1 @@ -MachineVolume | @aleph-sdk/monorepo

    Type alias MachineVolume

    MachineVolume: ImmutableVolume | EphemeralVolume | PersistentVolume

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +MachineVolume | @aleph-sdk/monorepo

    Type alias MachineVolume

    MachineVolume: ImmutableVolume | EphemeralVolume | PersistentVolume

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.Message.html b/docs/types/message_src.Message.html index 6008c493..289f4dcf 100644 --- a/docs/types/message_src.Message.html +++ b/docs/types/message_src.Message.html @@ -1 +1 @@ -Message | @aleph-sdk/monorepo

    Type alias Message

    Message: ProgramMessage | InstanceMessage | StoreMessage | PostMessage<any> | AggregateMessage<any> | ForgetMessage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Message | @aleph-sdk/monorepo

    Type alias Message

    Message: ProgramMessage | InstanceMessage | StoreMessage | PostMessage<any> | AggregateMessage<any> | ForgetMessage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.MessageBuilderConfig.html b/docs/types/message_src.MessageBuilderConfig.html index aca9fe42..8a5804e4 100644 --- a/docs/types/message_src.MessageBuilderConfig.html +++ b/docs/types/message_src.MessageBuilderConfig.html @@ -1 +1 @@ -MessageBuilderConfig | @aleph-sdk/monorepo

    Type alias MessageBuilderConfig<C>

    MessageBuilderConfig<C>: {
        account: Account;
        channel?: string;
        content: C;
        storageEngine: ItemType;
        timestamp: number;
    }

    Type Parameters

    • C

    Type declaration

    • account: Account
    • Optional channel?: string
    • content: C
    • storageEngine: ItemType
    • timestamp: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +MessageBuilderConfig | @aleph-sdk/monorepo

    Type alias MessageBuilderConfig<C>

    MessageBuilderConfig<C>: {
        account: Account;
        channel?: string;
        content: C;
        storageEngine: ItemType;
        timestamp: number;
    }

    Type Parameters

    • C

    Type declaration

    • account: Account
    • Optional channel?: string
    • content: C
    • storageEngine: ItemType
    • timestamp: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.MessageConfirmation.html b/docs/types/message_src.MessageConfirmation.html index 26f2ffc5..20e9235f 100644 --- a/docs/types/message_src.MessageConfirmation.html +++ b/docs/types/message_src.MessageConfirmation.html @@ -1,4 +1,4 @@ MessageConfirmation | @aleph-sdk/monorepo

    Type alias MessageConfirmation

    MessageConfirmation: {
        chain: string;
        hash: string | MessageConfirmationHash;
        height: number;
        publisher?: string;
        time?: number;
    }

    Format of the result when a message has been confirmed on a blockchain The time and publisher field are introduced in recent versions of CCNs. They should remain optional until the corresponding CCN upload (0.4.0) is widely uploaded.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.MessageConfirmationHash.html b/docs/types/message_src.MessageConfirmationHash.html index 06bb1f6e..82b5ae44 100644 --- a/docs/types/message_src.MessageConfirmationHash.html +++ b/docs/types/message_src.MessageConfirmationHash.html @@ -1 +1 @@ -MessageConfirmationHash | @aleph-sdk/monorepo

    Type alias MessageConfirmationHash

    MessageConfirmationHash: {
        binary: string;
        type: string;
    }

    Type declaration

    • binary: string
    • type: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +MessageConfirmationHash | @aleph-sdk/monorepo

    Type alias MessageConfirmationHash

    MessageConfirmationHash: {
        binary: string;
        type: string;
    }

    Type declaration

    • binary: string
    • type: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.MessageContent.html b/docs/types/message_src.MessageContent.html index de6193a7..7a1eee24 100644 --- a/docs/types/message_src.MessageContent.html +++ b/docs/types/message_src.MessageContent.html @@ -1 +1 @@ -MessageContent | @aleph-sdk/monorepo

    Type alias MessageContent<Content>

    MessageContent<Content>: PostContent<Content> | AggregateContent<Content> | StoreContent | ProgramContent | ForgetContent | InstanceContent

    Type Parameters

    • Content = any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +MessageContent | @aleph-sdk/monorepo

    Type alias MessageContent<Content>

    MessageContent<Content>: PostContent<Content> | AggregateContent<Content> | StoreContent | ProgramContent | ForgetContent | InstanceContent

    Type Parameters

    • Content = any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.MessageError.html b/docs/types/message_src.MessageError.html index 40ad0193..4d64c7e0 100644 --- a/docs/types/message_src.MessageError.html +++ b/docs/types/message_src.MessageError.html @@ -1 +1 @@ -MessageError | @aleph-sdk/monorepo

    Type alias MessageError

    MessageError: {
        details: string;
        error_code: string;
    }

    Type declaration

    • details: string
    • error_code: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +MessageError | @aleph-sdk/monorepo

    Type alias MessageError

    MessageError: {
        details: string;
        error_code: string;
    }

    Type declaration

    • details: string
    • error_code: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.MessageResponse.html b/docs/types/message_src.MessageResponse.html index 85a3daea..04d62736 100644 --- a/docs/types/message_src.MessageResponse.html +++ b/docs/types/message_src.MessageResponse.html @@ -1 +1 @@ -MessageResponse | @aleph-sdk/monorepo

    Type alias MessageResponse<T>

    MessageResponse<T>: {
        forgotten_by?: string[];
        item_hash: string;
        message: PublishedMessage<T>;
        status: MessageStatus;
    }

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +MessageResponse | @aleph-sdk/monorepo

    Type alias MessageResponse<T>

    MessageResponse<T>: {
        forgotten_by?: string[];
        item_hash: string;
        message: PublishedMessage<T>;
        status: MessageStatus;
    }

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.MessagesQueryResponse.html b/docs/types/message_src.MessagesQueryResponse.html index ac2c62bc..35a4a30b 100644 --- a/docs/types/message_src.MessagesQueryResponse.html +++ b/docs/types/message_src.MessagesQueryResponse.html @@ -1 +1 @@ -MessagesQueryResponse | @aleph-sdk/monorepo

    Type alias MessagesQueryResponse

    MessagesQueryResponse: {
        messages: PublishedMessage<MessageContent>[];
        pagination_item: string;
        pagination_page: number;
        pagination_per_page: number;
        pagination_total: number;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +MessagesQueryResponse | @aleph-sdk/monorepo

    Type alias MessagesQueryResponse

    MessagesQueryResponse: {
        messages: PublishedMessage<MessageContent>[];
        pagination_item: string;
        pagination_page: number;
        pagination_per_page: number;
        pagination_total: number;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.NodeRequirements.html b/docs/types/message_src.NodeRequirements.html index 1296d8f0..f0558583 100644 --- a/docs/types/message_src.NodeRequirements.html +++ b/docs/types/message_src.NodeRequirements.html @@ -1,4 +1,4 @@ NodeRequirements | @aleph-sdk/monorepo

    Type alias NodeRequirements

    NodeRequirements: {
        address_regex?: string;
        node_hash?: string;
        owner?: string;
    }

    Additional properties required for the node

    owner: Owner address of the node (not available yet) address_regex: Regular expression to match the node address (not available yet)

    -

    Type declaration

    • Optional address_regex?: string
    • Optional node_hash?: string
    • Optional owner?: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • Optional address_regex?: string
    • Optional node_hash?: string
    • Optional owner?: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.ParentVolume.html b/docs/types/message_src.ParentVolume.html index 0bc3266f..a5a81fde 100644 --- a/docs/types/message_src.ParentVolume.html +++ b/docs/types/message_src.ParentVolume.html @@ -1,2 +1,2 @@ ParentVolume | @aleph-sdk/monorepo

    Type alias ParentVolume

    ParentVolume: {
        ref: ItemHash;
        use_latest: boolean;
    }

    A reference volume to copy as a persistent volume.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.Payment.html b/docs/types/message_src.Payment.html index ecf42064..b2eba420 100644 --- a/docs/types/message_src.Payment.html +++ b/docs/types/message_src.Payment.html @@ -2,4 +2,4 @@

    chain: Blockchain to use receiver: Receiver address, should be usually the (streaming) reward address of the targeted node type: Payment type (hold, stream)

    -

    Type declaration

    • chain: Blockchain
    • Optional receiver?: string
    • type: PaymentType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    • chain: Blockchain
    • Optional receiver?: string
    • type: PaymentType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.PersistentVolume.html b/docs/types/message_src.PersistentVolume.html index 297792ea..77b00d7d 100644 --- a/docs/types/message_src.PersistentVolume.html +++ b/docs/types/message_src.PersistentVolume.html @@ -2,4 +2,4 @@ would be useful to persist between executions but can be recovered from other sources.

    There is no guarantee that these volumes will not be deleted anytime, when the program is not running and important data must be persisted on the Aleph network.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.PostContent.html b/docs/types/message_src.PostContent.html index a826ab05..3a7ea4f1 100644 --- a/docs/types/message_src.PostContent.html +++ b/docs/types/message_src.PostContent.html @@ -1 +1 @@ -PostContent | @aleph-sdk/monorepo

    Type alias PostContent<T>

    PostContent<T>: BaseContent & {
        content?: T;
        ref?: string | ChainRef;
        type: string;
    }

    Type Parameters

    • T

    Type declaration

    • Optional content?: T
    • Optional ref?: string | ChainRef
    • type: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PostContent | @aleph-sdk/monorepo

    Type alias PostContent<T>

    PostContent<T>: BaseContent & {
        content?: T;
        ref?: string | ChainRef;
        type: string;
    }

    Type Parameters

    • T

    Type declaration

    • Optional content?: T
    • Optional ref?: string | ChainRef
    • type: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.PostGetConfiguration.html b/docs/types/message_src.PostGetConfiguration.html index e02306f9..7f1d031d 100644 --- a/docs/types/message_src.PostGetConfiguration.html +++ b/docs/types/message_src.PostGetConfiguration.html @@ -1 +1 @@ -PostGetConfiguration | @aleph-sdk/monorepo

    Type alias PostGetConfiguration

    PostGetConfiguration: {
        addresses?: string[];
        channels?: string[];
        hashes?: string[];
        page?: number;
        pageSize?: number;
        refs?: string[];
        tags?: string[];
        types?: string | string[];
    }

    Type declaration

    • Optional addresses?: string[]
    • Optional channels?: string[]
    • Optional hashes?: string[]
    • Optional page?: number
    • Optional pageSize?: number
    • Optional refs?: string[]
    • Optional tags?: string[]
    • Optional types?: string | string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PostGetConfiguration | @aleph-sdk/monorepo

    Type alias PostGetConfiguration

    PostGetConfiguration: {
        addresses?: string[];
        channels?: string[];
        hashes?: string[];
        page?: number;
        pageSize?: number;
        refs?: string[];
        tags?: string[];
        types?: string | string[];
    }

    Type declaration

    • Optional addresses?: string[]
    • Optional channels?: string[]
    • Optional hashes?: string[]
    • Optional page?: number
    • Optional pageSize?: number
    • Optional refs?: string[]
    • Optional tags?: string[]
    • Optional types?: string | string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.PostMessage.html b/docs/types/message_src.PostMessage.html index dcfa459e..df43c5af 100644 --- a/docs/types/message_src.PostMessage.html +++ b/docs/types/message_src.PostMessage.html @@ -1 +1 @@ -PostMessage | @aleph-sdk/monorepo

    Type alias PostMessage<T>

    PostMessage<T>: SignedMessage<PostContent<T>>

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PostMessage | @aleph-sdk/monorepo

    Type alias PostMessage<T>

    PostMessage<T>: SignedMessage<PostContent<T>>

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.PostPublishConfiguration.html b/docs/types/message_src.PostPublishConfiguration.html index 80ca6f0e..7761c3e5 100644 --- a/docs/types/message_src.PostPublishConfiguration.html +++ b/docs/types/message_src.PostPublishConfiguration.html @@ -1 +1 @@ -PostPublishConfiguration | @aleph-sdk/monorepo

    Type alias PostPublishConfiguration<T>

    PostPublishConfiguration<T>: {
        account: Account;
        address?: string;
        channel?: string;
        content: T;
        postType: string;
        ref?: string | ChainRef;
        storageEngine?: ItemType;
        sync?: boolean;
    }

    Type Parameters

    • T

    Type declaration

    • account: Account
    • Optional address?: string
    • Optional channel?: string
    • content: T
    • postType: string
    • Optional ref?: string | ChainRef
    • Optional storageEngine?: ItemType
    • Optional sync?: boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PostPublishConfiguration | @aleph-sdk/monorepo

    Type alias PostPublishConfiguration<T>

    PostPublishConfiguration<T>: {
        account: Account;
        address?: string;
        channel?: string;
        content: T;
        postType: string;
        ref?: string | ChainRef;
        storageEngine?: ItemType;
        sync?: boolean;
    }

    Type Parameters

    • T

    Type declaration

    • account: Account
    • Optional address?: string
    • Optional channel?: string
    • content: T
    • postType: string
    • Optional ref?: string | ChainRef
    • Optional storageEngine?: ItemType
    • Optional sync?: boolean

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.PostQueryParams.html b/docs/types/message_src.PostQueryParams.html index b639428a..7c769db5 100644 --- a/docs/types/message_src.PostQueryParams.html +++ b/docs/types/message_src.PostQueryParams.html @@ -1 +1 @@ -PostQueryParams | @aleph-sdk/monorepo

    Type alias PostQueryParams

    PostQueryParams: {
        addresses?: string;
        channels?: string;
        hashes?: string;
        page: number;
        pageSize: number;
        refs?: string;
        tags?: string;
        types?: string | string[];
    }

    Type declaration

    • Optional addresses?: string
    • Optional channels?: string
    • Optional hashes?: string
    • page: number
    • pageSize: number
    • Optional refs?: string
    • Optional tags?: string
    • Optional types?: string | string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PostQueryParams | @aleph-sdk/monorepo

    Type alias PostQueryParams

    PostQueryParams: {
        addresses?: string;
        channels?: string;
        hashes?: string;
        page: number;
        pageSize: number;
        refs?: string;
        tags?: string;
        types?: string | string[];
    }

    Type declaration

    • Optional addresses?: string
    • Optional channels?: string
    • Optional hashes?: string
    • page: number
    • pageSize: number
    • Optional refs?: string
    • Optional tags?: string
    • Optional types?: string | string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.PostQueryResponse.html b/docs/types/message_src.PostQueryResponse.html index 27037b6a..1df7246e 100644 --- a/docs/types/message_src.PostQueryResponse.html +++ b/docs/types/message_src.PostQueryResponse.html @@ -1 +1 @@ -PostQueryResponse | @aleph-sdk/monorepo

    Type alias PostQueryResponse<T>

    PostQueryResponse<T>: {
        pagination_item: string;
        pagination_page: number;
        pagination_per_page: number;
        pagination_total: number;
        posts: PostResponse<T>[];
    }

    Type Parameters

    • T

    Type declaration

    • pagination_item: string
    • pagination_page: number
    • pagination_per_page: number
    • pagination_total: number
    • posts: PostResponse<T>[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PostQueryResponse | @aleph-sdk/monorepo

    Type alias PostQueryResponse<T>

    PostQueryResponse<T>: {
        pagination_item: string;
        pagination_page: number;
        pagination_per_page: number;
        pagination_total: number;
        posts: PostResponse<T>[];
    }

    Type Parameters

    • T

    Type declaration

    • pagination_item: string
    • pagination_page: number
    • pagination_per_page: number
    • pagination_total: number
    • posts: PostResponse<T>[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.PostResponse.html b/docs/types/message_src.PostResponse.html index d6f63a16..db94c7e1 100644 --- a/docs/types/message_src.PostResponse.html +++ b/docs/types/message_src.PostResponse.html @@ -1 +1 @@ -PostResponse | @aleph-sdk/monorepo

    Type alias PostResponse<T>

    PostResponse<T>: {
        _id: {
            $oid: string;
        };
        address: string;
        chain: string;
        channel: string;
        confirmed: boolean;
        content: T;
        hash: string;
        item_content: string;
        item_hash: string;
        item_type: string;
        original_item_hash: string;
        original_signature: string;
        original_type: string;
        sender: string;
        signature: string;
        size: number;
        time: number;
        type: string;
    }

    Type Parameters

    • T

    Type declaration

    • _id: {
          $oid: string;
      }
      • $oid: string
    • address: string
    • chain: string
    • channel: string
    • confirmed: boolean
    • content: T
    • hash: string
    • item_content: string
    • item_hash: string
    • item_type: string
    • original_item_hash: string
    • original_signature: string
    • original_type: string
    • sender: string
    • signature: string
    • size: number
    • time: number
    • type: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PostResponse | @aleph-sdk/monorepo

    Type alias PostResponse<T>

    PostResponse<T>: {
        _id: {
            $oid: string;
        };
        address: string;
        chain: string;
        channel: string;
        confirmed: boolean;
        content: T;
        hash: string;
        item_content: string;
        item_hash: string;
        item_type: string;
        original_item_hash: string;
        original_signature: string;
        original_type: string;
        sender: string;
        signature: string;
        size: number;
        time: number;
        type: string;
    }

    Type Parameters

    • T

    Type declaration

    • _id: {
          $oid: string;
      }
      • $oid: string
    • address: string
    • chain: string
    • channel: string
    • confirmed: boolean
    • content: T
    • hash: string
    • item_content: string
    • item_hash: string
    • item_type: string
    • original_item_hash: string
    • original_signature: string
    • original_type: string
    • sender: string
    • signature: string
    • size: number
    • time: number
    • type: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.ProgramContent.html b/docs/types/message_src.ProgramContent.html index b7bddc41..9cb2992f 100644 --- a/docs/types/message_src.ProgramContent.html +++ b/docs/types/message_src.ProgramContent.html @@ -1 +1 @@ -ProgramContent | @aleph-sdk/monorepo

    Type alias ProgramContent

    ProgramContent: BaseExecutableContent & {
        code: CodeContent;
        data?: DataContent;
        export?: Export;
        on: FunctionTriggers;
        runtime: FunctionRuntime;
        type: vm_function;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ProgramContent | @aleph-sdk/monorepo

    Type alias ProgramContent

    ProgramContent: BaseExecutableContent & {
        code: CodeContent;
        data?: DataContent;
        export?: Export;
        on: FunctionTriggers;
        runtime: FunctionRuntime;
        type: vm_function;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.ProgramMessage.html b/docs/types/message_src.ProgramMessage.html index 24c366eb..8ef9b034 100644 --- a/docs/types/message_src.ProgramMessage.html +++ b/docs/types/message_src.ProgramMessage.html @@ -1 +1 @@ -ProgramMessage | @aleph-sdk/monorepo

    Type alias ProgramMessage

    ProgramMessage: SignedMessage<ProgramContent>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ProgramMessage | @aleph-sdk/monorepo

    Type alias ProgramMessage

    ProgramMessage: SignedMessage<ProgramContent>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.ProgramPublishConfiguration.html b/docs/types/message_src.ProgramPublishConfiguration.html index cd19ee20..0edc4df4 100644 --- a/docs/types/message_src.ProgramPublishConfiguration.html +++ b/docs/types/message_src.ProgramPublishConfiguration.html @@ -1 +1 @@ -ProgramPublishConfiguration | @aleph-sdk/monorepo

    Type alias ProgramPublishConfiguration

    ProgramPublishConfiguration: RequireOnlyOne<{
        account: Account;
        channel: string;
        encoding?: Encoding;
        entrypoint: string;
        file?: Buffer | Blob;
        isPersistent?: boolean;
        memory?: number;
        metadata?: Record<string, unknown>;
        payment?: Payment;
        programRef?: string;
        runtime?: string;
        storageEngine?: ipfs | storage;
        subscriptions?: Record<string, unknown>[];
        sync?: boolean;
        variables?: Record<string, string>;
        vcpus?: number;
        volumes?: MachineVolume[];
    }, "programRef" | "file">

    Type declaration

    • account: Account
    • channel: string
    • Optional encoding?: Encoding
    • entrypoint: string
    • Optional file?: Buffer | Blob
    • Optional isPersistent?: boolean
    • Optional memory?: number
    • Optional metadata?: Record<string, unknown>
    • Optional payment?: Payment
    • Optional programRef?: string
    • Optional runtime?: string
    • Optional storageEngine?: ipfs | storage
    • Optional subscriptions?: Record<string, unknown>[]
    • Optional sync?: boolean
    • Optional variables?: Record<string, string>
    • Optional vcpus?: number
    • Optional volumes?: MachineVolume[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ProgramPublishConfiguration | @aleph-sdk/monorepo

    Type alias ProgramPublishConfiguration

    ProgramPublishConfiguration: RequireOnlyOne<{
        account: Account;
        channel: string;
        encoding?: Encoding;
        entrypoint: string;
        file?: Buffer | Blob;
        isPersistent?: boolean;
        memory?: number;
        metadata?: Record<string, unknown>;
        payment?: Payment;
        programRef?: string;
        runtime?: string;
        storageEngine?: ipfs | storage;
        subscriptions?: Record<string, unknown>[];
        sync?: boolean;
        variables?: Record<string, string>;
        vcpus?: number;
        volumes?: MachineVolume[];
    }, "programRef" | "file">

    Type declaration

    • account: Account
    • channel: string
    • Optional encoding?: Encoding
    • entrypoint: string
    • Optional file?: Buffer | Blob
    • Optional isPersistent?: boolean
    • Optional memory?: number
    • Optional metadata?: Record<string, unknown>
    • Optional payment?: Payment
    • Optional programRef?: string
    • Optional runtime?: string
    • Optional storageEngine?: ipfs | storage
    • Optional subscriptions?: Record<string, unknown>[]
    • Optional sync?: boolean
    • Optional variables?: Record<string, string>
    • Optional vcpus?: number
    • Optional volumes?: MachineVolume[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.ProgramSpawnConfiguration.html b/docs/types/message_src.ProgramSpawnConfiguration.html index fadc6778..3536c4f0 100644 --- a/docs/types/message_src.ProgramSpawnConfiguration.html +++ b/docs/types/message_src.ProgramSpawnConfiguration.html @@ -1 +1 @@ -ProgramSpawnConfiguration | @aleph-sdk/monorepo

    Type alias ProgramSpawnConfiguration

    ProgramSpawnConfiguration: {
        account: Account;
        channel: string;
        encoding?: Encoding;
        entrypoint: string;
        isPersistent?: boolean;
        memory?: number;
        metadata?: Record<string, unknown>;
        payment?: Payment;
        programRef: string;
        runtime?: string;
        storageEngine?: ipfs | storage;
        subscriptions?: Record<string, unknown>[];
        sync?: boolean;
        variables?: Record<string, string>;
        vcpus?: number;
        volumes?: MachineVolume[];
    }

    Type declaration

    • account: Account
    • channel: string
    • Optional encoding?: Encoding
    • entrypoint: string
    • Optional isPersistent?: boolean
    • Optional memory?: number
    • Optional metadata?: Record<string, unknown>
    • Optional payment?: Payment
    • programRef: string
    • Optional runtime?: string
    • Optional storageEngine?: ipfs | storage
    • Optional subscriptions?: Record<string, unknown>[]
    • Optional sync?: boolean
    • Optional variables?: Record<string, string>
    • Optional vcpus?: number
    • Optional volumes?: MachineVolume[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ProgramSpawnConfiguration | @aleph-sdk/monorepo

    Type alias ProgramSpawnConfiguration

    ProgramSpawnConfiguration: {
        account: Account;
        channel: string;
        encoding?: Encoding;
        entrypoint: string;
        isPersistent?: boolean;
        memory?: number;
        metadata?: Record<string, unknown>;
        payment?: Payment;
        programRef: string;
        runtime?: string;
        storageEngine?: ipfs | storage;
        subscriptions?: Record<string, unknown>[];
        sync?: boolean;
        variables?: Record<string, string>;
        vcpus?: number;
        volumes?: MachineVolume[];
    }

    Type declaration

    • account: Account
    • channel: string
    • Optional encoding?: Encoding
    • entrypoint: string
    • Optional isPersistent?: boolean
    • Optional memory?: number
    • Optional metadata?: Record<string, unknown>
    • Optional payment?: Payment
    • programRef: string
    • Optional runtime?: string
    • Optional storageEngine?: ipfs | storage
    • Optional subscriptions?: Record<string, unknown>[]
    • Optional sync?: boolean
    • Optional variables?: Record<string, string>
    • Optional vcpus?: number
    • Optional volumes?: MachineVolume[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.PublishedMessageProps.html b/docs/types/message_src.PublishedMessageProps.html index 39d2e0b2..1bbdbd4d 100644 --- a/docs/types/message_src.PublishedMessageProps.html +++ b/docs/types/message_src.PublishedMessageProps.html @@ -1 +1 @@ -PublishedMessageProps | @aleph-sdk/monorepo

    Type alias PublishedMessageProps<C>

    PublishedMessageProps<C>: SignedMessageProps<C> & {
        confirmations: MessageConfirmation[];
        confirmed: boolean;
    }

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PublishedMessageProps | @aleph-sdk/monorepo

    Type alias PublishedMessageProps<C>

    PublishedMessageProps<C>: SignedMessageProps<C> & {
        confirmations: MessageConfirmation[];
        confirmed: boolean;
    }

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.RootfsVolume.html b/docs/types/message_src.RootfsVolume.html index 62b941a3..c1315c01 100644 --- a/docs/types/message_src.RootfsVolume.html +++ b/docs/types/message_src.RootfsVolume.html @@ -1,3 +1,3 @@ RootfsVolume | @aleph-sdk/monorepo

    Type alias RootfsVolume

    RootfsVolume: {
        parent: ParentVolume;
        persistence: VolumePersistence;
        size_mib: number;
    }

    Root file system of a VM instance. The root file system of an instance is built as a copy of a reference image, named parent image. The user determines a custom size and persistence model.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.SignedMessageProps.html b/docs/types/message_src.SignedMessageProps.html index 80f76af3..cf607c58 100644 --- a/docs/types/message_src.SignedMessageProps.html +++ b/docs/types/message_src.SignedMessageProps.html @@ -1 +1 @@ -SignedMessageProps | @aleph-sdk/monorepo

    Type alias SignedMessageProps<C>

    SignedMessageProps<C>: HashedMessageProps<C> & {
        signature: string;
    }

    Type Parameters

    Type declaration

    • signature: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +SignedMessageProps | @aleph-sdk/monorepo

    Type alias SignedMessageProps<C>

    SignedMessageProps<C>: HashedMessageProps<C> & {
        signature: string;
    }

    Type Parameters

    Type declaration

    • signature: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.SocketResponse.html b/docs/types/message_src.SocketResponse.html index dd5e0bc2..8f046142 100644 --- a/docs/types/message_src.SocketResponse.html +++ b/docs/types/message_src.SocketResponse.html @@ -1 +1 @@ -SocketResponse | @aleph-sdk/monorepo

    Type alias SocketResponse

    SocketResponse: {
        _id?: string;
        chain: Blockchain;
        channel: string;
        confirmations?: boolean;
        confirmed: boolean;
        content: BaseContent;
        hash_type?: string;
        item_content?: string;
        item_hash: string;
        item_type: ItemType;
        sender: string;
        signature: string;
        size: number;
        time: number;
        type: MessageType;
    }

    Type declaration

    • Optional _id?: string
    • chain: Blockchain
    • channel: string
    • Optional confirmations?: boolean
    • confirmed: boolean
    • content: BaseContent
    • Optional hash_type?: string
    • Optional item_content?: string
    • item_hash: string
    • item_type: ItemType
    • sender: string
    • signature: string
    • size: number
    • time: number
    • type: MessageType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +SocketResponse | @aleph-sdk/monorepo

    Type alias SocketResponse

    SocketResponse: {
        _id?: string;
        chain: Blockchain;
        channel: string;
        confirmations?: boolean;
        confirmed: boolean;
        content: BaseContent;
        hash_type?: string;
        item_content?: string;
        item_hash: string;
        item_type: ItemType;
        sender: string;
        signature: string;
        size: number;
        time: number;
        type: MessageType;
    }

    Type declaration

    • Optional _id?: string
    • chain: Blockchain
    • channel: string
    • Optional confirmations?: boolean
    • confirmed: boolean
    • content: BaseContent
    • Optional hash_type?: string
    • Optional item_content?: string
    • item_hash: string
    • item_type: ItemType
    • sender: string
    • signature: string
    • size: number
    • time: number
    • type: MessageType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.StoreContent.html b/docs/types/message_src.StoreContent.html index a07c6b6e..4f1b0d8a 100644 --- a/docs/types/message_src.StoreContent.html +++ b/docs/types/message_src.StoreContent.html @@ -1 +1 @@ -StoreContent | @aleph-sdk/monorepo

    Type alias StoreContent

    StoreContent: BaseContent & {
        content_type?: string;
        extra_fields?: Record<string, unknown>;
        item_hash: string;
        item_type: string;
        ref?: string;
        size?: number;
    }

    Type declaration

    • Optional content_type?: string
    • Optional extra_fields?: Record<string, unknown>
    • item_hash: string
    • item_type: string
    • Optional ref?: string
    • Optional size?: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +StoreContent | @aleph-sdk/monorepo

    Type alias StoreContent

    StoreContent: BaseContent & {
        content_type?: string;
        extra_fields?: Record<string, unknown>;
        item_hash: string;
        item_type: string;
        ref?: string;
        size?: number;
    }

    Type declaration

    • Optional content_type?: string
    • Optional extra_fields?: Record<string, unknown>
    • item_hash: string
    • item_type: string
    • Optional ref?: string
    • Optional size?: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.StoreMessage.html b/docs/types/message_src.StoreMessage.html index d8bbbb8f..9943b294 100644 --- a/docs/types/message_src.StoreMessage.html +++ b/docs/types/message_src.StoreMessage.html @@ -1 +1 @@ -StoreMessage | @aleph-sdk/monorepo

    Type alias StoreMessage

    StoreMessage: SignedMessage<StoreContent>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +StoreMessage | @aleph-sdk/monorepo

    Type alias StoreMessage

    StoreMessage: SignedMessage<StoreContent>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.StorePinConfiguration.html b/docs/types/message_src.StorePinConfiguration.html index 02095095..5ed4e8a0 100644 --- a/docs/types/message_src.StorePinConfiguration.html +++ b/docs/types/message_src.StorePinConfiguration.html @@ -3,4 +3,4 @@

    fileHash: The IPFS hash of the content you want to pin.

    storageEngine: [Deprecated] - The storage engine to used when storing the message.

    apiServer: The API server endpoint used to carry the request to the Aleph's network.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.StorePublishConfiguration.html b/docs/types/message_src.StorePublishConfiguration.html index 29f3b0ab..764d16b4 100644 --- a/docs/types/message_src.StorePublishConfiguration.html +++ b/docs/types/message_src.StorePublishConfiguration.html @@ -6,4 +6,4 @@

    inlineRequested: If set to False, the Store message will be store on the same storageEngine you picked.

    extraFields: Extra fields to add to the Store message.

    sync: If true, the function will wait for the message to be confirmed by the API server.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/message_src.TrustedExecutionEnvironment.html b/docs/types/message_src.TrustedExecutionEnvironment.html index a6946a45..abfd001a 100644 --- a/docs/types/message_src.TrustedExecutionEnvironment.html +++ b/docs/types/message_src.TrustedExecutionEnvironment.html @@ -1,4 +1,4 @@ TrustedExecutionEnvironment | @aleph-sdk/monorepo

    Type alias TrustedExecutionEnvironment

    TrustedExecutionEnvironment: {
        firmware: string;
        policy: number;
    }

    Properties of the trusted execution environment

    firmware: Firmware to use for the trusted execution policy: Policy to use for trusted execution

    -

    Type declaration

    • firmware: string
    • policy: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/nuls2_src.ChainNAddress.html b/docs/types/nuls2_src.ChainNAddress.html index ae891ffa..6f362cff 100644 --- a/docs/types/nuls2_src.ChainNAddress.html +++ b/docs/types/nuls2_src.ChainNAddress.html @@ -1 +1 @@ -ChainNAddress | @aleph-sdk/monorepo

    Type alias ChainNAddress

    ChainNAddress: {
        address_type?: number;
        chain_id?: number;
    }

    Type declaration

    • Optional address_type?: number
    • Optional chain_id?: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ChainNAddress | @aleph-sdk/monorepo

    Type alias ChainNAddress

    ChainNAddress: {
        address_type?: number;
        chain_id?: number;
    }

    Type declaration

    • Optional address_type?: number
    • Optional chain_id?: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/nuls2_src.NULS2ImportConfig.html b/docs/types/nuls2_src.NULS2ImportConfig.html index 0be2cf5f..1057ab04 100644 --- a/docs/types/nuls2_src.NULS2ImportConfig.html +++ b/docs/types/nuls2_src.NULS2ImportConfig.html @@ -1 +1 @@ -NULS2ImportConfig | @aleph-sdk/monorepo

    Type alias NULS2ImportConfig

    NULS2ImportConfig: {
        chain_id?: number;
        prefix?: string;
    }

    Type declaration

    • Optional chain_id?: number
    • Optional prefix?: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +NULS2ImportConfig | @aleph-sdk/monorepo

    Type alias NULS2ImportConfig

    NULS2ImportConfig: {
        chain_id?: number;
        prefix?: string;
    }

    Type declaration

    • Optional chain_id?: number
    • Optional prefix?: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/core_src.DEFAULT_API_V2.html b/docs/variables/core_src.DEFAULT_API_V2.html index 89729277..6807bcd9 100644 --- a/docs/variables/core_src.DEFAULT_API_V2.html +++ b/docs/variables/core_src.DEFAULT_API_V2.html @@ -1 +1 @@ -DEFAULT_API_V2 | @aleph-sdk/monorepo

    Variable DEFAULT_API_V2Const

    DEFAULT_API_V2: "https://api3.aleph.im/" = 'https://api3.aleph.im/'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DEFAULT_API_V2 | @aleph-sdk/monorepo

    Variable DEFAULT_API_V2Const

    DEFAULT_API_V2: "https://api3.aleph.im/" = 'https://api3.aleph.im/'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/core_src.DEFAULT_API_WS_V2.html b/docs/variables/core_src.DEFAULT_API_WS_V2.html index 6b967280..68084ec4 100644 --- a/docs/variables/core_src.DEFAULT_API_WS_V2.html +++ b/docs/variables/core_src.DEFAULT_API_WS_V2.html @@ -1 +1 @@ -DEFAULT_API_WS_V2 | @aleph-sdk/monorepo

    Variable DEFAULT_API_WS_V2Const

    DEFAULT_API_WS_V2: "wss://api3.aleph.im/" = 'wss://api3.aleph.im/'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DEFAULT_API_WS_V2 | @aleph-sdk/monorepo

    Variable DEFAULT_API_WS_V2Const

    DEFAULT_API_WS_V2: "wss://api3.aleph.im/" = 'wss://api3.aleph.im/'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/dns_src.DNS_INSTANCE_DOMAIN.html b/docs/variables/dns_src.DNS_INSTANCE_DOMAIN.html index b77a9de6..57d55e51 100644 --- a/docs/variables/dns_src.DNS_INSTANCE_DOMAIN.html +++ b/docs/variables/dns_src.DNS_INSTANCE_DOMAIN.html @@ -1 +1 @@ -DNS_INSTANCE_DOMAIN | @aleph-sdk/monorepo

    Variable DNS_INSTANCE_DOMAINConst

    DNS_INSTANCE_DOMAIN: "instance.public.aleph.sh" = 'instance.public.aleph.sh'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DNS_INSTANCE_DOMAIN | @aleph-sdk/monorepo

    Variable DNS_INSTANCE_DOMAINConst

    DNS_INSTANCE_DOMAIN: "instance.public.aleph.sh" = 'instance.public.aleph.sh'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/dns_src.DNS_IPFS_DOMAIN.html b/docs/variables/dns_src.DNS_IPFS_DOMAIN.html index 901f3ce4..380804d0 100644 --- a/docs/variables/dns_src.DNS_IPFS_DOMAIN.html +++ b/docs/variables/dns_src.DNS_IPFS_DOMAIN.html @@ -1 +1 @@ -DNS_IPFS_DOMAIN | @aleph-sdk/monorepo

    Variable DNS_IPFS_DOMAINConst

    DNS_IPFS_DOMAIN: "ipfs.public.aleph.sh" = 'ipfs.public.aleph.sh'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DNS_IPFS_DOMAIN | @aleph-sdk/monorepo

    Variable DNS_IPFS_DOMAINConst

    DNS_IPFS_DOMAIN: "ipfs.public.aleph.sh" = 'ipfs.public.aleph.sh'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/dns_src.DNS_PROGRAM_DOMAIN.html b/docs/variables/dns_src.DNS_PROGRAM_DOMAIN.html index b4bf387c..9d558aac 100644 --- a/docs/variables/dns_src.DNS_PROGRAM_DOMAIN.html +++ b/docs/variables/dns_src.DNS_PROGRAM_DOMAIN.html @@ -1 +1 @@ -DNS_PROGRAM_DOMAIN | @aleph-sdk/monorepo

    Variable DNS_PROGRAM_DOMAINConst

    DNS_PROGRAM_DOMAIN: "program.public.aleph.sh" = 'program.public.aleph.sh'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DNS_PROGRAM_DOMAIN | @aleph-sdk/monorepo

    Variable DNS_PROGRAM_DOMAINConst

    DNS_PROGRAM_DOMAIN: "program.public.aleph.sh" = 'program.public.aleph.sh'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/dns_src.DNS_RESOLVERS.html b/docs/variables/dns_src.DNS_RESOLVERS.html index 6c917ead..98b8ef51 100644 --- a/docs/variables/dns_src.DNS_RESOLVERS.html +++ b/docs/variables/dns_src.DNS_RESOLVERS.html @@ -1 +1 @@ -DNS_RESOLVERS | @aleph-sdk/monorepo

    Variable DNS_RESOLVERSConst

    DNS_RESOLVERS: string[] = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DNS_RESOLVERS | @aleph-sdk/monorepo

    Variable DNS_RESOLVERSConst

    DNS_RESOLVERS: string[] = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/dns_src.DNS_STATIC_DOMAIN.html b/docs/variables/dns_src.DNS_STATIC_DOMAIN.html index c6390928..96d1c559 100644 --- a/docs/variables/dns_src.DNS_STATIC_DOMAIN.html +++ b/docs/variables/dns_src.DNS_STATIC_DOMAIN.html @@ -1 +1 @@ -DNS_STATIC_DOMAIN | @aleph-sdk/monorepo

    Variable DNS_STATIC_DOMAINConst

    DNS_STATIC_DOMAIN: "static.public.aleph.sh" = 'static.public.aleph.sh'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +DNS_STATIC_DOMAIN | @aleph-sdk/monorepo

    Variable DNS_STATIC_DOMAINConst

    DNS_STATIC_DOMAIN: "static.public.aleph.sh" = 'static.public.aleph.sh'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/evm_src.ChainData.html b/docs/variables/evm_src.ChainData.html index 1628b7a8..b1bfda3a 100644 --- a/docs/variables/evm_src.ChainData.html +++ b/docs/variables/evm_src.ChainData.html @@ -1 +1 @@ -ChainData | @aleph-sdk/monorepo

    Variable ChainDataConst

    ChainData: {
        [key: number]: RpcType;
    } = ...

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ChainData | @aleph-sdk/monorepo

    Variable ChainDataConst

    ChainData: {
        [key: number]: RpcType;
    } = ...

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/evm_src.ChainMetadata.html b/docs/variables/evm_src.ChainMetadata.html index 5fa51a6f..bc1cefdb 100644 --- a/docs/variables/evm_src.ChainMetadata.html +++ b/docs/variables/evm_src.ChainMetadata.html @@ -1 +1 @@ -ChainMetadata | @aleph-sdk/monorepo

    Variable ChainMetadataConst

    ChainMetadata: {
        [key: number]: ChainMetadataType;
    } = ...

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ChainMetadata | @aleph-sdk/monorepo

    Variable ChainMetadataConst

    ChainMetadata: {
        [key: number]: ChainMetadataType;
    } = ...

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/evm_src.erc20Abi.html b/docs/variables/evm_src.erc20Abi.html index 13fa39cd..320d3f24 100644 --- a/docs/variables/evm_src.erc20Abi.html +++ b/docs/variables/evm_src.erc20Abi.html @@ -1 +1 @@ -erc20Abi | @aleph-sdk/monorepo

    Variable erc20AbiConst

    erc20Abi: {
        constant: boolean;
        inputs: {
            name: string;
            type: string;
        }[];
        name: string;
        outputs: {
            name: string;
            type: string;
        }[];
        payable: boolean;
        stateMutability: string;
        type: string;
    }[] = ...

    Type declaration

    • constant: boolean
    • inputs: {
          name: string;
          type: string;
      }[]
    • name: string
    • outputs: {
          name: string;
          type: string;
      }[]
    • payable: boolean
    • stateMutability: string
    • type: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +erc20Abi | @aleph-sdk/monorepo

    Variable erc20AbiConst

    erc20Abi: {
        constant: boolean;
        inputs: {
            name: string;
            type: string;
        }[];
        name: string;
        outputs: {
            name: string;
            type: string;
        }[];
        payable: boolean;
        stateMutability: string;
        type: string;
    }[] = ...

    Type declaration

    • constant: boolean
    • inputs: {
          name: string;
          type: string;
      }[]
    • name: string
    • outputs: {
          name: string;
          type: string;
      }[]
    • payable: boolean
    • stateMutability: string
    • type: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/message_src.MAXIMUM_DISK_SIZE.html b/docs/variables/message_src.MAXIMUM_DISK_SIZE.html index 47b1b1a0..8e20250b 100644 --- a/docs/variables/message_src.MAXIMUM_DISK_SIZE.html +++ b/docs/variables/message_src.MAXIMUM_DISK_SIZE.html @@ -1 +1 @@ -MAXIMUM_DISK_SIZE | @aleph-sdk/monorepo

    Variable MAXIMUM_DISK_SIZEConst

    MAXIMUM_DISK_SIZE: number = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +MAXIMUM_DISK_SIZE | @aleph-sdk/monorepo

    Variable MAXIMUM_DISK_SIZEConst

    MAXIMUM_DISK_SIZE: number = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/message_src.defaultExecutionEnvironment.html b/docs/variables/message_src.defaultExecutionEnvironment.html index 06fad0af..58e47ab6 100644 --- a/docs/variables/message_src.defaultExecutionEnvironment.html +++ b/docs/variables/message_src.defaultExecutionEnvironment.html @@ -1 +1 @@ -defaultExecutionEnvironment | @aleph-sdk/monorepo

    Variable defaultExecutionEnvironmentConst

    defaultExecutionEnvironment: FunctionEnvironment = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +defaultExecutionEnvironment | @aleph-sdk/monorepo

    Variable defaultExecutionEnvironmentConst

    defaultExecutionEnvironment: FunctionEnvironment = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/message_src.defaultInstanceExecutionEnvironment.html b/docs/variables/message_src.defaultInstanceExecutionEnvironment.html index ddc722ab..3c901337 100644 --- a/docs/variables/message_src.defaultInstanceExecutionEnvironment.html +++ b/docs/variables/message_src.defaultInstanceExecutionEnvironment.html @@ -1 +1 @@ -defaultInstanceExecutionEnvironment | @aleph-sdk/monorepo

    Variable defaultInstanceExecutionEnvironmentConst

    defaultInstanceExecutionEnvironment: InstanceEnvironment = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +defaultInstanceExecutionEnvironment | @aleph-sdk/monorepo

    Variable defaultInstanceExecutionEnvironmentConst

    defaultInstanceExecutionEnvironment: InstanceEnvironment = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/message_src.defaultResources.html b/docs/variables/message_src.defaultResources.html index 41729b8b..9bfc793c 100644 --- a/docs/variables/message_src.defaultResources.html +++ b/docs/variables/message_src.defaultResources.html @@ -1 +1 @@ -defaultResources | @aleph-sdk/monorepo

    Variable defaultResourcesConst

    defaultResources: MachineResources = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +defaultResources | @aleph-sdk/monorepo

    Variable defaultResourcesConst

    defaultResources: MachineResources = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/tezos_src.STANDARD_DAPP_URL.html b/docs/variables/tezos_src.STANDARD_DAPP_URL.html index b0a12001..ed5c483e 100644 --- a/docs/variables/tezos_src.STANDARD_DAPP_URL.html +++ b/docs/variables/tezos_src.STANDARD_DAPP_URL.html @@ -1 +1 @@ -STANDARD_DAPP_URL | @aleph-sdk/monorepo

    Variable STANDARD_DAPP_URLConst

    STANDARD_DAPP_URL: "https://aleph.im" = 'https://aleph.im'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +STANDARD_DAPP_URL | @aleph-sdk/monorepo

    Variable STANDARD_DAPP_URLConst

    STANDARD_DAPP_URL: "https://aleph.im" = 'https://aleph.im'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file