Skip to content
This repository has been archived by the owner on Feb 21, 2024. It is now read-only.

Commit

Permalink
[build-php] Debugging enabled in examples
Browse files Browse the repository at this point in the history
  • Loading branch information
mark-jivko committed Jan 28, 2023
1 parent df313fe commit 1ee6a62
Show file tree
Hide file tree
Showing 877 changed files with 7,712 additions and 3,667 deletions.
190 changes: 114 additions & 76 deletions docs/Api/AccountApi.md

Large diffs are not rendered by default.

110 changes: 66 additions & 44 deletions docs/Api/AlgorandApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,12 @@ Method | Description

## `algorandBroadcast()`

### Example

[👉 View "**algorandBroadcast.php**" ✨](https://github.com/tatumio/tatum-php/blob/master/examples/Api/AlgorandApi/algorandBroadcast.php)

### Request

> **POST** `/v3/algorand/broadcast`
### Type signature
Expand Down Expand Up @@ -66,16 +72,18 @@ Broadcast signed Algorand transaction

Broadcast signed transaction to Algorand blockchain. This method is used internally from Tatum KMS or Tatum client libraries. It is possible to create custom signing mechanism and use this method only for broadcasting data to the blockchain.

### Example

[✨ View "algorandBroadcast.php"](https://github.com/tatumio/tatum-php/blob/master/examples/Api/AlgorandApi/algorandBroadcast.php)

[Back to top](#top)



## `algorandGenerateAddress()`

### Example

[👉 View "**algorandGenerateAddress.php**" ✨](https://github.com/tatumio/tatum-php/blob/master/examples/Api/AlgorandApi/algorandGenerateAddress.php)

### Request

> **GET** `/v3/algorand/address/{priv}`
### Type signature
Expand Down Expand Up @@ -104,16 +112,18 @@ Generate Algorand account address from private key

Generate Algorand account deposit address from private key.

### Example

[✨ View "algorandGenerateAddress.php"](https://github.com/tatumio/tatum-php/blob/master/examples/Api/AlgorandApi/algorandGenerateAddress.php)

[Back to top](#top)



## `algorandGenerateWallet()`

### Example

[👉 View "**algorandGenerateWallet.php**" ✨](https://github.com/tatumio/tatum-php/blob/master/examples/Api/AlgorandApi/algorandGenerateWallet.php)

### Request

> **GET** `/v3/algorand/wallet`
### Type signature
Expand Down Expand Up @@ -142,16 +152,18 @@ Generate Algorand wallet

Tatum supports Algorand wallets.

### Example

[✨ View "algorandGenerateWallet.php"](https://github.com/tatumio/tatum-php/blob/master/examples/Api/AlgorandApi/algorandGenerateWallet.php)

[Back to top](#top)



## `algorandGetBalance()`

### Example

[👉 View "**algorandGetBalance.php**" ✨](https://github.com/tatumio/tatum-php/blob/master/examples/Api/AlgorandApi/algorandGetBalance.php)

### Request

> **GET** `/v3/algorand/account/balance/{address}`
### Type signature
Expand Down Expand Up @@ -180,16 +192,18 @@ Get Algorand Account balance

Get Algorand account balance in ALGO.

### Example

[✨ View "algorandGetBalance.php"](https://github.com/tatumio/tatum-php/blob/master/examples/Api/AlgorandApi/algorandGetBalance.php)

[Back to top](#top)



## `algorandGetBlock()`

### Example

[👉 View "**algorandGetBlock.php**" ✨](https://github.com/tatumio/tatum-php/blob/master/examples/Api/AlgorandApi/algorandGetBlock.php)

### Request

> **GET** `/v3/algorand/block/{roundNumber}`
### Type signature
Expand Down Expand Up @@ -218,16 +232,18 @@ Get Algorand block by block round number

Get Algorand block by block round number.

### Example

[✨ View "algorandGetBlock.php"](https://github.com/tatumio/tatum-php/blob/master/examples/Api/AlgorandApi/algorandGetBlock.php)

[Back to top](#top)



## `algorandGetCurrentBlock()`

### Example

[👉 View "**algorandGetCurrentBlock.php**" ✨](https://github.com/tatumio/tatum-php/blob/master/examples/Api/AlgorandApi/algorandGetCurrentBlock.php)

### Request

> **GET** `/v3/algorand/block/current`
### Type signature
Expand All @@ -252,16 +268,18 @@ Get current block number

Get Algorand current block number. This is the number of the latest block in the blockchain.

### Example

[✨ View "algorandGetCurrentBlock.php"](https://github.com/tatumio/tatum-php/blob/master/examples/Api/AlgorandApi/algorandGetCurrentBlock.php)

[Back to top](#top)



## `algorandGetTransaction()`

### Example

[👉 View "**algorandGetTransaction.php**" ✨](https://github.com/tatumio/tatum-php/blob/master/examples/Api/AlgorandApi/algorandGetTransaction.php)

### Request

> **GET** `/v3/algorand/transaction/{txid}`
### Type signature
Expand Down Expand Up @@ -290,16 +308,18 @@ Get Algorand Transaction

Get Algorand transaction by transaction id.

### Example

[✨ View "algorandGetTransaction.php"](https://github.com/tatumio/tatum-php/blob/master/examples/Api/AlgorandApi/algorandGetTransaction.php)

[Back to top](#top)



## `receiveAlgorandAsset()`

### Example

[👉 View "**receiveAlgorandAsset.php**" ✨](https://github.com/tatumio/tatum-php/blob/master/examples/Api/AlgorandApi/receiveAlgorandAsset.php)

### Request

> **POST** `/v3/algorand/asset/receive`
### Type signature
Expand Down Expand Up @@ -330,16 +350,18 @@ Enable receiving asset on account

This operation needs the private key of the blockchain address. No one should ever send it's own private keys to the internet because there is a strong possibility of stealing keys and loss of funds. In this method, it is possible to enter privateKey or signatureId. PrivateKey should be used only for quick development on testnet versions of blockchain when there is no risk of losing funds. In production, <a href="https://github.com/tatumio/tatum-kms" target="_blank">Tatum KMS</a> should be used for the highest security standards, and signatureId should be present in the request. Alternatively, using the Tatum client library for supported languages.

### Example

[✨ View "receiveAlgorandAsset.php"](https://github.com/tatumio/tatum-php/blob/master/examples/Api/AlgorandApi/receiveAlgorandAsset.php)

[Back to top](#top)



## `receiveAlgorandAssetKMS()`

### Example

[👉 View "**receiveAlgorandAssetKMS.php**" ✨](https://github.com/tatumio/tatum-php/blob/master/examples/Api/AlgorandApi/receiveAlgorandAssetKMS.php)

### Request

> **POST** `/v3/algorand/asset/receive`
### Type signature
Expand All @@ -366,16 +388,18 @@ Enable receiving asset on account

ReceiveAlgorandAssetKMS operation

### Example

[✨ View "receiveAlgorandAssetKMS.php"](https://github.com/tatumio/tatum-php/blob/master/examples/Api/AlgorandApi/receiveAlgorandAssetKMS.php)

[Back to top](#top)



## `transferAlgorandBlockchain()`

### Example

[👉 View "**transferAlgorandBlockchain.php**" ✨](https://github.com/tatumio/tatum-php/blob/master/examples/Api/AlgorandApi/transferAlgorandBlockchain.php)

### Request

> **POST** `/v3/algorand/transaction`
### Type signature
Expand Down Expand Up @@ -412,16 +436,18 @@ Send Algos to an Algorand account

For signing transactions on the **mainnet**, we strongly recommend that you use the Tatum <a href="https://github.com/tatumio/tatum-kms" target="_blank">Key Management System (KMS)</a> and provide the signature ID instead of the private key in the API. Alternatively, you can use the <a href="https://github.com/tatumio/tatum-js" target="_blank">Tatum JavaScript client</a>.

### Example

[✨ View "transferAlgorandBlockchain.php"](https://github.com/tatumio/tatum-php/blob/master/examples/Api/AlgorandApi/transferAlgorandBlockchain.php)

[Back to top](#top)



## `transferAlgorandBlockchainKMS()`

### Example

[👉 View "**transferAlgorandBlockchainKMS.php**" ✨](https://github.com/tatumio/tatum-php/blob/master/examples/Api/AlgorandApi/transferAlgorandBlockchainKMS.php)

### Request

> **POST** `/v3/algorand/transaction`
### Type signature
Expand All @@ -448,9 +474,5 @@ Send Algos to an Algorand account

TransferAlgorandBlockchainKMS operation

### Example

[✨ View "transferAlgorandBlockchainKMS.php"](https://github.com/tatumio/tatum-php/blob/master/examples/Api/AlgorandApi/transferAlgorandBlockchainKMS.php)

[Back to top](#top)

Loading

0 comments on commit 1ee6a62

Please sign in to comment.