community-hello-world-explorer

;; community-hello-world
;; Contract that provides a community billboad, readable by anyone but only updateable by admin

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Constants, Variables & Maps ;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

;;Constant that sets admin to the contract deployer
(define-constant admin tx-sender)

;; Error messages
(define-constant ERR-TX-SENDER-NOT-NEXT-USER (err u0))
(define-constant ERR-UPDATED-USER-NAME-IS-EMPTY (err u1))
(define-constant ERR-TX-SENDER-ISNT-ADMIN (err u2))
(define-constant ERR-NEXT-USER-PRINCIPAL-IS-ADMIN (err u3))
(define-constant ERR-UPDATED-USER-IS-NEXT-USER (err u4))

;; Variable that keeps track of the next user that has "write" access to the billboard
(define-data-var next-user principal tx-sender)

;;Variable tuple that contains new member info
(define-data-var billboard {new-user-principal: principal, new-user-name: (string-ascii 24)} {
    new-user-principal: tx-sender,
    new-user-name: ""
})

;;;;;;;;;;;;;;;;;;;;
;; Read Functions ;;
;;;;;;;;;;;;;;;;;;;;

;; Get community billboard
(define-read-only (get-billboard) 
    (var-get billboard)
)

;; Get next user
(define-read-only (get-next-user) 
    (var-get next-user)
)

;;;;;;;;;;;;;;;;;;;;;
;; Write Functions ;;
;;;;;;;;;;;;;;;;;;;;;

;; Update billboard
;; @desc - function users by next-user to update the community billboard
;;@param - new-user-name: (string-ascii 24)
(define-public (update-billboard (updated-user-name (string-ascii 24))) 
    (begin
    ;; Assert that tx-sender is next-user (approved by admin)
    (asserts! (is-eq tx-sender (var-get next-user)) ERR-TX-SENDER-NOT-NEXT-USER)
    ;; Assert that updated-user-name is not empty
    (asserts! (not (is-eq updated-user-name "")) ERR-UPDATED-USER-NAME-IS-EMPTY)
    ;; Var-set billboard with new keys
    (ok (var-set billboard {
        new-user-principal: tx-sender,
        new-user-name: updated-user-name
    }))

    )
)

;; Admin Set New User
;;@desc - functiuon used by admin to set / give permission to next user
;;@param - updated-user-principal: principal
(define-public (admin-set-new-user (updated-user-principal principal)) 
    (begin 

        ;; Assert that tx-sender is admin
        (asserts! (is-eq tx-sender admin) ERR-TX-SENDER-ISNT-ADMIN)
        ;; Assert that Updated-user-principal is NOT admin
        (asserts! (not (is-eq tx-sender updated-user-principal)) ERR-NEXT-USER-PRINCIPAL-IS-ADMIN)
        ;; Assert that updated-user-principal is NOT current next-user
        (asserts! (not (is-eq updated-user-principal (var-get next-user))) ERR-UPDATED-USER-IS-NEXT-USER)
        ;; Var-set next-user with updated-user-principal
        (ok (var-set next-user updated-user-principal))
    )
)