Introduce "IssueTokensFromGarage" action

.github/workflows/deploy.yml

@@ -24,6 +24,8 @@ on:
         required: true
       KMS_KEY_ID:
         required: true
+      ADHOC_KMS_KEY_ID:
+        required: true
       GOOGLE_CREDENTIAL:
         required: true
       APPLE_CREDENTIAL:
@@ -135,6 +137,7 @@ jobs:
           ODIN_GQL_URL: ${{ vars.ODIN_GQL_URL }}
           HEIMDALL_GQL_URL: ${{ vars.HEIMDALL_GQL_URL }}
           KMS_KEY_ID: ${{ secrets.KMS_KEY_ID }}
+          ADHOC_KMS_KEY_ID: ${{ secrets.ADHOC_KMS_KEY_ID }}
           GOOGLE_CREDENTIAL: ${{ secrets.GOOGLE_CREDENTIAL }}
           GOOGLE_PACKAGE_NAME: ${{ vars.GOOGLE_PACKAGE_NAME }}
           APPLE_BUNDLE_ID: ${{ vars.APPLE_BUNDLE_ID }}
@@ -172,6 +175,7 @@ jobs:
           ODIN_GQL_URL: ${{ vars.ODIN_GQL_URL }}
           HEIMDALL_GQL_URL: ${{ vars.HEIMDALL_GQL_URL }}
           KMS_KEY_ID: ${{ secrets.KMS_KEY_ID }}
+          ADHOC_KMS_KEY_ID: ${{ secrets.ADHOC_KMS_KEY_ID }}
           GOOGLE_CREDENTIAL: ${{ secrets.GOOGLE_CREDENTIAL }}
           GOOGLE_PACKAGE_NAME: ${{ vars.GOOGLE_PACKAGE_NAME }}
           APPLE_BUNDLE_ID: ${{ vars.APPLE_BUNDLE_ID }}

.github/workflows/main.yml

@@ -43,6 +43,7 @@ jobs:
       AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
       AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
       KMS_KEY_ID: ${{ secrets.KMS_KEY_ID }}
+      ADHOC_KMS_KEY_ID: ${{ secrets.ADHOC_KMS_KEY_ID }}
       GOOGLE_CREDENTIAL: ${{ secrets.GOOGLE_CREDENTIAL }}
       APPLE_CREDENTIAL: ${{ secrets.APPLE_CREDENTIAL }}
       APPLE_KEY_ID: ${{ secrets.APPLE_KEY_ID }}
@@ -71,6 +72,7 @@ jobs:
       AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
       AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
       KMS_KEY_ID: ${{ secrets.KMS_KEY_ID }}
+      ADHOC_KMS_KEY_ID: ${{ secrets.ADHOC_KMS_KEY_ID }}
       GOOGLE_CREDENTIAL: ${{ secrets.GOOGLE_CREDENTIAL }}
       APPLE_CREDENTIAL: ${{ secrets.APPLE_CREDENTIAL }}
       APPLE_KEY_ID: ${{ secrets.APPLE_KEY_ID }}
@@ -111,6 +113,7 @@ jobs:
       AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
       AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
       KMS_KEY_ID: ${{ secrets.KMS_KEY_ID }}
+      ADHOC_KMS_KEY_ID: ${{ secrets.ADHOC_KMS_KEY_ID }}
       GOOGLE_CREDENTIAL: ${{ secrets.GOOGLE_CREDENTIAL }}
       APPLE_CREDENTIAL: ${{ secrets.APPLE_CREDENTIAL }}
       APPLE_KEY_ID: ${{ secrets.APPLE_KEY_ID }}

.github/workflows/synth.yml

@@ -18,6 +18,8 @@ on:
         required: true
       KMS_KEY_ID:
         required: true
+      ADHOC_KMS_KEY_ID:
+        required: true
       GOOGLE_CREDENTIAL:
         required: true
       APPLE_CREDENTIAL:
@@ -122,6 +124,7 @@ jobs:
           ODIN_GQL_URL: ${{ vars.ODIN_GQL_URL }}
           HEIMDALL_GQL_URL: ${{ vars.HEIMDALL_GQL_URL }}
           KMS_KEY_ID: ${{ secrets.KMS_KEY_ID }}
+          ADHOC_KMS_KEY_ID: ${{ secrets.ADHOC_KMS_KEY_ID }}
           GOOGLE_CREDENTIAL: ${{ secrets.GOOGLE_CREDENTIAL }}
           GOOGLE_PACKAGE_NAME: ${{ vars.GOOGLE_PACKAGE_NAME }}
           APPLE_BUNDLE_ID: ${{ vars.APPLE_BUNDLE_ID }}

common/__init__.py

@@ -58,6 +58,7 @@ class Config:
 
     headless: str = "http://localhost"
     kms_key_id: Optional[str] = None
+    adhoc_kms_key_id: Optional[str] = None
     golden_dust_request_sheet_id: Optional[str] = None
     golden_dust_work_sheet_id: Optional[str] = None
     form_sheet: Optional[str] = None

common/_crypto.py

@@ -144,6 +144,8 @@ def sign_tx(self, unsigned_tx: bytes) -> bytes:
         return der_encode(seq)
 
 
+
+# Deprecated
 def derive_address(address: Union[str, bytes], key: Union[str, bytes], get_byte: bool = False) -> Union[bytes, str]:
     """
     Derive given address using key.

common/consts.py

@@ -32,6 +32,17 @@
     "SOULSTONE_1004",  # Lil' Fenrir
 )
 
+ITEM_FUNGIBLE_ID_DICT = {
+    "400000": "3991e04dd808dc0bc24b21f5adb7bf1997312f8700daf1334bf34936e8a0813a",
+    "500000": "00dfffe23964af9b284d121dae476571b7836b8d9e2e5f510d92a840fecc64fe",
+    "600201": "f8faf92c9c0d0e8e06694361ea87bfc8b29a8ae8de93044b98470a57636ed0e0",
+    "600202": "08f566bb43570aad34c1790901f824dd5609db880afebd5382fcec054203d92a",
+    "600203": "",
+    "800201": "1a755098a2bc0659a063107df62e2ff9b3cdaba34d96b79519f504b996f53820",
+    "CRYSTAL": "FAV__CRYSTAL",
+    "RUNE_GOLDENLEAF": "FAV__RUNE_GOLDENLEAF",
+}
+
 GQL_DICT = {
     PlanetID.ODIN: os.environ.get("ODIN_GQL_URL"),
     PlanetID.ODIN_INTERNAL: os.environ.get("ODIN_GQL_URL"),

common/lib9c/actions/issue_tokens_from_garage.py

@@ -0,0 +1,53 @@
+from typing import List, Optional
+
+from common.lib9c.actions import ActionBase
+from common.lib9c.models.fungible_asset_value import FungibleAssetValue
+
+
+class FavIssueSpec:
+    def __init__(self, fav: FungibleAssetValue):
+        self._fav = fav
+
+    @property
+    def plain_value(self):
+        return \
+            [
+                self._fav.plain_value,
+                None  # No Item spec
+            ]
+
+
+class ItemIssueSpec:
+    def __init__(self, fungible_item_id: [str | bytes], amount: int):
+        self.item_id = fungible_item_id if isinstance(fungible_item_id, bytes) else bytes.fromhex(fungible_item_id)
+        self.amount = amount
+
+    @property
+    def plain_value(self):
+        return \
+            [
+                None,  # No FAV spec
+                [
+                    self.item_id,
+                    self.amount
+                ]
+            ]
+
+
+class IssueTokensFromGarage(ActionBase):
+    """
+    Python port of `IssueTokensFromGarage` action from lib9c
+
+    - type_id: `issue_tokens_from_garage`
+    - values: List[spec]
+      - spec: List[FavIssueSpec | ItemIssueSpec]
+    """
+    TYPE_ID: str = "issue_tokens_from_garage"
+
+    def __init__(self, *, values: List[FavIssueSpec | ItemIssueSpec], _id: Optional[str] = None):
+        super().__init__(self.TYPE_ID, _id)
+        self._values: List[FavIssueSpec | ItemIssueSpec] = values
+
+    @property
+    def _plain_value(self):
+        return [x.plain_value for x in self._values] if self._values else None

common/lib9c/exceptions.py

@@ -0,0 +1,2 @@
+class InvalidAmountException(Exception):
+    pass

common/lib9c/models/address.py

@@ -1,5 +1,10 @@
 from __future__ import annotations
 
+import hashlib
+import hmac
+
+import eth_utils
+
 
 class Address:
     def __init__(self, addr: str):
@@ -20,5 +25,46 @@ def long_format(self):
     def short_format(self):
         return self.raw.hex()
 
+    def derive(self, key: str) -> Address:
+        return Address(
+            self.__checksum_encode(hmac.new(
+                key.encode("utf-8"),
+                self.raw,
+                digestmod=hashlib.sha1
+            ).digest())
+        )
+
+    def __checksum_encode(self, addr: bytes) -> str:  # Takes a 20-byte binary address as input
+        """
+        Convert input address to checksum encoded address without prefix "0x"
+        See [ERC-55](https://eips.ethereum.org/EIPS/eip-55)
+
+        :param addr: 20-bytes binary address
+        :return: checksum encoded address as string
+        """
+        hex_addr = addr.hex()
+        checksum_buffer = ""
+
+        # Treat the hex address as ascii/utf-8 for keccak256 hashing
+        hashed_address = eth_utils.keccak(text=hex_addr).hex()
+
+        # Iterate over each character in the hex address
+        for nibble_index, character in enumerate(hex_addr):
+            if character in "0123456789":
+                # We can't upper-case the decimal digits
+                checksum_buffer += character
+            elif character in "abcdef":
+                # Check if the corresponding hex digit (nibble) in the hash is 8 or higher
+                hashed_address_nibble = int(hashed_address[nibble_index], 16)
+                if hashed_address_nibble > 7:
+                    checksum_buffer += character.upper()
+                else:
+                    checksum_buffer += character
+            else:
+                raise eth_utils.ValidationError(
+                    f"Unrecognized hex character {character!r} at position {nibble_index}"
+                )
+        return checksum_buffer
+
     def __eq__(self, other: Address):
         return self.raw == other.raw

common/shared_stack.py

@@ -94,6 +94,7 @@ def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
         # SecureStrings in Parameter Store
         PARAMETER_LIST = (
             ("KMS_KEY_ID", True),
+            ("ADHOC_KMS_KEY_ID", True),
             ("GOOGLE_CREDENTIAL", True),
             ("APPLE_CREDENTIAL", True),
             ("SEASON_PASS_JWT_SECRET", True),

common/utils/aws.py

@@ -21,10 +21,13 @@ def fetch_secrets(region: str, secret_arn: str) -> Dict:
     return json.loads(resp["SecretString"])
 
 
-def fetch_kms_key_id(stage: str, region: str) -> Optional[str]:
+def fetch_kms_key_id(stage: str, region: str, adhoc: bool = False) -> Optional[str]:
     client = boto3.client("ssm", region_name=region)
     try:
-        return client.get_parameter(Name=f"{stage}_9c_IAP_KMS_KEY_ID", WithDecryption=True)["Parameter"]["Value"]
+        return client.get_parameter(
+            Name=f"{stage}_9c_IAP{'_ADHOC' if adhoc else ''}_KMS_KEY_ID",
+            WithDecryption=True
+        )["Parameter"]["Value"]
     except Exception as e:
         logger.error(e)
         return None

tests/lib9c/actions/test_issue_tokens_from_garage.py

@@ -0,0 +1,120 @@
+from decimal import Decimal
+
+import pytest
+
+from common.lib9c.actions.issue_tokens_from_garage import IssueTokensFromGarage, FavIssueSpec, ItemIssueSpec
+from common.lib9c.models.currency import Currency
+from common.lib9c.models.fungible_asset_value import FungibleAssetValue
+
+TEST_ID = "0d0d9e0cbc1b11eeb0dc6fd71476142a"
+TEST_FUNGIBLE_ITEM_ID = "f8faf92c9c0d0e8e06694361ea87bfc8b29a8ae8de93044b98470a57636ed0e0"  # Golden Dust
+TEST_FUNGIBLE_ITEM_BINARY = b'\xf8\xfa\xf9,\x9c\r\x0e\x8e\x06iCa\xea\x87\xbf\xc8\xb2\x9a\x8a\xe8\xde\x93\x04K\x98G\nWcn\xd0\xe0'
+ACTION_TEST_DATA = [
+    (
+        {
+            "_id": TEST_ID,
+            "values": [
+                FavIssueSpec(FungibleAssetValue.from_raw_data("Crystal", 18, amount=Decimal("1000")))
+            ]
+        },
+        [
+            [
+                [
+                    {
+                        "ticker": "Crystal",
+                        "decimalPlaces": b'\x12',
+                        "minters": None,
+                    },
+                    1000 * 10 ** 18
+                ],
+                None
+            ],
+        ]
+    ),
+    (
+        {
+            "_id": TEST_ID,
+            "values": [
+                ItemIssueSpec(TEST_FUNGIBLE_ITEM_ID, 42)
+            ]
+        },
+        [
+            [
+                None,
+                [
+                    TEST_FUNGIBLE_ITEM_BINARY,
+                    42
+                ]
+            ]
+        ]
+    ),
+    (
+        {
+            "_id": TEST_ID,
+            "values": [
+                ItemIssueSpec("f8faf92c9c0d0e8e06694361ea87bfc8b29a8ae8de93044b98470a57636ed0e0", 42)
+            ]
+        },
+        [
+            [
+                None,
+                [
+                    b'\xf8\xfa\xf9,\x9c\r\x0e\x8e\x06iCa\xea\x87\xbf\xc8\xb2\x9a\x8a\xe8\xde\x93\x04K\x98G\nWcn\xd0\xe0',
+                    42
+                ]
+            ]
+        ]
+    ),
+    (
+        {
+            "_id": TEST_ID,
+            "values": [
+                FavIssueSpec(FungibleAssetValue.from_raw_data("Crystal", 18, amount=Decimal("1000"))),
+                ItemIssueSpec("f8faf92c9c0d0e8e06694361ea87bfc8b29a8ae8de93044b98470a57636ed0e0", 42)
+            ]
+        },
+        [
+            [
+                [
+                    {
+                        "ticker": "Crystal",
+                        "decimalPlaces": b'\x12',
+                        "minters": None,
+                    },
+                    1000 * 10 ** 18
+                ],
+                None
+            ],
+            [
+                None,
+                [
+                    b'\xf8\xfa\xf9,\x9c\r\x0e\x8e\x06iCa\xea\x87\xbf\xc8\xb2\x9a\x8a\xe8\xde\x93\x04K\x98G\nWcn\xd0\xe0',
+                    42
+                ]
+            ]
+        ]
+    )
+]
+
+
+def test_fav_issue_spec():
+    fav = FungibleAssetValue(Currency("Crystal", 18), Decimal(42))
+    fav_issue_spec = FavIssueSpec(fav)
+    assert fav_issue_spec.plain_value[0] == fav.plain_value
+
+
+@pytest.mark.parametrize("data", [TEST_FUNGIBLE_ITEM_ID, TEST_FUNGIBLE_ITEM_BINARY])
+def test_item_issue_spec(data):
+    item_issue_spec = ItemIssueSpec(data, 42)
+    assert item_issue_spec.plain_value == [None, [TEST_FUNGIBLE_ITEM_BINARY, 42]]
+
+
+@pytest.mark.parametrize("test_data", ACTION_TEST_DATA)
+def test_action(test_data):
+    data, expected = test_data
+    action = IssueTokensFromGarage(**data)
+    plain_value = action.plain_value
+    values = plain_value["values"]
+
+    assert plain_value["type_id"] == "issue_tokens_from_garage"
+    assert values == expected

tests/lib9c/models/test_address.py

@@ -30,3 +30,12 @@ def test_address(addr):
 def test_address_error(addr):
     with pytest.raises(ValueError) as e:
         Address(addr)
+
+
+@pytest.mark.parametrize(("key", "result"), [
+    ("key1", "0x518c0044a81c7d3747Ad416Df7227e53233F2e10"),
+    ("key2", "0xEb5cC07Eb104B082C1ae82E018340e989700ca31")
+])
+def test_address_derive(key, result):
+    addr = Address("0xa5f7e0bd63AD2749D66380f36Eb33Fe0ba50A27D")
+    assert addr.derive(key) == Address(result)