@aurigami/sdk 1.6.1 → 1.6.2

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.6.1",
+  "version": "1.6.2",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -60,7 +60,7 @@
     "typescript": "^4.5.4"
   },
   "dependencies": {
-    "@aurigami/contracts": "3.4.0",
+    "@aurigami/contracts": "3.5.0",
     "axios": "^0.26.1",
     "bignumber.js": "^9.0.2",
     "dotenv": "^16.0.0",

package/src/consts/constants.ts

@@ -81,6 +81,7 @@ export const networkAddresses: NetworkAddresses = {
     MULTICALL: MAINNET_ADDRESSES.multicall.toLowerCase(),
     TEAM_MULTISIG: '0x2D05FfFE70CE64c5954710D4C308dB31C8dBd8dE'.toLowerCase(),
     PLY_TOKEN_LOCK: MAINNET_ADDRESSES.plyTokenLock.toLowerCase(),
+    REFERRAL: MAINNET_ADDRESSES.referralDirectory.toLocaleLowerCase(),
   },
   tokens: {
     AURORA: '0x8bec47865ade3b172a928df8f990bc7f2a3b9f79'.toLowerCase(),

package/src/contracts/Referral.ts

@@ -0,0 +1,98 @@
+import ReferralDirectoryABI from '@aurigami/contracts/artifacts/contracts/ReferralDirectory.sol/ReferralDirectory.json';
+import { ReferralDirectory } from '@aurigami/contracts/typechain';
+import { TransactionResponse } from '@ethersproject/abstract-provider';
+import { Contract, ethers } from 'ethers';
+import * as consts from '../consts';
+import { BlockchainEntity, BlockchainEntityRead } from '../entities';
+import { Address, NetworkConnection } from '../types';
+
+export class ReferralRead extends BlockchainEntityRead {
+  protected _referral: ReferralDirectory;
+  constructor(networkConnection: NetworkConnection) {
+    super(networkConnection);
+    this._referral = new Contract(
+      consts.networkAddresses.misc.REFERRAL,
+      ReferralDirectoryABI.abi,
+      networkConnection.provider
+    ) as ReferralDirectory;
+  }
+
+  /**
+   * Generate a 10-character referral code
+   * containing alphanumeric characters.
+   */
+  protected generateReferralCode(): string {
+    let letters = 'abcdefghijklmnopqrstuvwxyz';
+    let numbers = '1234567890';
+    let charset = letters + letters.toUpperCase() + numbers;
+    let R = '';
+    for (var i = 0; i < 10; i++)
+      R += charset[Math.floor(Math.random() * charset.length)];
+    return R;
+  }
+
+  /**
+   * Get the referral code for a given address, returns empty string if not found.
+   *
+   * Called to check if a user has a referral code.
+   */
+  public async getUserReferralCode(userAddr: Address): Promise<string> {
+    const result = await this._referral.userReferralCode(userAddr);
+    return ethers.utils.parseBytes32String(result);
+  }
+
+  /**
+   * Get referral code that a user was referred by, returns empty string if not found.
+   */
+  public async getReferralCodeUsed(userAddr: Address): Promise<string> {
+    const result = await this._referral.referralCodeUsed(userAddr);
+    return ethers.utils.parseBytes32String(result);
+  }
+
+  /**
+   * Get owner of a referral code, returns zero address if not found.
+   */
+  public async getReferralCodeOwner(code: string): Promise<Address> {
+    const referralCode = ethers.utils.formatBytes32String(code);
+    return this._referral.referralCodeOwner(referralCode);
+  }
+}
+
+export class ReferralReadWrite extends ReferralRead {
+  /**
+   * Generate a referral code for a given address.
+   *
+   * Called when an user want to creates his own referral code
+   */
+  public async registerNewReferralCode(): Promise<TransactionResponse> {
+    const referralCode = ethers.utils.formatBytes32String(
+      this.generateReferralCode()
+    );
+    return this._referral
+      .connect(this._networkConnection.signer!)
+      .registerNewUserReferralCode(referralCode);
+  }
+
+  /**
+   * Called when an user confirms he is referred by a specified code
+   */
+  public async useReferralCode(code: string): Promise<TransactionResponse> {
+    const referralCode = ethers.utils.formatBytes32String(code);
+    return this._referral
+      .connect(this._networkConnection.signer!)
+      .registerReferralCodeUsed(referralCode);
+  }
+}
+
+export class Referral extends BlockchainEntity {
+  constructor() {
+    super();
+  }
+  public read(networkConnection: NetworkConnection): ReferralRead {
+    return new ReferralRead(networkConnection);
+  }
+
+  public readWrite(networkConnection: NetworkConnection): ReferralReadWrite {
+    return new ReferralReadWrite(networkConnection);
+  }
+}

package/src/contracts/index.ts

@@ -1,4 +1,5 @@
 export * from './airdrop-lottery';
 export * from './MoneyMarket';
 export * from './Papermill';
+export * from './Referral';
 export * from './Staking';