> For the complete documentation index, see [llms.txt](https://doc-api.conet.network/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc-api.conet.network/readme/class-platform.md).

# Class Platform

#### Introduction

This class provides platform-level operations, and typically requires presenting system security credentials when invoked. These security credentials are issued to the UI after the client account is unlocked with a passcode. The UI needs to retain these security credentials throughout its entire lifecycle, and they must be presented when invoking this class.

**Class platform**

<pre class="language-typescript"><code class="lang-typescript"><strong>import { platform， type_platformStatus } from 'API/platfrom'
</strong>
const [platformStatus, setPlatformStatus] = useState&#x3C;type_platformStatus>('')
const [workerLoading, setWorkerLoading] = useState（0)

const conetPlatform = new platform(setPlatformStatus, setWorkerLoading)
</code></pre>

**Type profile**

```typescript
interface pgpKey {
	privateKeyArmor: string
	publicKeyArmor: string
}
interface token {
	balance: string
	name: string
	symbol: string
	erc20Address: string
	history: tokenHistory[]
}
interface profile {
	isPrimary: boolean			//	true: current profile
	referrer?: referrer			//	referrer only in the first profile. 
	keyID: string 				//	Wallet Address
	pgpKey: pgpKey				//
	privateKeyArmor: string			//	Wallet private key
	tokens: token[]
	isNode?: boolean
					
	data?: any				//	UI custom data, like nickname
	
}
```

### React Hooks

**listeningVersionHook (**&#x70;rofileVerHook: React.Dispatch\<React.SetStateAction\<number>>**)**

Number will be changed when profile was updated.

**listeningAssetsHook (**&#x70;rofileVerHook: React.Dispatch\<React.SetStateAction\<number>>**)**

Number will be changed when assets balance was updated.

**listeningMiningHook(**&#x6D;iningHook: React.Dispatch\<React.SetStateAction\<mining>>**)**

```typescript
interface mining {
    blockNumber: number
    CCNTP_total_balance: string
    Updated_balace: string                //    CCNTP_total_balance - Last_balance
    status: 'mining'|'stoped'
    profile: profile
}
```

**listeningGuardianPurchaseHook (**&#x70;rofileVerHook: React.Dispatch\<React.SetStateAction\<number>>**)**

Number will be changed when status changed.

* 1 => Transferring asset to CONET Guardian.
* 2 => Waiting for transfer to be confirmed.
* 3 => Waiting for purchase to be confirmed by CONET.
* 4 => Purchase completed.&#x20;
* -1 => Token transfer failed.
* -2, TX => Purchase declined by CONET (please connect CONET team with this TX)

### Class Platform

**new platform(platformStatus, workerLoading)**

* setPlatformStatus: [React.Dispatch](https://react-redux.js.org/api/hooks)\<React.SetStateAction\<type\_platformStatus>>
* type\_platformStatus: 'LOCKED'|'UNLOCKED'|'NONE'
* setWorkerLoading: React.Dispatch\<React.SetStateAction\<number>>: from0\~100
* Returns:  Instance of [class](https://www.typescriptlang.org/docs/handbook/2/classes.html) platform.

Creates a new instance of platform. Monitor the percentage of backend processes being loaded by **setWorkerLoading**, Show client status when loading is complete by **setPlatformStatus.**

### Security credentials required functions

**platform.createAccount(passcode)**

* **Returns:** Promise<[string](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html)>
* **Return resolve**: 12 words Secret Recovery Phrase (SRP) split by space, zero length string (create account was fail)
* **Return reject**: Never.
* **passcode** <[string](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html)> (length > 5)

This function only available when **platformStatus** is "NONE"

**platform.testPasscode(passcode, profileVerHook)**

* **Returns:** Promise<\[passcodeStatus: boolean, authorizationKey: string]>
* **Return resolve**:  Unlock wallet success when passcodeStatus is true, return **authorizationKey**. Unlock wallet fail when passcodeStatus was false.
* **Return reject**: Never.
* **passcode** <[string](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html)> (length > 5)
* **profileVerHook: React.Dispatch\<React.SetStateAction\<number>>** The number of remote new version updates **c**ompare the current local version.

**platformStatus** will be update to **UNLOCKED** when passcode success.

Class platform will get authorization key from backend which can access user private data after passcode is success.&#x20;

**platform.resetPasscode(oldPasscode, newPasscode)**

* **Returns:** Promise<\[passcodeStatus: boolean, authorizationKey: string]>
* **Return resolve**:  Unlock wallet success when reset passcode was down, return **authorizationKey**. Unlock wallet fail when passcodeStatus was false.
* **Return reject**: Never.
* **oldPasscode** <[string](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html)> (length > 5)
* **newPasscode** <[string](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html)> (length > 5)

**platform.recoverAccount(SRP, passcode)**

* **Returns:** Promise\<authorizationKey: string>
* **Return resolve**:  Return **authorizationKey** when recover Account from SRP, or null when recover fail.&#x20;
* **Return reject**: Never.
* **SRP** <[string](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html)>  12 words Secret Recovery Phrase (SRP) split by space.
* **passcode** <[string](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html)> (length > 5) The new passcode for securus account.

**platform.showSRP(passcode)**

* **passcode**<[string](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html)> (length > 5)
* **Returns:** Promise<[string](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html)>
* **Return resolve**: 12 words Secret Recovery Phrase (SRP) split by space or zero length string (unavailable)
* **return reject**: Never.
* **Require:** Class platform has complete authorization.

**platform.getAllProfiles(**&#x61;uthorizationKe&#x79;**)**

* **authorizationKey**<[string](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html)>  The access authorization which return from success testPasscode.
* **Returns:** Promise\<profile\[]>
* **Return resolve**: All profiles or null array (unavailable)
* **return reject**: Never.
* **Require:** Class platform has complete authorization.

**platform.importWallet(**&#x61;uthorizationKey, privateKey, dat&#x61;**)**

* **authorizationKey**<[string](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html)>  The access authorization which return from success testPasscode.
* **privateKey**<[string](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html)>  The private key.
* **data** \<any> UI custom data. example want put a "import" TAG.
* **Returns:** Promise\<profile\[]>
* **Return resolve**: All profiles or null array (when private key or authorizationKey is illegal.)
* **Return reject**: Never.
* **Require:** Class platform has complete authorization.

**platform.updateProfile(**&#x61;uthorizationKey, profil&#x65;**)**

* **authorizationKey**<[string](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html)>  The access authorization which return from success testPasscode.
* profile\<profile> Include UI custom data.
* **Returns:** Promise\<profile\[]>
* **Return resolve**: All profiles or null array (when profile or authorizationKey is illegal.)
* **Return reject**: Never.
* **Require:** Class platform has complete authorization.

**platform.addProfile(**&#x61;uthorizationKey, dat&#x61;**)**

* **authorizationKey**<[string](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html)>  The access authorization which return from success testPasscode.
* **data** \<any> UI custom data. example want put a "import" TAG.
* **Returns:** Promise\<profile\[]>
* **Return resolve**: All profiles or null array (when authorizationKey is illegal.)
* **Return reject**: Never.
* **Require:** Class platform has complete authorization.

**platform.startMining(**&#x61;uthorizationKey, profile: profil&#x65;**)**

<pre class="language-typescript"><code class="lang-typescript"><strong>type status = 'success'|
</strong><strong>    'Err_Server_Unreachable'|'Err_Multiple_IP'|'Err_Existed'|'Err_Unknow'
</strong><strong>    'TIMEOUT'|'NOT_INTERNET'
</strong></code></pre>

* **Returns:** Promise\<status: number>

**platform.stopMining()**

* **Returns:** Promise\<profile\[]>
* **Return resolve**: null
* **Return reject**: Never.

### No security credentials required functions

**platform.CONETFaucet**(walletPublicAddress)

* **Returns**: Promise\<boolean> True: success, False: fail. (each 24 hours can request once only.)

**platform.prePurchase(nodes: number, amount: number, purchaseProfile: profile, payAssetName: string)**

* **Returns:** Promise<\[gasPrice: string, estimateFee string, nodeAvailable: boolean, availableNodes: number]>
* **All is null**: Insufficient wallet assets cannot complete transfer.
* **gasPrice:** Number of [GWAI unit](https://www.investopedia.com/terms/g/gwei-ethereum.asp)
* **estimateFee:** Number of ETH unit
* **nodeAvailable:** True = Purchase can be finish , False = no available nodes can be purchase.
* **availableNodes:** The balance of available nodes which can be purchase.
* Error: Network unavailable.

**platform.claimToken(profile: profile, assetName: string)**

* **Returns:** Promise<\[boolean]>
* **All is null**: Insufficient wallet assets cannot complete transfer.
* Error: no balance.

**platform.guardianPurchase(nodes: number, amount: number, purchaseProfile: profile, payAssetName: string)**

* **Returns:** Promise<\[]>
* **All is null**: Insufficient wallet assets cannot complete transfer.
* Error: Network unavailable.
* process status please see the HOOK : **listeningGuardianPurchaseHook**

**platform.getTransferGas(amount: string, profile: profile, payAssetName: string)**

**Returns:** Promise<\[fixed Amount, gasPrice: string, estimateFee string]> null return for sufficient assets.

Error: Network unavailable.

**platform.transferAsset(amount: string, profile: profile, payAssetName: string)**

**Returns:** Promise<\[boolean]>true for transfer success.

Error: Network unavailable.

**platform.getRefereesList(**&#x77;allet\_public\_ke&#x79;**)**

* **Returns:** Promise\<refereesTree\[]>

```typescript
//    refereesTree result examples 0x04441E4BC3A8842473Fe974DB4351f0b126940be
refereesTree: {
    '0x4fa1FC4a2a96D77E8521628268631F735E2CcBee':[
        {
            '0xDBaa41dd7CABE1D5Ca41d38E8F768f94D531d85A': 
                ['0xc9043f661ADddCAF902d45D220e7aea38920d188'] 
        }
    ]
}
```

* wallet\_public\_key <[string](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html)> profile.keyID

Return referees tree array.

**platform.getAssetsPrice()**

* **Returns:** Promise\<price\[]>

```typescript
Price = {
    BNB: {USD: number},
    ETH: {USD: number},
    USDT: {USD: number}
}
```

* **Return reject**: Never.

**platform.fx168PrePurchase(nodes: number)**

* **Returns:** Promise\<orders: fx168Order\[]> The hash will return when success.
* Error: INVALID\_DATA. When nodes <1

```typescript
interface fx168Order {
    id: string
    status: string
    nodes: string
}
```

**platform.deleteAccount()**

* **Returns**: Promise\<boolean>
* **Return resolve**: **true**: success. **false**: fail
* **Return reject**: Never.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://doc-api.conet.network/readme/class-platform.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.