Added support to deployNFT and fixes smart_contract getOptions function

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+### Added
+- Add `deployNFT` method to `WalletAddress` and `Wallet` to deploy an ERC721, updated `SmartContract` class to support deployment and fetching contract details
+
 ## [0.6.1] - 2024-09-23
 
 ### Added

src/client/api.ts

@@ -1596,6 +1596,12 @@ export interface NFTContractOptions {
      * @memberof NFTContractOptions
      */
     'symbol': string;
+    /**
+     * The base URI for the NFT metadata
+     * @type {string}
+     * @memberof NFTContractOptions
+     */
+    'base_uri': string;
 }
 /**
  * 

src/coinbase/address/wallet_address.ts

@@ -16,6 +16,7 @@ import {
   Destination,
   StakeOptionsMode,
   CreateERC20Options,
+  CreateERC721Options,
 } from "../types";
 import { delay } from "../utils";
 import { Wallet as WalletClass } from "../wallet";
@@ -332,7 +333,7 @@ export class WalletAddress extends Address {
    * @param options.symbol - The symbol of the ERC20 token.
    * @param options.totalSupply - The total supply of the ERC20 token.
    * @returns A Promise that resolves to the deployed SmartContract object.
-   * @throws {Error} If the private key is not loaded when not using server signer.
+   * @throws {APIError} If the API request to create a smart contract fails.
    */
   public async deployToken(options: CreateERC20Options): Promise<SmartContract> {
     if (!Coinbase.useServerSigner && !this.key) {
@@ -351,6 +352,33 @@ export class WalletAddress extends Address {
     return smartContract;
   }
 
+  /**
+   * Deploys an ERC721 token contract.
+   *
+   * @param options - The options for creating the ERC721 token.
+   * @param options.name - The name of the ERC721 token.
+   * @param options.symbol - The symbol of the ERC721 token.
+   * @param options.baseURI - The base URI of the ERC721 token.
+   * @returns A Promise that resolves to the deployed SmartContract object.
+   * @throws {APIError} If the API request to create a smart contract fails.
+   */
+  public async deployNFT(options: CreateERC721Options): Promise<SmartContract> {
+    if (!Coinbase.useServerSigner && !this.key) {
+      throw new Error("Cannot deploy ERC721 without private key loaded");
+    }
+
+    const smartContract = await this.createERC721(options);
+
+    if (Coinbase.useServerSigner) {
+      return smartContract;
+    }
+
+    await smartContract.sign(this.getSigner());
+    await smartContract.broadcast();
+
+    return smartContract;
+  }
+
   /**
    * Creates an ERC20 token contract.
    *
@@ -378,6 +406,32 @@ export class WalletAddress extends Address {
     return SmartContract.fromModel(resp?.data);
   }
 
+  /**
+   * Creates an ERC721 token contract.
+   *
+   * @param options - The options for creating the ERC721 token.
+   * @param options.name - The name of the ERC721 token.
+   * @param options.symbol - The symbol of the ERC721 token.
+   * @param options.baseURI - The base URI of the ERC721 token.
+   * @returns A Promise that resolves to the deployed SmartContract object.
+   * @throws {APIError} If the private key is not loaded when not using server signer.
+   */
+  private async createERC721(options: CreateERC721Options): Promise<SmartContract> {
+    const resp = await Coinbase.apiClients.smartContract!.createSmartContract(
+      this.getWalletId(),
+      this.getId(),
+      {
+        type: SmartContractType.Erc721,
+        options: {
+          name: options.name,
+          symbol: options.symbol,
+          base_uri: options.baseURI,
+        },
+      },
+    );
+    return SmartContract.fromModel(resp?.data);
+  }
+
   /**
    * Creates a contract invocation with the given data.
    *

src/coinbase/smart_contract.ts

@@ -3,6 +3,8 @@ import {
   DeploySmartContractRequest,
   SmartContract as SmartContractModel,
   SmartContractType as SmartContractTypeModel,
+  SmartContractOptions as SmartContractOptionsModel,
+  TokenContractOptions as TokenContractOptionsModel,
 } from "../client/api";
 import { Transaction } from "./transaction";
 import {
@@ -164,10 +166,19 @@ export class SmartContract {
    * @returns The Smart Contract Options.
    */
   public getOptions(): SmartContractOptions {
-    if (this.getType() === SmartContractType.ERC20) {
-      return this.model.options as TokenContractOptions;
+    if (this.isERC20(this.getType(), this.model.options)) {
+      return {
+        name: this.model.options.name,
+        symbol: this.model.options.symbol,
+        totalSupply: this.model.options.total_supply,
+      } as TokenContractOptions;
+    } else {
+      return {
+        name: this.model.options.name,
+        symbol: this.model.options.symbol,
+        baseURI: this.model.options.base_uri,
+      } as NFTContractOptions;
     }
-    return this.model.options as NFTContractOptions;
   }
 
   /**
@@ -279,4 +290,18 @@ export class SmartContract {
       `type: '${this.getType()}'}`
     );
   }
+
+  /**
+   * Type guard for checking if the smart contract is an ERC20.
+   *
+   * @param type - The type of the smart contract.
+   * @param options - The options of the smart contract.
+   * @returns True if the smart contract is an ERC20, false otherwise.
+   */
+  private isERC20(
+    type: SmartContractType,
+    options: SmartContractOptionsModel,
+  ): options is TokenContractOptionsModel {
+    return type === SmartContractType.ERC20;
+  }
 }

src/coinbase/types.ts

@@ -920,6 +920,7 @@ export enum SmartContractType {
 export type NFTContractOptions = {
   name: string;
   symbol: string;
+  baseURI: string;
 };
 
 /**
@@ -976,6 +977,15 @@ export type CreateERC20Options = {
   totalSupply: Amount;
 };
 
+/**
+ * Options for creating a ERC721.
+ */
+export type CreateERC721Options = {
+  name: string;
+  symbol: string;
+  baseURI: string;
+};
+
 /**
  * Options for listing historical balances of an address.
  */

src/coinbase/wallet.ts

@@ -29,6 +29,7 @@ import {
   WalletCreateOptions,
   WalletData,
   CreateERC20Options,
+  CreateERC721Options,
 } from "./types";
 import { convertStringToHex, delay, formatDate, getWeekBackDate } from "./utils";
 import { StakingOperation } from "./staking_operation";
@@ -783,6 +784,20 @@ export class Wallet {
     return (await this.getDefaultAddress()).deployToken(options);
   }
 
+  /**
+   * Deploys an ERC721 token contract.
+   *
+   * @param options - The options for creating the ERC721 token.
+   * @param options.name - The name of the ERC721 token.
+   * @param options.symbol - The symbol of the ERC721 token.
+   * @param options.baseURI - The base URI of the ERC721 token.
+   * @returns A Promise that resolves to the deployed SmartContract object.
+   * @throws {APIError} If the private key is not loaded when not using server signer.
+   */
+  public async deployNFT(options: CreateERC721Options): Promise<SmartContract> {
+    return (await this.getDefaultAddress()).deployNFT(options);
+  }
+
   /**
    * Returns a String representation of the Wallet.
    *

src/examples/solana_list_rewards.ts

@@ -8,11 +8,24 @@ async function listSolanaStakingRewards() {
 
   const startTime = new Date(2024, 5).toISOString();
 
-  const rewards = await StakingReward.list(NetworkIdentifier.SolanaMainnet, Coinbase.assets.Sol, ["beefKGBWeSpHzYBHZXwp5So7wdQGX6mu4ZHCsH3uTar"], startTime, new Date().toISOString());
+  const rewards = await StakingReward.list(
+    NetworkIdentifier.SolanaMainnet,
+    Coinbase.assets.Sol,
+    ["beefKGBWeSpHzYBHZXwp5So7wdQGX6mu4ZHCsH3uTar"],
+    startTime,
+    new Date().toISOString(),
+  );
   console.log(rewards);
 
-  const addr = new Address(NetworkIdentifier.SolanaMainnet, "beefKGBWeSpHzYBHZXwp5So7wdQGX6mu4ZHCsH3uTar");
-  const balances = await addr.historicalStakingBalances(Coinbase.assets.Sol, startTime, new Date().toISOString());
+  const addr = new Address(
+    NetworkIdentifier.SolanaMainnet,
+    "beefKGBWeSpHzYBHZXwp5So7wdQGX6mu4ZHCsH3uTar",
+  );
+  const balances = await addr.historicalStakingBalances(
+    Coinbase.assets.Sol,
+    startTime,
+    new Date().toISOString(),
+  );
   console.log(balances);
 }
 

src/index.ts

@@ -1,29 +1,29 @@
 export * from "./coinbase/address";
 export * from "./coinbase/address/external_address";
 export * from "./coinbase/address/wallet_address";
-export * from './coinbase/api_error';
-export * from './coinbase/asset';
-export * from './coinbase/authenticator';
-export * from './coinbase/balance';
-export * from './coinbase/balance_map';
-export * from './coinbase/coinbase';
-export * from './coinbase/constants';
-export * from './coinbase/contract_event';
-export * from './coinbase/contract_invocation';
-export * from './coinbase/errors';
-export * from './coinbase/faucet_transaction';
-export * from './coinbase/hash';
-export * from './coinbase/historical_balance';
-export * from './coinbase/payload_signature';
-export * from './coinbase/server_signer';
-export * from './coinbase/smart_contract';
-export * from './coinbase/staking_balance';
-export * from './coinbase/staking_operation';
-export * from './coinbase/staking_reward';
-export * from './coinbase/trade';
-export * from './coinbase/transaction';
-export * from './coinbase/transfer';
-export * from './coinbase/types';
-export * from './coinbase/validator';
-export * from './coinbase/wallet';
-export * from './coinbase/webhook';
+export * from "./coinbase/api_error";
+export * from "./coinbase/asset";
+export * from "./coinbase/authenticator";
+export * from "./coinbase/balance";
+export * from "./coinbase/balance_map";
+export * from "./coinbase/coinbase";
+export * from "./coinbase/constants";
+export * from "./coinbase/contract_event";
+export * from "./coinbase/contract_invocation";
+export * from "./coinbase/errors";
+export * from "./coinbase/faucet_transaction";
+export * from "./coinbase/hash";
+export * from "./coinbase/historical_balance";
+export * from "./coinbase/payload_signature";
+export * from "./coinbase/server_signer";
+export * from "./coinbase/smart_contract";
+export * from "./coinbase/staking_balance";
+export * from "./coinbase/staking_operation";
+export * from "./coinbase/staking_reward";
+export * from "./coinbase/trade";
+export * from "./coinbase/transaction";
+export * from "./coinbase/transfer";
+export * from "./coinbase/types";
+export * from "./coinbase/validator";
+export * from "./coinbase/wallet";
+export * from "./coinbase/webhook";

src/tests/address_test.ts

@@ -70,7 +70,9 @@ describe("Address", () => {
       const result = await address.listTransactions({ limit: 2, page: "page" });
       expect(result.transactions.length).toEqual(2);
       expect(result.transactions[0].blockHeight()).toEqual("12345");
-      expect(Coinbase.apiClients.transactionHistory!.listAddressTransactions).toHaveBeenCalledTimes(1);
+      expect(Coinbase.apiClients.transactionHistory!.listAddressTransactions).toHaveBeenCalledTimes(
+        1,
+      );
       expect(Coinbase.apiClients.transactionHistory!.listAddressTransactions).toHaveBeenCalledWith(
         address.getNetworkId(),
         address.getId(),
@@ -98,7 +100,9 @@ describe("Address", () => {
       const result = await address.listTransactions({});
       expect(result.transactions.length).toEqual(1);
       expect(result.transactions[0].blockHeight()).toEqual("12348");
-      expect(Coinbase.apiClients.transactionHistory!.listAddressTransactions).toHaveBeenCalledTimes(1);
+      expect(Coinbase.apiClients.transactionHistory!.listAddressTransactions).toHaveBeenCalledTimes(
+        1,
+      );
       expect(Coinbase.apiClients.transactionHistory!.listAddressTransactions).toHaveBeenCalledWith(
         address.getNetworkId(),
         address.getId(),
@@ -116,7 +120,9 @@ describe("Address", () => {
       });
       const result = await address.listTransactions({});
       expect(result.transactions.length).toEqual(0);
-      expect(Coinbase.apiClients.transactionHistory!.listAddressTransactions).toHaveBeenCalledTimes(1);
+      expect(Coinbase.apiClients.transactionHistory!.listAddressTransactions).toHaveBeenCalledTimes(
+        1,
+      );
       expect(Coinbase.apiClients.transactionHistory!.listAddressTransactions).toHaveBeenCalledWith(
         address.getNetworkId(),
         address.getId(),