Merge pull request #7 from aibtcdev/feat/ad-update-sprint

NFTs as an ad network

Author: whoabuddy

Clarinet.toml

@@ -4,7 +4,31 @@ description = ''
 authors = []
 telemetry = true
 cache_dir = './.cache'
-requirements = []
+
+[[project.requirements]]
+contract_id = 'SP2PABAF9FTAJYNFZH93XENAJ8FVY99RRM50D2JG9.nft-trait'
+
+[contracts.external-proxy]
+path = 'contracts/test-proxy.clar'
+deployer = 'wallet_1'
+clarity_version = 2
+epoch = 2.5
+
+[contracts.proxy]
+path = 'contracts/test-proxy.clar'
+clarity_version = 2
+epoch = 2.5
+
+[contracts.aibtcdev-airdrop-1]
+path = 'contracts/aibtcdev-airdrop-1.clar'
+clarity_version = 2
+epoch = 2.5
+
+[contracts.aibtcdev-airdrop-2]
+path = 'contracts/aibtcdev-airdrop-2.clar'
+clarity_version = 2
+epoch = 2.5
+
 [contracts.aibtcdev-aibtc]
 path = 'contracts/aibtcdev-aibtc.clar'
 clarity_version = 2

contracts/aibtcdev-airdrop-1.clar

@@ -0,0 +1,58 @@
+(impl-trait 'SP2PABAF9FTAJYNFZH93XENAJ8FVY99RRM50D2JG9.nft-trait.nft-trait)
+
+(define-constant DEPLOYER tx-sender)
+
+(define-data-var nextId uint u1)
+(define-data-var url (string-ascii 256) "https://nft-ad-1.aibtc.dev/aibtcdev-1.json")
+
+(define-non-fungible-token aibtcdev-1 uint)
+
+(define-read-only (get-last-token-id) (ok (- (var-get nextId) u1)))
+(define-read-only (get-token-uri (id uint)) (ok (some (var-get url) )))
+(define-read-only (get-owner (id uint)) (ok (nft-get-owner? aibtcdev-1 id)))
+
+(define-public (transfer (id uint) (from principal) (to principal))
+  (if (or (is-eq from tx-sender) (is-eq from contract-caller))
+    (nft-transfer? aibtcdev-1 id from to)
+    (err u4)
+  )
+)
+
+(define-public (burn (id uint) (from principal))
+  (if (or (is-eq from tx-sender) (is-eq from contract-caller))
+    (nft-burn? aibtcdev-1 id from)
+    (err u4)
+  )
+)
+
+(define-public (mint (to principal))
+  (let ((id (var-get nextId)))
+    (asserts! (is-eq DEPLOYER (get-standard-caller)) (err u401))
+    (var-set nextId (+ id u1))
+    (nft-mint? aibtcdev-1 id to)
+  )
+)
+
+(define-public (set-url (new (string-ascii 256)))
+  (if (is-eq DEPLOYER (get-standard-caller))
+    (ok (var-set url new))
+    (err u401)
+  )
+)
+
+(define-public (airdrop (l1 (list 5000 principal)) (l2 (list 5000 principal)) (l3 (list 4995 principal)))
+  (if (is-eq DEPLOYER (get-standard-caller))
+    (ok (var-set nextId (fold drop l3 (fold drop l2 (fold drop l1 (var-get nextId))))))
+    (err u401)
+  )
+)
+
+(define-private (drop (to principal) (id uint))
+  (begin (is-err (nft-mint? aibtcdev-1 id to)) (+ id u1))
+)
+
+(define-read-only (get-standard-caller)
+  (let ((d (unwrap-panic (principal-destruct? contract-caller))))
+    (unwrap-panic (principal-construct? (get version d) (get hash-bytes d)))
+  )
+)

contracts/aibtcdev-airdrop-2.clar

@@ -0,0 +1,58 @@
+(impl-trait 'SP2PABAF9FTAJYNFZH93XENAJ8FVY99RRM50D2JG9.nft-trait.nft-trait)
+
+(define-constant DEPLOYER tx-sender)
+
+(define-data-var nextId uint u1)
+(define-data-var url (string-ascii 256) "https://nft-ad-2.aibtc.dev/aibtcdev-2.json")
+
+(define-non-fungible-token aibtcdev-2 uint)
+
+(define-read-only (get-last-token-id) (ok (- (var-get nextId) u1)))
+(define-read-only (get-token-uri (id uint)) (ok (some (var-get url) )))
+(define-read-only (get-owner (id uint)) (ok (nft-get-owner? aibtcdev-2 id)))
+
+(define-public (transfer (id uint) (from principal) (to principal))
+  (if (or (is-eq from tx-sender) (is-eq from contract-caller))
+    (nft-transfer? aibtcdev-2 id from to)
+    (err u4)
+  )
+)
+
+(define-public (burn (id uint) (from principal))
+  (if (or (is-eq from tx-sender) (is-eq from contract-caller))
+    (nft-burn? aibtcdev-2 id from)
+    (err u4)
+  )
+)
+
+(define-public (mint (to principal))
+  (let ((id (var-get nextId)))
+    (asserts! (is-eq DEPLOYER (get-standard-caller)) (err u401))
+    (var-set nextId (+ id u1))
+    (nft-mint? aibtcdev-2 id to)
+  )
+)
+
+(define-public (set-url (new (string-ascii 256)))
+  (if (is-eq DEPLOYER (get-standard-caller))
+    (ok (var-set url new))
+    (err u401)
+  )
+)
+
+(define-public (airdrop (l1 (list 5000 principal)) (l2 (list 5000 principal)) (l3 (list 4995 principal)))
+  (if (is-eq DEPLOYER (get-standard-caller))
+    (ok (var-set nextId (fold drop l3 (fold drop l2 (fold drop l1 (var-get nextId))))))
+    (err u401)
+  )
+)
+
+(define-private (drop (to principal) (id uint))
+  (begin (is-err (nft-mint? aibtcdev-2 id to)) (+ id u1))
+)
+
+(define-read-only (get-standard-caller)
+  (let ((d (unwrap-panic (principal-destruct? contract-caller))))
+    (unwrap-panic (principal-construct? (get version d) (get hash-bytes d)))
+  )
+)

contracts/test-proxy.clar

@@ -12,6 +12,8 @@
 
 ;; constants
 ;;
+(define-constant CONTRACT (as-contract tx-sender))
+(define-constant OWNER tx-sender)
 
 ;; data vars
 ;;
@@ -27,10 +29,18 @@
       caller: contract-caller,
       sender: tx-sender,
     })
-    (ok (contract-call? .aibtcdev-bank-account get-standard-caller))
+    (ok (contract-call? 'ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.aibtcdev-bank-account get-standard-caller))
   )
 )
 
+(define-public (mint-aibtcdev-1 (to principal))
+  (contract-call? 'ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.aibtcdev-airdrop-1 mint to)
+)
+
+(define-public (mint-aibtcdev-2 (to principal))
+  (contract-call? 'ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.aibtcdev-airdrop-2 mint to)
+)
+
 ;; read only functions
 ;;
 

deployments/default.simnet-plan.yaml

@@ -48,6 +48,14 @@ genesis:
 plan:
   batches:
     - id: 0
+      transactions:
+        - emulated-contract-publish:
+            contract-name: nft-trait
+            emulated-sender: SP2PABAF9FTAJYNFZH93XENAJ8FVY99RRM50D2JG9
+            path: "./.cache/requirements/SP2PABAF9FTAJYNFZH93XENAJ8FVY99RRM50D2JG9.nft-trait.clar"
+            clarity-version: 1
+      epoch: "2.0"
+    - id: 1
       transactions:
         - emulated-contract-publish:
             contract-name: aibtcdev-aibtc
@@ -65,16 +73,36 @@ plan:
             path: contracts/aibtcdev-resources-v1.clar
             clarity-version: 2
       epoch: "2.4"
-    - id: 1
+    - id: 2
       transactions:
+        - emulated-contract-publish:
+            contract-name: aibtcdev-airdrop-1
+            emulated-sender: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
+            path: contracts/aibtcdev-airdrop-1.clar
+            clarity-version: 2
+        - emulated-contract-publish:
+            contract-name: aibtcdev-airdrop-2
+            emulated-sender: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
+            path: contracts/aibtcdev-airdrop-2.clar
+            clarity-version: 2
         - emulated-contract-publish:
             contract-name: aibtcdev-bank-account
             emulated-sender: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
             path: contracts/aibtcdev-bank-account.clar
             clarity-version: 2
+        - emulated-contract-publish:
+            contract-name: proxy
+            emulated-sender: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
+            path: contracts/test-proxy.clar
+            clarity-version: 2
         - emulated-contract-publish:
             contract-name: test-proxy
             emulated-sender: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
             path: contracts/test-proxy.clar
             clarity-version: 2
+        - emulated-contract-publish:
+            contract-name: external-proxy
+            emulated-sender: ST1SJ3DTE5DN7X54YDH5D64R3BCB6A2AG2ZQ8YPD5
+            path: contracts/test-proxy.clar
+            clarity-version: 2
       epoch: "2.5"

tests/aibtcdev-airdrop-1.test.ts

@@ -0,0 +1,158 @@
+import { Tx, tx } from "@hirosystems/clarinet-sdk";
+import {
+  boolCV,
+  noneCV,
+  principalCV,
+  someCV,
+  uintCV,
+} from "@stacks/transactions";
+import { describe, expect, it } from "vitest";
+
+const accounts = simnet.getAccounts();
+const address1 = accounts.get("wallet_1")!;
+
+const CONTRACT = "aibtcdev-airdrop-1";
+
+const getLastTokenId = () => {
+  return simnet.callReadOnlyFn(
+    CONTRACT,
+    "get-last-token-id",
+    [],
+    simnet.deployer
+  ).result;
+};
+
+const getOwner = (id: number) => {
+  return simnet.callReadOnlyFn(
+    CONTRACT,
+    "get-owner",
+    [uintCV(id)],
+    simnet.deployer
+  ).result;
+};
+
+const transfer = (id: number, from: string, to: string, sender: string) => {
+  return tx.callPublicFn(
+    CONTRACT,
+    "transfer",
+    [uintCV(id), principalCV(from), principalCV(to)],
+    sender
+  );
+};
+
+const mint = (to: string, sender: string | string = simnet.deployer) => {
+  return tx.callPublicFn(CONTRACT, "mint", [principalCV(to)], sender);
+};
+
+describe("get-last-token-id", () => {
+  it("returns 0 after deployment", () => {
+    expect(getLastTokenId()).toBeOk(uintCV(0));
+  });
+
+  it("returns correct value after minting few NFT's", () => {
+    const MIN = 0;
+    const MAX = 200;
+    const MINTS = Math.floor(Math.random() * (MAX - MIN + 1)) + MIN;
+
+    const TXS = new Array(MINTS).fill(null).map(() => mint(simnet.deployer));
+
+    simnet.mineBlock(TXS);
+
+    expect(getLastTokenId()).toBeOk(uintCV(MINTS));
+  });
+});
+
+describe("mint", () => {
+  it("fails when called by someone who is not contract deployer", () => {
+    const tx = mint(address1, address1);
+    const result = simnet.mineBlock([tx])[0].result;
+
+    expect(result).toBeErr(uintCV(401));
+  });
+
+  it("succeeds when called by anyone via proxy contract deployed by same address as NFT contract deployer", () => {
+    const t1 = tx.callPublicFn(
+      "proxy",
+      "mint-aibtcdev-1",
+      [principalCV(address1)],
+      address1
+    );
+    const t2 = tx.callPublicFn(
+      "proxy",
+      "mint-aibtcdev-1",
+      [principalCV(address1)],
+      simnet.deployer
+    );
+
+    const block = simnet.mineBlock([t1, t2]);
+
+    expect(block[0].result).toBeOk(boolCV(true));
+    expect(block[1].result).toBeOk(boolCV(true));
+
+    expect(getOwner(1)).toBeOk(someCV(principalCV(address1)));
+    expect(getOwner(2)).toBeOk(someCV(principalCV(address1)));
+  });
+
+  it("fails when called by anyone via proxy contract deployed by different address than NFT contract deployer", () => {
+    const t1 = tx.callPublicFn(
+      `${address1}.external-proxy`,
+      "mint-aibtcdev-1",
+      [principalCV(address1)],
+      address1
+    );
+    const t2 = tx.callPublicFn(
+      `${address1}.external-proxy`,
+      "mint-aibtcdev-1",
+      [principalCV(address1)],
+      simnet.deployer
+    );
+
+    const block = simnet.mineBlock([t1, t2]);
+
+    expect(block[0].result).toBeErr(uintCV(401));
+    expect(block[1].result).toBeErr(uintCV(401));
+  });
+
+  it("mints new NFT to transaction sender", () => {
+    const t1 = mint(simnet.deployer);
+    const t2 = mint(address1);
+
+    expect(getOwner(1)).toBeOk(noneCV());
+    expect(getOwner(2)).toBeOk(noneCV());
+
+    simnet.mineBlock([t1, t2]);
+
+    expect(getOwner(1)).toBeOk(someCV(principalCV(simnet.deployer)));
+    expect(getOwner(2)).toBeOk(someCV(principalCV(address1)));
+  });
+});
+
+describe("transfer", () => {
+  it("fails when called by someone who is not NFT owner", () => {
+    const owner = address1;
+    const not_owner = simnet.deployer;
+
+    simnet.mineBlock([mint(owner)]);
+    expect(getOwner(1)).toBeOk(someCV(principalCV(owner)));
+
+    const result = simnet.mineBlock([
+      transfer(1, owner, not_owner, not_owner),
+    ])[0].result;
+    expect(result).toBeErr(uintCV(4));
+  });
+
+  it("transfers NFT from one account to another", () => {
+    const from = address1;
+    const to = simnet.deployer;
+
+    simnet.mineBlock([mint(from), mint(from)]);
+    expect(getOwner(1)).toBeOk(someCV(principalCV(from)));
+    expect(getOwner(2)).toBeOk(someCV(principalCV(from)));
+
+    const result = simnet.mineBlock([transfer(1, from, to, from)])[0].result;
+    expect(result).toBeOk(boolCV(true));
+
+    expect(getOwner(1)).toBeOk(someCV(principalCV(to)));
+    expect(getOwner(2)).toBeOk(someCV(principalCV(from)));
+  });
+});