Skip to content
/ lorentz-contract-transferlist Public

Transfer whitelisting as an isolated contract or a contract wrapper

License

BSD-3-Clause license
3 stars 1 fork Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

tqtezos/lorentz-contract-transferlist

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
app
app
 
 
hpack
hpack
 
 
src
src
 
 
test
test
 
 
.gitignore
.gitignore
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
Setup.hs
Setup.hs
 
 
package.yaml
package.yaml
 
 
shell.nix
shell.nix
 
 
stack
stack
 
 
stack.yaml
stack.yaml
 
 
stack.yaml.lock
stack.yaml.lock
 
 

Repository files navigation

See the FA1.2 Quick Start Tutorial for more detail.

The CLI

The CLI has two parts:

  • Transferlist: Polymorphic transferlist contract and parameters
  • TransferlistManagedLedger: The Transferlisted FA1.2 contract
❯❯❯ ./stack exec -- lorentz-contract-transferlist --help

Lorentz tools

Usage: lorentz-contract-transferlist COMMAND
  Sale contract parameter generation helper

Available options:
  -h,--help                Show this help text

Available commands:
  Transferlist                Transferlist contract CLI interface
  TransferlistManagedLedger   Transferlist Wrapped ManagedLedger contract CLI
                           interface

You can use help for specific COMMAND
EXAMPLE:
  lorentz-contract-sale COMMAND --help

The TransferlistManagedLedger part is only used to print and initialize a wrapped ManagedLedger, i.e. FA1.2, contract. The rest of the interface is provided in the Transferlist part:

❯❯❯ ./stack exec -- lorentz-contract-transferlist Transferlist --help
Usage: lorentz-contract-transferlist Transferlist COMMAND
  Transferlist contract CLI interface

Available options:
  -h,--help                Show this help text

Available commands:
  print                    Dump the Transferlist contract in form of Michelson code
  init                     Initial storage for the (wrapped) Transferlist contract:
                           pass 'initialWrappedStorage' for the wrapped version
  assertTransfer           Generate the parameter for the Transferlist contract:
                           AssertTransfer
  SetIssuer                Generate the (wrapped) parameter for the Transferlist
                           contract: SetIssuer
  AddUser                  Generate the (wrapped) parameter for the Transferlist
                           contract: AddUser
  SetTransferlistOutbound     Generate the (wrapped) parameter for the Transferlist
                           contract: SetTransferlistOutbound
  SetAdmin                 Generate the (wrapped) parameter for the Transferlist
                           contract: SetAdmin
  GetIssuer                Generate the (wrapped) parameter for the Transferlist
                           contract: GetIssuer
  GetUser                  Generate the (wrapped) parameter for the Transferlist
                           contract: GetUser
  GetTransferlist             Generate the (wrapped) parameter for the Transferlist
                           contract: GetTransferlist
  GetAdmin                 Generate the (wrapped) parameter for the Transferlist
                           contract: GetAdmin
  WrappedParam             Generate a wrapped parameter for the Transferlist
                           contract, given the original contract's parameter

Standalone Transferlist Contract

An example initial storage:

❯❯❯ stack exec -- lorentz-contract-transferlist Transferlist init --issuer "\"$ALICE_ADDRESS\"" \
  --transferlists "[]" \
  --users "[]" \
  --admin "\"$ALICE_ADDRESS\"" \
  --initialStorageType 'address'

Pair (Pair "tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr" { }) (Pair { } "tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr")

To originate the contract:

$ tezos-client --wait none originate contract Transferlist \
  transferring 0 from $ALICE_ADDRESS running \
  "$(cat contracts/address_transferlist.tz)" \
  --init "$(stack exec -- lorentz-contract-transferlist Transferlist init --issuer "\"$ALICE_ADDRESS\"" \
  --transferlists "[]" \
  --users "[]" \
  --admin "\"$ALICE_ADDRESS\"" \
  --initialStorageType 'address')" --burn-cap 2.868

Waiting for the node to be bootstrapped before injection...
Current head: BKj8GASFzkn3 (timestamp: 2020-04-13T19:57:21-00:00, validation: 2020-04-13T19:57:37-00:00)
Node is bootstrapped, ready for injecting operations.
Estimated gas: 77578 units (will add 100 for safety)
Estimated storage: 2868 bytes added (will add 20 for safety)
Operation successfully injected in the node.
Operation hash is 'ooxGu3cE8irRMcvwSwDUNqMKQkyQBuom6Swh1jikznrBisLqVzA'
NOT waiting for the operation to be included.
Use command
  tezos-client wait for ooxGu3cE8irRMcvwSwDUNqMKQkyQBuom6Swh1jikznrBisLqVzA to be included --confirmations 30 --branch BKj8GASFzkn37cVU92mLmMhjLTQwfQpPjQnGTBwNpeSqWiuVYAm
and/or an external block explorer to make sure that it has been included.
This sequence of operations was run:
  Manager signed operations:
    From: tz1bDCu64RmcpWahdn9bWrDMi6cu7mXZynHm
    Fee to the baker: ꜩ0.010575
    Expected counter: 623948
    Gas limit: 77678
    Storage limit: 2888 bytes
    Balance updates:
      tz1bDCu64RmcpWahdn9bWrDMi6cu7mXZynHm ............. -ꜩ0.010575
      fees(tz1Ke2h7sDdakHJQh8WX4Z372du1KChsksyU,166) ... +ꜩ0.010575
    Origination:
      From: tz1bDCu64RmcpWahdn9bWrDMi6cu7mXZynHm
      Credit: ꜩ0
      Script:
        { ... }
        Initial storage:
          (Pair (Pair "tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr" {})
                (Pair {} "tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr"))
        No delegate for this contract
        This origination was successfully applied
        Originated contracts:
          KT1EYLosB86x6fExJutPA8wDKHqs1NgkHz4P
        Storage size: 2611 bytes
        Updated big_maps:
          New map(1142) of type (big_map nat (pair bool (set nat)))
          New map(1141) of type (big_map address nat)
        Paid storage size diff: 2611 bytes
        Consumed gas: 77578
        Balance updates:
          tz1bDCu64RmcpWahdn9bWrDMi6cu7mXZynHm ... -ꜩ2.611
          tz1bDCu64RmcpWahdn9bWrDMi6cu7mXZynHm ... -ꜩ0.257

New contract KT1EYLosB86x6fExJutPA8wDKHqs1NgkHz4P originated.
Contract memorized as Transferlist.

Originating the Transferlisted FA1.2 contract

The CLI interface for the Transferlisted FA1.2 a.k.a. TransferlistManagedLedger only includes the print command:

❯❯❯ ./stack exec -- lorentz-contract-transferlist TransferlistManagedLedger --help

Usage: lorentz-contract-transferlist TransferlistManagedLedger COMMAND
  Transferlist Wrapped ManagedLedger contract CLI interface

Available options:
  -h,--help                Show this help text

Available commands:
  print                    Dump the Oracle contract in form of Michelson code
  init                     Initial storage for the Transferlist Wrapped
                           ManagedLedger contract

Printing the Transferlisted FA1.2 contract

The print command only has arguments to output to a file or print on one line:

❯❯❯ ./stack exec -- lorentz-contract-transferlist TransferlistManagedLedger print --help

Usage: lorentz-contract-transferlist TransferlistManagedLedger print [-o|--output FILEPATH]
                                                               [--oneline]
  Dump the Oracle contract in form of Michelson code

Available options:
  -h,--help                Show this help text
  -o,--output FILEPATH     File to use as output. If not specified, stdout is
                           used.
  --oneline                Force single line output
  -h,--help                Show this help text

Initial storage

We can use the init command from the TransferlistManagedLedger part to generate the initial storage:

❯❯❯ ./stack exec -- lorentz-contract-transferlist TransferlistManagedLedger init --help

Usage: lorentz-contract-transferlist TransferlistManagedLedger init --issuer ADDRESS
                                                              --users User Transferlists
                                                              --transferlists Transferlists and their allowed outbound Transferlists
                                                              --admin ADDRESS
                                                              --managedLedgerAdmin ADDRESS
                                                              --balances [(ADDRESS, NATURAL)]
  Initial storage for the Transferlist Wrapped ManagedLedger contract

Available options:
  -h,--help                Show this help text
  --issuer ADDRESS         Address of the issuer.
  --users User Transferlists  User Transferlists: User, Transferlist ID or Nothing
  --transferlists Transferlists and their allowed outbound Transferlists
                           Transferlists: Transferlist ID, Restricted, Allowed
                           outbound Transferlist IDs
  --admin ADDRESS          Address of the admin.
  --managedLedgerAdmin ADDRESS
                           Address of the managedLedgerAdmin.
  --balances [(ADDRESS, NATURAL)]
                           The initial balances
  -h,--help                Show this help text

We'll need to set:

  • issuer: A privledged address that may transfer without restrictions
  • users: A map of user addresses to transferlist ID's
  • transferlists: A map from transferlist ID's to (restricted :: Bool, outboundAllowedTransferlists :: [TransferlistId])
  • admin: the transferlist admin, that can change the issuer and update the transferlists
  • managedLedgerAdmin: the admin of the ManagedLedger part, who can mint/burn/pause
  • balances: the initial balances

For testing purposes, we'll set the issuer to a contract that won't be able to send operations, an already-originated FA1.2 on babylonnet: KT1RUhPAABRhZBctcsWFtymyjpuBQdLTqaAQ

❯❯❯ FA12_ADDRESS="KT1RUhPAABRhZBctcsWFtymyjpuBQdLTqaAQ"

  --issuer $FA12_ADDRESS

We'll leave the transferlists, users and balances initially empty:

  --transferlists ""
  --users ""
  --balances "[]"

Finally, we'll make alice both the transferlist admin and the managedLedgerAdmin:

  --admin $ALICE_ADDRESS
  --managedLedgerAdmin $ALICE_ADDRESS
❯❯❯ ./stack exec -- lorentz-contract-transferlist TransferlistManagedLedger init \
  --issuer $FA12_ADDRESS \
  --transferlists "" \
  --users "" \
  --balances "[]" \
  --admin $ALICE_ADDRESS \
  --managedLedgerAdmin $ALICE_ADDRESS

Pair (Pair { } (Pair "tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr" (Pair False 0))) (Pair (Pair "KT1RUhPAABRhZBctcsWFtymyjpuBQdLTqaAQ" { }) (Pair { } "tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr"))

Running the origination

❯❯❯ alpha-client --wait none originate contract TransferlistedManagedLedger \
  transferring 0 from $ALICE_ADDRESS running \
  "$(./stack exec -- lorentz-contract-transferlist TransferlistManagedLedger print \
  --oneline)" \
  --init "$(./stack exec -- lorentz-contract-Transferlist TransferlistManagedLedger init \
  --issuer $FA12_ADDRESS \
  --transferlists "" \
  --users "" \
  --balances "[]" \
  --admin $ALICE_ADDRESS \
  --managedLedgerAdmin $ALICE_ADDRESS)" --burn-cap 10.364 

Waiting for the node to be bootstrapped before injection...
Current head: BLm8QfzXh5mw (timestamp: 2020-01-02T23:16:18-00:00, validation: 2020-01-02T23:16:22-00:00)
Node is bootstrapped, ready for injecting operations.
Estimated gas: 302470 units (will add 100 for safety)
Estimated storage: 10364 bytes added (will add 20 for safety)
Operation successfully injected in the node.
Operation hash is 'ooGzhDKyYqJrFAXyRpo6TbpgBFd3t9r5jfxtWUQFSDsvovGaXWP'
NOT waiting for the operation to be included.
Use command
  tezos-client wait for ooGzhDKyYqJrFAXyRpo6TbpgBFd3t9r5jfxtWUQFSDsvovGaXWP to be included --confirmations 30 --branch BLm8QfzXh5mwW44YwUsQYnk9v2P5uAHsjEhSV5KABgoyGBWBxjr
and/or an external block explorer to make sure that it has been included.
This sequence of operations was run:
  Manager signed operations:
    From: tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr
    Fee to the baker: ꜩ0.040544
    Expected counter: 61021
    Gas limit: 302570
    Storage limit: 10384 bytes
    Balance updates:
      tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr ............ -ꜩ0.040544
      fees(tz1Ke2h7sDdakHJQh8WX4Z372du1KChsksyU,87) ... +ꜩ0.040544
    Origination:
      From: tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr
      Credit: ꜩ0
      Script:
        { parameter
            (or (or (or (or (pair address (pair address nat)) (pair address nat))
                        (or (pair (pair address address) (contract nat))
                            (or (pair address (contract nat)) (pair unit (contract nat)))))
                    (or (or bool address)
                        (or (pair unit (contract address)) (or (pair address nat) (pair address nat)))))
                (or (or (or address (pair address (option nat)))
                        (or (pair nat (option (pair bool (set nat)))) address))
                    (or (or (pair unit (contract address)) (pair address (contract (option nat))))
                        (or (pair nat (contract (option (pair bool (set nat))))) (pair unit (contract address)))))) ;
          storage
            (pair (pair (big_map address (pair nat (map address nat))) (pair address (pair bool nat)))
                  (pair (pair address (big_map address nat))
                        (pair (big_map nat (pair bool (set nat))) address))) ;
          code { DUP ;
                 CAR ;
                 ..
                     DIP { PAIR } ;
                     PAIR } } }
        Initial storage:
          (Pair (Pair {} (Pair "tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr" (Pair False 0)))
                (Pair (Pair "KT1RUhPAABRhZBctcsWFtymyjpuBQdLTqaAQ" {})
                      (Pair {} "tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr")))
        No delegate for this contract
        This origination was successfully applied
        Originated contracts:
          KT1BddbuJHr85iomhaoxxwEEy2o38TdZ1rQS
        Storage size: 10107 bytes
        Updated big_maps:
          New map(1213) of type (big_map nat (pair bool (set nat)))
          New map(1212) of type (big_map address nat)
          New map(1211) of type (big_map address (pair nat (map address nat)))
        Paid storage size diff: 10107 bytes
        Consumed gas: 302470
        Balance updates:
          tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr ... -ꜩ10.107
          tz1R3vJ5TV8Y5pVj8dicBR23Zv8JArusDkYr ... -ꜩ0.257

New contract KT1BddbuJHr85iomhaoxxwEEy2o38TdZ1rQS originated.
Contract memorized as TransferlistedManagedLedger.

Set a bash alias for the address:

❯❯❯ TRANSFERLISTED_FA12="KT1BddbuJHr85iomhaoxxwEEy2o38TdZ1rQS"

As mentioned before, the polymorhic Transferlist part is used for all but printing and initializing the TransferlistManagedLedger contract.

❯❯❯ alpha-client --wait none transfer 0 from $ALICE_ADDRESS to $ORACLE_ADDRESS \
  --arg "$(./stack exec -- lorentz-contract-oracle Oracle get-value \
  --callbackContract $NAT_STORAGE_ADDRESS)" --burn-cap 0.000001

About

Transfer whitelisting as an isolated contract or a contract wrapper

Resources

Readme

License

BSD-3-Clause license
Activity
Custom properties

Stars

3 stars

Watchers

4 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Languages