Fix docs

blockcoders · Jul 7, 2022 · 447ec6a · 447ec6a
1 parent d745b0c
commit 447ec6a
Show file tree

Hide file tree

Showing 3 changed files with 249 additions and 35 deletions.
diff --git a/README.md b/README.md
@@ -7,8 +7,6 @@
 
 Harmony Marketplace SDK provides a collection of interfaces to interact with HRC721, HRC1155 and any Smart Contracts that extends those standards. This library was based on [@harmony-js](https://github.com/harmony-one/sdk)
 
-Currently under developement 🤓
-
 ## Install
 
 ```sh
@@ -157,54 +155,229 @@ const key = new HDKey(new HttpProvider(HarmonyShards.SHARD_0), options)
 
 The `BaseToken` is an extension over a regular [Contract](https://github.com/harmony-one/sdk/tree/master/packages/harmony-contract) which is the Harmony recomendation for interact with smart contracts. This abstract class contains the core functionality for interact with Harmony Smart Contracts.
 
-### Common Methods
+## HRC20 API
+
+The `HRC20` implements the abstract class [Base Token](#base-token).
+
+**NOTE**: The harmony [explorer](https://explorer.harmony.one/hrc20) will look for a specific list of functions and events to identify HRC20 tokens. You can validate if the bytecode of your HRC20 is valid [here](https://explorer.harmony.one/tools/checkHrc).
+
+Expected Methods:
+| Method | Description |
+| ------------- | ------------- |
+| totalSupply | Total amount of tokens stored by the contract. |
+| decimals | Returns the decimals places of the token. |
+| transfer | Moves amount tokens from the caller’s account to to. |
+| balanceOf | Returns the amount of tokens owned by account. |
+| symbol | Returns the symbol of the token. |
+| name | Returns the name of the token. |
+| approve | Sets amount as the allowance of spender over the caller’s tokens. |
+
+Expected Events
+| Event | Description |
+| ------------- | ------------- |
+| Transfer | Emitted when a token id is transferred from an address to another. |
+| Approval | Emitted when owner enables approved to manage the tokenId token. |
+
+You can find an example of [HRC20](./src/tests/contracts/BlockcodersHRC20.sol) in this address [0x...0a0a](https://explorer.ps.hmny.io/address/0x35305d505a884ccfaba7b7d5f533ef29ad57254b?activeTab=7).
+
+### Initializing
+
+```typescript
+import { HttpProvider } from '@harmony-js/network'
+import { PrivateKey, HarmonyShards, HRC20 } from 'harmony-marketplace-sdk'
+import * as ABI from './abi.json'
+
+const wallet = new PrivateKey(
+  new HttpProvider(HarmonyShards.SHARD_0),
+  '45e497bd45a9049bcb649016594489ac67b9f052a6cdf5cb74ee2427a60bf25e'
+)
+
+// A contract instance
+const contract = new HRC20('0x...00', ABI, wallet)
+
+// A contract instance with options
+const contract = new HRC20('0x...00', ABI, wallet, {
+  data: '0x',
+  shardID: 0,
+  address: '0x...00',
+  defaultAccount: wallet.getAccount('0x...00'),
+  defaultBlock: 'lastest',
+  defaultGas: '21000',
+  defaultGasPrice: '1',
+  transactionBlockTimeout: 2000,
+  transactionConfirmationBlocks: '10',
+  transactionPollingTimeout: 200,
+})
+```
+
+### Methods
+
+#### balanceOf
+
+Returns the number of tokens in owner's account.
+
+```ts
+import { HttpProvider } from '@harmony-js/network'
+import { PrivateKey, HarmonyShards, HRC20 } from 'harmony-marketplace-sdk'
+import * as ABI from './abi.json'
+
+const wallet = new PrivateKey(
+  new HttpProvider(HarmonyShards.SHARD_0),
+  '45e497bd45a9049bcb649016594489ac67b9f052a6cdf5cb74ee2427a60bf25e'
+)
+
+// A contract instance
+const contract = new HRC20('0x...00', ABI, wallet)
+
+// returns a BN instance.
+const balance = await contract.balanceOf('0x...01')
+```
+
+#### transfer
+
+Moves amount tokens from the caller’s account to to.
+
+```ts
+import { HttpProvider } from '@harmony-js/network'
+import { PrivateKey, HarmonyShards, HRC20 } from 'harmony-marketplace-sdk'
+import * as ABI from './abi.json'
+
+const wallet = new PrivateKey(
+  new HttpProvider(HarmonyShards.SHARD_0),
+  '45e497bd45a9049bcb649016594489ac67b9f052a6cdf5cb74ee2427a60bf25e'
+)
+
+// A contract instance
+const contract = new HRC20('0x...00', ABI, wallet)
+
+// returns a Harmony Transaction instance.
+const tx = await contract.transfer('0x...01', '1')
+```
+
+#### allowance
+
+Moves amount tokens from the caller’s account to to.
 
-This methods are common for [HRC721](#hrc721-api) and [HRC1155](#hrc1155-api).
+```ts
+import { HttpProvider } from '@harmony-js/network'
+import { PrivateKey, HarmonyShards, HRC20 } from 'harmony-marketplace-sdk'
+import * as ABI from './abi.json'
 
-#### setApprovalForAll
+const wallet = new PrivateKey(
+  new HttpProvider(HarmonyShards.SHARD_0),
+  '45e497bd45a9049bcb649016594489ac67b9f052a6cdf5cb74ee2427a60bf25e'
+)
+
+// A contract instance
+const contract = new HRC20('0x...00', ABI, wallet)
 
-Approve or remove operator as an operator for the caller.
+// returns a BN instance.
+const tx = await contract.allowance('0x...01', '0x...02')
+```
+
+#### approve
+
+Moves amount tokens from the caller’s account to to.
 
 ```ts
 import { HttpProvider } from '@harmony-js/network'
-import { PrivateKey, HarmonyShards, BaseToken } from 'harmony-marketplace-sdk'
+import { PrivateKey, HarmonyShards, HRC20 } from 'harmony-marketplace-sdk'
 import * as ABI from './abi.json'
 
 const wallet = new PrivateKey(
   new HttpProvider(HarmonyShards.SHARD_0),
   '45e497bd45a9049bcb649016594489ac67b9f052a6cdf5cb74ee2427a60bf25e'
 )
 
-class TestNFT extends BaseToken {}
+// A contract instance
+const contract = new HRC20('0x...00', ABI, wallet)
+
+// returns a Harmony Transaction instance.
+const tx = await contract.approve('0x...01', 100)
+```
+
+#### transferFrom
+
+Moves amount tokens from the caller’s account to to.
+
+```ts
+import { HttpProvider } from '@harmony-js/network'
+import { PrivateKey, HarmonyShards, HRC20 } from 'harmony-marketplace-sdk'
+import * as ABI from './abi.json'
+
+const wallet = new PrivateKey(
+  new HttpProvider(HarmonyShards.SHARD_0),
+  '45e497bd45a9049bcb649016594489ac67b9f052a6cdf5cb74ee2427a60bf25e'
+)
 
 // A contract instance
-const contract = new TestNFT('0x...00', ABI, wallet)
+const contract = new HRC20('0x...00', ABI, wallet)
 
 // returns a Harmony Transaction instance.
-const tx = await contract.setApprovalForAll('0x...01', true)
+const tx = await contract.transferFrom('0x...01', '0x...02', 100)
 ```
 
-#### isApprovedForAll
+#### symbol
 
-Returns if the operator is allowed to manage all of the assets of owner.
+Returns the token symbol.
 
 ```ts
 import { HttpProvider } from '@harmony-js/network'
-import { PrivateKey, HarmonyShards, BaseToken } from 'harmony-marketplace-sdk'
+import { PrivateKey, HarmonyShards, HRC20 } from 'harmony-marketplace-sdk'
 import * as ABI from './abi.json'
 
 const wallet = new PrivateKey(
   new HttpProvider(HarmonyShards.SHARD_0),
   '45e497bd45a9049bcb649016594489ac67b9f052a6cdf5cb74ee2427a60bf25e'
 )
 
-class TestNFT extends BaseToken {}
+// A contract instance
+const contract = new HRC20('0x...00', ABI, wallet)
+
+// returns a string value.
+const symbol = await contract.symbol() // BC
+```
+
+#### name
+
+Returns the token name.
+
+```ts
+import { HttpProvider } from '@harmony-js/network'
+import { PrivateKey, HarmonyShards, HRC20 } from 'harmony-marketplace-sdk'
+import * as ABI from './abi.json'
+
+const wallet = new PrivateKey(
+  new HttpProvider(HarmonyShards.SHARD_0),
+  '45e497bd45a9049bcb649016594489ac67b9f052a6cdf5cb74ee2427a60bf25e'
+)
+
+// A contract instance
+const contract = new HRC20('0x...00', ABI, wallet)
+
+// returns a string value.
+const name = await contract.name() // Blockcoders
+```
+
+#### decimals
+
+Returns the decimals places of the token.
+
+```ts
+import { HttpProvider } from '@harmony-js/network'
+import { PrivateKey, HarmonyShards, HRC20 } from 'harmony-marketplace-sdk'
+import * as ABI from './abi.json'
+
+const wallet = new PrivateKey(
+  new HttpProvider(HarmonyShards.SHARD_0),
+  '45e497bd45a9049bcb649016594489ac67b9f052a6cdf5cb74ee2427a60bf25e'
+)
 
 // A contract instance
-const contract = new TestNFT('0x...00', ABI, wallet)
+const contract = new HRC20('0x...00', ABI, wallet)
 
-// returns a boolean.
-const approved = await contract.isApprovedForAll('0x...01', '0x...02')
+// returns a number value.
+const name = await contract.decimals() // 18
 ```
 
 ## HRC721 API
@@ -232,7 +405,7 @@ Expected Events
 | Transfer | Emitted when a token id is transferred from an address to another. |
 | Approval | Emitted when owner enables approved to manage the tokenId token. |
 
-You can find an example of [HRC721](./src/tests/contracts/HRC721/BlockcodersHRC721.sol) in this address [0x...0a0a](https://explorer.pops.one/address/0xbba5d03304318b8fe765d977081eb392eb170a0a?activeTab=0).
+You can find an example of [HRC721](./src/tests/contracts/BlockcodersHRC721.sol) in this address [0x...0a0a](https://explorer.pops.one/address/0xbba5d03304318b8fe765d977081eb392eb170a0a?activeTab=0).
 
 ### Initializing
 
@@ -496,7 +669,7 @@ Expected Events
 | TransferSingle | Emitted when a token id are transferred from an address to another by operator. |
 | TransferBatch | Emitted when a token ids are transferred from an address to another by operator. |
 
-You can find an example of [HRC1155](./src/tests/contracts/HRC1155/BlockcodersHRC1155.sol) in this address [0x...b264](https://explorer.pops.one/address/0x16703afb468e4ba88380c2a2fda1aa4c5ec7b264).
+You can find an example of [HRC1155](./src/tests/contracts/BlockcodersHRC1155.sol) in this address [0x...b264](https://explorer.pops.one/address/0x16703afb468e4ba88380c2a2fda1aa4c5ec7b264).
 
 ### Initializing
 
@@ -677,6 +850,53 @@ const contract = new HRC1155('0x...00', ABI, wallet)
 const uri = await contract.contractURI()
 ```
 
+## BridgeToken API
+
+Harmony -> Ethereum way bridge 
+
+### Initializing
+
+```typescript
+import { HttpProvider } from '@harmony-js/network'
+import { PrivateKey, HarmonyShards, HRC1155 } from 'harmony-marketplace-sdk'
+import * as ABI from './abi.json'
+
+const ethOwner = new Wallet(
+  '45e497bd45a9049bcb649016594489ac67b9f052a6cdf5cb74ee2427a60bf25e',
+  new EtherscanProvider(
+    { chainId: 1 },
+    API_KEY,
+  )
+) 
+const hmyOwner = new PrivateKey(
+  new HttpProvider(HarmonyShards.SHARD_0),
+  '45e497bd45a9049bcb649016594489ac67b9f052a6cdf5cb74ee2427a60bf25e'
+)
+const bridge = new BridgeHRC20Token(hmyOwner, ethOwner)
+const token = new HRC20('0x...00', ABI, hmyOwner)
+const sender =  hmyOwner.accounts[0].toLowerCase()
+const recipient =  ethOwner.address.toLowerCase()
+const tokenInfo = { amount: 1000000000 }
+
+// Send tokens from Harmony to Ethereum
+const { addr, receiptId } = await bridge.sendToken(
+  BridgeType.HMY_TO_ETH,
+  sender,
+  recipient,
+  token,
+  tokenInfo,
+)
+
+// Send tokens from Ethereum to Harmony
+const { addr, receiptId } = await bridge.sendToken(
+  BridgeType.ETH_TO_HMY,
+  sender,
+  recipient,
+  token,
+  tokenInfo,
+)
+```
+
 ## Change Log
 
 See [Changelog](CHANGELOG.md) for more information.
@@ -690,6 +910,7 @@ Contributions welcome! See [Contributing](CONTRIBUTING.md).
 - [**Jose Ramirez**](https://github.com/0xslipk)
 - [**Brian Zuker**](https://github.com/bzuker)
 - [**Ana Riera**](https://github.com/AnnRiera)
+- [**Fernando Sirni**](https://github.com/fersirni)
 
 ## Acknowledgements
 

diff --git a/src/bridge/bridgeToken.ts b/src/bridge/bridgeToken.ts
@@ -1,5 +1,4 @@
 import { Signer, VoidSigner } from '@ethersproject/abstract-signer'
-import { Provider } from '@ethersproject/providers'
 import { Wallet } from '@harmony-js/account'
 import {
   BridgeType,
@@ -22,12 +21,7 @@ export abstract class BridgeToken {
   protected readonly hmyOwnerWallet: Wallet
   protected readonly network: NetworkInfo
 
-  constructor(
-    hmyOwnerWallet: Wallet,
-    ethOwnerWallet: Signer,
-    ethProvider: Provider,
-    network: NetworkInfo = NetworkInfo.MAINNET,
-  ) {
+  constructor(hmyOwnerWallet: Wallet, ethOwnerWallet: Signer, network: NetworkInfo = NetworkInfo.MAINNET) {
     this.network = network
     this.isMainnet = this.network === NetworkInfo.MAINNET
 
@@ -39,7 +33,11 @@ export abstract class BridgeToken {
       this.hmyMasterWallet = new Key(HARMONY_RPC_SHARD_0_DEVNET_URL)
     }
 
-    this.ethMasterWallet = this.ethMasterWallet.connect(ethProvider)
+    if (!ethOwnerWallet.provider) {
+      throw new Error('Ethereum signer should have a rpc provider set.')
+    }
+
+    this.ethMasterWallet = this.ethMasterWallet.connect(ethOwnerWallet.provider)
     this.hmyMasterWallet.setSigner(MAINNET_MULTISIG_WALLET)
 
     this.hmyOwnerWallet = hmyOwnerWallet

diff --git a/src/tests/e2e/bridge-token.e2e-spec.ts b/src/tests/e2e/bridge-token.e2e-spec.ts
@@ -66,7 +66,7 @@ describe('Bridge Token', () => {
       await token.mint(HMY_OWNER_ADDRESS, amount, E2E_TX_OPTIONS)
 
       hrc20 = new HRC20(addr, abi, WALLET_HMY_OWNER)
-      bridge = new BridgeHRC20Token(WALLET_HMY_OWNER, WALLET_ETH_OWNER, WALLET_ETH_MASTER.provider, NetworkInfo.DEVNET)
+      bridge = new BridgeHRC20Token(WALLET_HMY_OWNER, WALLET_ETH_OWNER, NetworkInfo.DEVNET)
     })
 
     it('Should send the tokens from Hmy to Eth', async () => {
@@ -149,7 +149,7 @@ describe('Bridge Token', () => {
       await token.mint(HMY_OWNER_ADDRESS, tokenId, E2E_TX_OPTIONS)
 
       hrc721 = new HRC721(addr, abi, WALLET_HMY_OWNER)
-      bridge = new BridgeHRC721Token(WALLET_HMY_OWNER, WALLET_ETH_OWNER, WALLET_ETH_MASTER.provider, NetworkInfo.DEVNET)
+      bridge = new BridgeHRC721Token(WALLET_HMY_OWNER, WALLET_ETH_OWNER, NetworkInfo.DEVNET)
     })
 
     it('Should send the tokens from Hmy to Eth', async () => {
@@ -236,12 +236,7 @@ describe('Bridge Token', () => {
       await token.mintBatch(HMY_OWNER_ADDRESS, tokenIds, amounts, E2E_TX_OPTIONS)
 
       hrc1155 = new HRC1155(addr, abi, WALLET_HMY_OWNER)
-      bridge = new BridgeHRC1155Token(
-        WALLET_HMY_OWNER,
-        WALLET_ETH_OWNER,
-        WALLET_ETH_MASTER.provider,
-        NetworkInfo.DEVNET,
-      )
+      bridge = new BridgeHRC1155Token(WALLET_HMY_OWNER, WALLET_ETH_OWNER, NetworkInfo.DEVNET)
     })
 
     it('Should send the tokens from Hmy to Eth', async () => {