From 0ce0578a1fb9fb771dede63978e96891b2250053 Mon Sep 17 00:00:00 2001 From: damienen <44813558+damienen@users.noreply.github.com> Date: Tue, 30 Apr 2024 20:23:50 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20Itheum/s?= =?UTF-8?q?dk-mx-enterprise@b56e4a892f95369e0e3e90c51ecaca4af2802f10=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/Factory.html | 56 +++++++++++++-------------- enums/EnvironmentsEnum.html | 4 +- interfaces/Config.html | 4 +- interfaces/DeployedContract.html | 4 +- variables/apiConfiguration.html | 2 +- variables/factoryContractAddress.html | 2 +- variables/itheumTokenIdentifier.html | 2 +- variables/networkConfiguration.html | 2 +- 8 files changed, 38 insertions(+), 38 deletions(-) diff --git a/classes/Factory.html b/classes/Factory.html index d38d353..91bacbf 100644 --- a/classes/Factory.html +++ b/classes/Factory.html @@ -1,4 +1,4 @@ -Factory | @itheum/sdk-mx-enterprise

Class Factory

Constructors

constructor +Factory | @itheum/sdk-mx-enterprise

Class Factory

Constructors

constructor

Properties

chainID contract env @@ -32,51 +32,51 @@

Constructors

constructor

  • new Factory(env, timeout?): Factory

  • Creates a new instance of the Factory class, which can be used to interact with the factory smart contract

    Parameters

    • env: string

      'devnet' | 'devnet2' | 'mainnet' | 'testnet' based on EnvironmentsEnum

    • timeout: number = 10000

      Timeout for the network provider (DEFAULT = 10000ms)

      -

    Returns Factory

Properties

Readonly chainID

chainID: string

Readonly contract

contract: SmartContract

Readonly env

env: string

Readonly networkProvider

networkProvider: ApiNetworkProvider

Methods

changeOwnership

  • changeOwnership(senderAddress, contractAddress): Transaction

  • Returns a transaction to change the ownership of the minter contract to the deployer of minter contract

    +

Returns Factory

Properties

Readonly chainID

chainID: string

Readonly contract

contract: SmartContract

Readonly env

env: string

Readonly networkProvider

networkProvider: ApiNetworkProvider

Methods

changeOwnership

  • changeOwnership(senderAddress, contractAddress): Transaction

  • Returns a transaction to change the ownership of the minter contract to the deployer of minter contract

    Parameters

    • senderAddress: IAddress

      The address of the sender, must be the owner of the contract Note: It change the ownership of the minter contract to the deployer of minter contract

      -
    • contractAddress: IAddress

    Returns Transaction

deployContract

  • deployContract(senderAddress, version): Transaction

  • Parameters

    • senderAddress: IAddress

      The address of the deployer of the minter contract

      +
    • contractAddress: IAddress

    Returns Transaction

deployContract

  • deployContract(senderAddress, version): Transaction

  • Parameters

    • senderAddress: IAddress

      The address of the deployer of the minter contract

    • version: string

      The version of the minter contract code

      -

    Returns Transaction

disableWhitelist

  • disableWhitelist(senderAddress): Transaction

  • Parameters

    • senderAddress: IAddress

      The address of the sender, must be the owner of the contract

      -

    Returns Transaction

enableWhitelist

  • enableWhitelist(senderAddress): Transaction

  • Parameters

    • senderAddress: IAddress

      The address of the sender, must be the owner of the contract

      -

    Returns Transaction

getContractAddress

  • getContractAddress(): IAddress

  • Retrives the address of the factory smart contract

    -

    Returns IAddress

initializeContract

  • initializeContract(senderAddress, require_whitelist, treasuryAddress, tax, claimsContractAddress, claimsTokenIdentifier): Transaction

  • Parameters

    • senderAddress: IAddress

      The address of the sender, must be the owner of the factory contract

      +

    Returns Transaction

disableWhitelist

  • disableWhitelist(senderAddress): Transaction

  • Parameters

    • senderAddress: IAddress

      The address of the sender, must be the owner of the contract

      +

    Returns Transaction

enableWhitelist

  • enableWhitelist(senderAddress): Transaction

  • Parameters

    • senderAddress: IAddress

      The address of the sender, must be the owner of the contract

      +

    Returns Transaction

getContractAddress

  • getContractAddress(): IAddress

  • Retrives the address of the factory smart contract

    +

    Returns IAddress

initializeContract

  • initializeContract(senderAddress, require_whitelist, treasuryAddress, tax, claimsContractAddress, claimsTokenIdentifier): Transaction

  • Parameters

    • senderAddress: IAddress

      The address of the sender, must be the owner of the factory contract

    • require_whitelist: boolean

      A boolean value indicating if the factory will require whitelist

    • treasuryAddress: IAddress

      The address of the treasury where the tax will be sent

    • tax: number

      The tax percentage to set in the contract ( minter contract will send the tax cut to treasury address)

    • claimsContractAddress: IAddress

      The address of the claims contract

    • claimsTokenIdentifier: string

      The token identifier of the claims contract

      -

    Returns Transaction

pause

  • pause(senderAddress): Transaction

  • Pause contract transaction

    -

    Parameters

    • senderAddress: IAddress

    Returns Transaction

removeCode

  • removeCode(senderAddress, version): Transaction

  • Parameters

    • senderAddress: IAddress

      The address of the sender, must be the owner of the contract

      +

    Returns Transaction

pause

  • pause(senderAddress): Transaction

  • Pause contract transaction

    +

    Parameters

    • senderAddress: IAddress

    Returns Transaction

removeCode

  • removeCode(senderAddress, version): Transaction

  • Parameters

    • senderAddress: IAddress

      The address of the sender, must be the owner of the contract

    • version: string

      The version of the minter contract

      -

    Returns Transaction

removeWhitelist

  • removeWhitelist(senderAddress, address): Transaction

  • Parameters

    • senderAddress: IAddress

      The address of the sender, must be the owner of the contract

      +

    Returns Transaction

removeWhitelist

  • removeWhitelist(senderAddress, address): Transaction

  • Parameters

    • senderAddress: IAddress

      The address of the sender, must be the owner of the contract

    • address: IAddress

      The address to remove from whitelist

      -

    Returns Transaction

setTax

  • setTax(senderAddress, taxPercentage): Transaction

  • Parameters

    • senderAddress: IAddress

      The address of the sender, must be the owner of the contract

      +

    Returns Transaction

setTax

  • setTax(senderAddress, taxPercentage): Transaction

  • Parameters

    • senderAddress: IAddress

      The address of the sender, must be the owner of the contract

    • taxPercentage: number

      The tax percentage to set in the contract ( minter contract will send the tax cut to treasury address)

      -

    Returns Transaction

setTreasuryAddress

  • setTreasuryAddress(senderAddress, treasuryAddress): Transaction

  • Parameters

    • senderAddress: IAddress

      The address of the sender, must be the owner of the contract

      +

    Returns Transaction

setTreasuryAddress

  • setTreasuryAddress(senderAddress, treasuryAddress): Transaction

  • Parameters

    • senderAddress: IAddress

      The address of the sender, must be the owner of the contract

    • treasuryAddress: IAddress

      The address of the treasury

      -

    Returns Transaction

unpause

  • unpause(senderAddress): Transaction

  • Unpause contract transaction

    -

    Parameters

    • senderAddress: IAddress

    Returns Transaction

upgradeChildContract

  • upgradeChildContract(senderAddress, childContractAddress, upgradeVersion): Transaction

  • Parameters

    • senderAddress: IAddress

      The address of the sender, must be the owner of the factory or owner of the minter contract

      +

    Returns Transaction

unpause

  • unpause(senderAddress): Transaction

  • Unpause contract transaction

    +

    Parameters

    • senderAddress: IAddress

    Returns Transaction

upgradeChildContract

  • upgradeChildContract(senderAddress, childContractAddress, upgradeVersion): Transaction

  • Parameters

    • senderAddress: IAddress

      The address of the sender, must be the owner of the factory or owner of the minter contract

    • childContractAddress: IAddress

      The address of the child contract

    • upgradeVersion: string

      The version of the minter contract code to upgrade

      -

    Returns Transaction

uploadCode

  • uploadCode(senderAddress, code, version): Transaction

  • Parameters

    • senderAddress: IAddress

      The address of the sender, must be the owner of the contract

      +

    Returns Transaction

uploadCode

  • uploadCode(senderAddress, code, version): Transaction

  • Parameters

    • senderAddress: IAddress

      The address of the sender, must be the owner of the contract

    • code: string

      The code of the minter contract

    • version: string

      The version of the minter contract

      -

    Returns Transaction

viewAddressContracts

  • viewAddressContracts(address): Promise<DeployedContract[]>

  • Retrives all deployed contracts of address parameter

    +

Returns Transaction

viewAddressContracts

viewAddressIsWhitelisted

Returns Promise<DeployedContract[]>

viewAddressIsWhitelisted

viewClaimsContractAddress

viewClaimsTokenIdentifier

viewContractCode

Returns Promise<boolean>

viewClaimsContractAddress

viewClaimsTokenIdentifier

viewContractCode

viewContractPauseState

viewContracts

viewTaxPercentage

viewTreasuryAddress

viewVersions

viewWhitelistState

whitelist

viewContractPauseState

viewContracts

viewTaxPercentage

viewTreasuryAddress

viewVersions

viewWhitelistState

whitelist

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Transaction

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/EnvironmentsEnum.html b/enums/EnvironmentsEnum.html index a5e9cd3..94cd0d8 100644 --- a/enums/EnvironmentsEnum.html +++ b/enums/EnvironmentsEnum.html @@ -1,4 +1,4 @@ -EnvironmentsEnum | @itheum/sdk-mx-enterprise

Enumeration EnvironmentsEnum

Enumeration Members

devnet +EnvironmentsEnum | @itheum/sdk-mx-enterprise

Enumeration EnvironmentsEnum

Enumeration Members

devnet mainnet testnet -

Enumeration Members

devnet

devnet: "devnet"

mainnet

mainnet: "mainnet"

testnet

testnet: "testnet"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

devnet

devnet: "devnet"

mainnet

mainnet: "mainnet"

testnet

testnet: "testnet"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/Config.html b/interfaces/Config.html index afe0978..9a27bc1 100644 --- a/interfaces/Config.html +++ b/interfaces/Config.html @@ -1,3 +1,3 @@ -Config | @itheum/sdk-mx-enterprise

Interface Config

interface Config {
    chainID: string;
    networkProvider: string;
}

Properties

chainID +Config | @itheum/sdk-mx-enterprise

Interface Config

interface Config {
    chainID: string;
    networkProvider: string;
}

Properties

chainID networkProvider -

Properties

chainID

chainID: string

networkProvider

networkProvider: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

chainID

chainID: string

networkProvider

networkProvider: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/DeployedContract.html b/interfaces/DeployedContract.html index a2cf668..17cfbc4 100644 --- a/interfaces/DeployedContract.html +++ b/interfaces/DeployedContract.html @@ -1,4 +1,4 @@ -DeployedContract | @itheum/sdk-mx-enterprise

Interface DeployedContract

interface DeployedContract {
    address: string;
    owner: string;
    version: string;
}

Properties

address +DeployedContract | @itheum/sdk-mx-enterprise

Interface DeployedContract

interface DeployedContract {
    address: string;
    owner: string;
    version: string;
}

Properties

address owner version -

Properties

address

address: string

owner

owner: string

version

version: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

address

address: string

owner

owner: string

version

version: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/apiConfiguration.html b/variables/apiConfiguration.html index a74ca0d..b74a4c5 100644 --- a/variables/apiConfiguration.html +++ b/variables/apiConfiguration.html @@ -1 +1 @@ -apiConfiguration | @itheum/sdk-mx-enterprise

Variable apiConfigurationConst

apiConfiguration: {
    [key in EnvironmentsEnum]: string
} = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +apiConfiguration | @itheum/sdk-mx-enterprise

Variable apiConfigurationConst

apiConfiguration: {
    [key in EnvironmentsEnum]: string
} = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/factoryContractAddress.html b/variables/factoryContractAddress.html index 8d10f6e..9f8e37f 100644 --- a/variables/factoryContractAddress.html +++ b/variables/factoryContractAddress.html @@ -1 +1 @@ -factoryContractAddress | @itheum/sdk-mx-enterprise

Variable factoryContractAddressConst

factoryContractAddress: {
    [key in EnvironmentsEnum]: string
} = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +factoryContractAddress | @itheum/sdk-mx-enterprise

Variable factoryContractAddressConst

factoryContractAddress: {
    [key in EnvironmentsEnum]: string
} = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/itheumTokenIdentifier.html b/variables/itheumTokenIdentifier.html index 49b3562..7c9985d 100644 --- a/variables/itheumTokenIdentifier.html +++ b/variables/itheumTokenIdentifier.html @@ -1 +1 @@ -itheumTokenIdentifier | @itheum/sdk-mx-enterprise

Variable itheumTokenIdentifierConst

itheumTokenIdentifier: {
    [key in EnvironmentsEnum]: string
} = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +itheumTokenIdentifier | @itheum/sdk-mx-enterprise

Variable itheumTokenIdentifierConst

itheumTokenIdentifier: {
    [key in EnvironmentsEnum]: string
} = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/networkConfiguration.html b/variables/networkConfiguration.html index b75c362..ec0c5a9 100644 --- a/variables/networkConfiguration.html +++ b/variables/networkConfiguration.html @@ -1 +1 @@ -networkConfiguration | @itheum/sdk-mx-enterprise

Variable networkConfigurationConst

networkConfiguration: {
    [key in EnvironmentsEnum]: Config
} = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +networkConfiguration | @itheum/sdk-mx-enterprise

Variable networkConfigurationConst

networkConfiguration: {
    [key in EnvironmentsEnum]: Config
} = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file