Rebrand for Avian

Author: cdonnachie

.github/workflows/ci-workflow.yml

@@ -4,12 +4,12 @@ on:
   workflow_dispatch:
   push:
     branches:
-    - master
-    - develop
+      - master
+      - develop
   pull_request:
     branches:
-    - master
-    - develop
+      - master
+      - develop
 
 jobs:
   job_build:
@@ -25,20 +25,20 @@ jobs:
 
       - name: Build
         run: |
-          make DEBUG=0 COIN=ravencoin && mv bin/ ravencoin-bin/
+          make DEBUG=0 COIN=avian && mv bin/ avian-bin/
           make clean
-          make DEBUG=0 COIN=ravencoin_testnet && mv bin/ ravencoin-testnet-bin/
-      - name: Upload Ravencoin app binary
+          make DEBUG=0 COIN=avian_testnet && mv bin/ avian-testnet-bin/
+      - name: Upload Avian app binary
         uses: actions/upload-artifact@v2
         with:
-          name: ravencoin-app
-          path: ravencoin-bin
+          name: avian-app
+          path: avian-bin
 
-      - name: Upload Ravencoin Testnet app binary
+      - name: Upload Avian Testnet app binary
         uses: actions/upload-artifact@v2
         with:
-          name: ravencoin-testnet-app
-          path: ravencoin-testnet-bin
+          name: avian-testnet-app
+          path: avian-testnet-bin
 
   job_unit_test:
     name: Unit test
@@ -100,8 +100,8 @@ jobs:
       - name: Download Bitcoin Testnet app binary
         uses: actions/download-artifact@v2
         with:
-          name: ravencoin-testnet-app
-          path: tests-legacy/ravencoin-testnet-bin
+          name: avian-testnet-app
+          path: tests-legacy/avian-testnet-bin
 
       - name: Run tests
         run: |

.gitignore

@@ -11,8 +11,8 @@ unit-tests/build/
 unit-tests/coverage/
 unit-tests/coverage.info
 
-tests-legacy/ravencoin-bin
-tests-legacy/ravencoin-testnet-bin
+tests-legacy/avian-bin
+tests-legacy/avian-testnet-bin
 
 # temporary folder used during tests
 tests/.test_bitcoin

Makefile

@@ -36,7 +36,7 @@ APP_STACK_SIZE = 1500
 
 # simplify for tests
 ifndef COIN
-COIN=ravencoin_testnet
+COIN=avian_testnet
 endif
 
 # Custom NanoS linking script to overlap legacy globals and new globals
@@ -56,42 +56,42 @@ APP_LOAD_FLAGS=--appFlags 0xa50
 
 # All but bitcoin app use dependency onto the bitcoin app/lib
 
-ifeq ($(COIN),ravencoin_testnet)
-# Ravencoin testnet
+ifeq ($(COIN),avian_testnet)
+# Avian testnet
 DEFINES_LIB=
 DEFINES   += BIP32_PUBKEY_VERSION=0x043587CF
 DEFINES   += BIP44_COIN_TYPE=1
 DEFINES   += BIP44_COIN_TYPE_2=1
 DEFINES   += COIN_P2PKH_VERSION=111
 DEFINES   += COIN_P2SH_VERSION=196
 DEFINES   += COIN_FAMILY=1
-DEFINES   += COIN_COINID=\"Raven\"
-DEFINES   += COIN_COINID_HEADER=\"RAVENCOIN\"
-DEFINES   += COIN_COINID_NAME=\"Ravencoin\"
-DEFINES   += COIN_COINID_SHORT=\"TRVN\"
-DEFINES   += COIN_KIND=COIN_KIND_RAVENCOIN_TESTNET
-APPNAME = "Ravencoin Test"
+DEFINES   += COIN_COINID=\"Avian\"
+DEFINES   += COIN_COINID_HEADER=\"AVIAN\"
+DEFINES   += COIN_COINID_NAME=\"Avian\"
+DEFINES   += COIN_COINID_SHORT=\"TAVN\"
+DEFINES   += COIN_KIND=COIN_KIND_Avian_TESTNET
+APPNAME = "Avian Test"
 APP_LOAD_PARAMS += --path $(APP_PATH)
 
-else ifeq ($(COIN),ravencoin)
-# Ravencoin
+else ifeq ($(COIN),avian)
+# Avian
 DEFINES_LIB=
 DEFINES   += BIP32_PUBKEY_VERSION=0x0488B21E
-DEFINES   += BIP44_COIN_TYPE=175
-DEFINES   += BIP44_COIN_TYPE_2=175
+DEFINES   += BIP44_COIN_TYPE=921
+DEFINES   += BIP44_COIN_TYPE_2=921
 DEFINES   += COIN_P2PKH_VERSION=60
 DEFINES   += COIN_P2SH_VERSION=122
 DEFINES   += COIN_FAMILY=1
-DEFINES   += COIN_COINID=\"Raven\"
-DEFINES   += COIN_COINID_HEADER=\"RAVENCOIN\"
-DEFINES   += COIN_COINID_NAME=\"Ravencoin\"
-DEFINES   += COIN_COINID_SHORT=\"RVN\"
-DEFINES   += COIN_KIND=COIN_KIND_RAVENCOIN
-APPNAME ="Ravencoin"
+DEFINES   += COIN_COINID=\"Avian\"
+DEFINES   += COIN_COINID_HEADER=\"AVIAN\"
+DEFINES   += COIN_COINID_NAME=\"Avian\"
+DEFINES   += COIN_COINID_SHORT=\"AVN\"
+DEFINES   += COIN_KIND=COIN_KIND_AVIAN
+APPNAME ="Avian"
 APP_LOAD_PARAMS += --path $(APP_PATH)
 else
 ifeq ($(filter clean,$(MAKECMDGOALS)),)
-$(error Unsupported COIN - use ravencoin_testnet, ravencoin)
+$(error Unsupported COIN - use avian_testnet, avian)
 endif
 endif
 
@@ -224,11 +224,11 @@ dep/%.d: %.c Makefile
 # Temporary restriction until we a Resistance Nano X icon
 ifeq ($(TARGET_NAME),TARGET_NANOS)
 listvariants:
-	@echo VARIANTS COIN ravencoin_testnet ravencoin
+	@echo VARIANTS COIN avian_testnet avian
 
 else
 listvariants:
-	@echo VARIANTS COIN ravencoin_testnet ravencoin
+	@echo VARIANTS COIN avian_testnet avian
 
 endif
 

bitcoin_client/ledger_bitcoin/client_legacy.py

@@ -76,7 +76,7 @@ def __init__(self, comm_client: TransportClient, chain: Chain = Chain.MAIN, debu
 
         self.app = btchip(DongleAdaptor(comm_client))
 
-        if self.app.getAppName() not in ["Ravencoin", "Ravencoin Test", "app"]:
+        if self.app.getAppName() not in ["Avian", "Avian Test", "app"]:
             raise ValueError("Ledger is not in either the Bitcoin or Bitcoin Testnet app")
 
     def get_extended_pubkey(self, path: str, display: bool = False) -> str:

doc/apdu.md

@@ -3,7 +3,7 @@ Bitcoin application : Technical Specifications
 <!-- TODO: List all the technical limitation for each command (max limits, etc.) -->
 
 ### Note
-The ravencoin app currently only supports legacy APDUs
+The avian app currently only supports legacy APDUs
 
 ## Framework
 

src/common/script.h

@@ -144,8 +144,8 @@ enum opcodetype {
     // Opcode added by BIP 342 (Tapscript)
     OP_CHECKSIGADD = 0xba,
 
-    // Ravencoin
-    OP_RVN_ASSET = 0xc0,
+    // Avian
+    OP_AVN_ASSET = 0xc0,
 
     OP_INVALIDOPCODE = 0xff,
 };

src/handler/lib/policy.c

@@ -435,7 +435,7 @@ int call_get_wallet_script(dispatcher_context_t *dispatcher_context,
     do {
         switch (state.nodes[state.node_stack_eos].policy_node->type) {
             case TOKEN_PKH:
-            /* Not yet implemented in RVN
+            /* Not yet implemented in AVN
             case TOKEN_WPKH:
             */
                 ret = process_pkh_wpkh_node(&state);

src/legacy/btchip_apdu_hash_input_finalize_full.c

@@ -64,11 +64,11 @@ static bool check_output_displayable() {
         btchip_output_script_is_op_return(btchip_context_D.currentOutput + 8);
 
     if (nullAmount) {
-        asset_ptr = btchip_output_script_get_ravencoin_asset_ptr(
+        asset_ptr = btchip_output_script_get_avian_asset_ptr(
             btchip_context_D.currentOutput + 8,
             sizeof(btchip_context_D.currentOutput) - 8
         );
-        tag_type = btchip_output_script_try_get_ravencoin_asset_tag_type(
+        tag_type = btchip_output_script_try_get_avian_asset_tag_type(
             btchip_context_D.currentOutput + 8,
             sizeof(btchip_context_D.currentOutput) - 8
         );
@@ -80,9 +80,9 @@ static bool check_output_displayable() {
         btchip_context_D.currentOutput + 8);
 
     if (asset_ptr > 0) {
-        isP2sh = btchip_output_script_is_p2sh_ravencoin_asset(btchip_context_D.currentOutput + 8);
+        isP2sh = btchip_output_script_is_p2sh_avian_asset(btchip_context_D.currentOutput + 8);
         asset_type = (btchip_context_D.currentOutput + 8)[asset_ptr];
-        invalid = !btchip_output_script_is_regular_ravencoin_asset(btchip_context_D.currentOutput + 8) && 
+        invalid = !btchip_output_script_is_regular_avian_asset(btchip_context_D.currentOutput + 8) && 
             !isP2sh && !(isOpReturn || tag_type > 0);
     }
     else {

src/legacy/btchip_display_variables.h

@@ -24,11 +24,11 @@ union display_variables {
         // of
 
         char fullAddress[65]; // the address
-        //Ravencoin: max asset length (32) + space (1) + max amt whole (11) + decimal (1) + max amt decimal (8) + \0 (1)
+        //Avian: max asset length (32) + space (1) + max amt whole (11) + decimal (1) + max amt decimal (8) + \0 (1)
         char fullAmount[54];
         char feesAmount[20];  // fees
 
-        //RVN
+        //AVN
         char ipfs[80];
         char divisions[11]; //UNCHANGED
         char reissuable[6];

src/legacy/btchip_helpers.c

@@ -35,9 +35,9 @@ const unsigned char TRANSACTION_OUTPUT_SCRIPT_P2SH_POST[] = {0x87}; // OP_EQUAL
 const unsigned char TRANSACTION_OUTPUT_SCRIPT_P2WPKH_PRE[] = {0x16, 0x00, 0x14};
 const unsigned char TRANSACTION_OUTPUT_SCRIPT_P2WSH_PRE[] = {0x22, 0x00, 0x20};
 
-//RVN
+//AVN
 
-unsigned char btchip_output_script_is_regular_ravencoin_asset(unsigned char *buffer) {
+unsigned char btchip_output_script_is_regular_avian_asset(unsigned char *buffer) {
     if ((os_memcmp(buffer + 1, TRANSACTION_OUTPUT_SCRIPT_PRE + 1,
                     sizeof(TRANSACTION_OUTPUT_SCRIPT_PRE) - 1) == 0) &&
         (os_memcmp(buffer + sizeof(TRANSACTION_OUTPUT_SCRIPT_PRE) + 20,
@@ -48,7 +48,7 @@ unsigned char btchip_output_script_is_regular_ravencoin_asset(unsigned char *buf
     return 0;
 }
 
-unsigned char btchip_output_script_is_p2sh_ravencoin_asset(unsigned char *buffer) {
+unsigned char btchip_output_script_is_p2sh_avian_asset(unsigned char *buffer) {
     if ((os_memcmp(buffer + 1, TRANSACTION_OUTPUT_SCRIPT_P2SH_PRE + 1,
                     sizeof(TRANSACTION_OUTPUT_SCRIPT_P2SH_PRE) - 1) == 0) &&
         (os_memcmp(buffer + sizeof(TRANSACTION_OUTPUT_SCRIPT_P2SH_PRE) + 20,
@@ -69,7 +69,7 @@ static bool increment_and_check_ptr(unsigned int* ptr, int amt, size_t size) {
 }
 
 //Check lengths etc.
-signed char btchip_output_script_try_get_ravencoin_asset_tag_type(unsigned char *buffer, size_t size) {
+signed char btchip_output_script_try_get_avian_asset_tag_type(unsigned char *buffer, size_t size) {
     int i;
     if (btchip_output_script_is_regular(buffer) ||
             btchip_output_script_is_p2sh(buffer) ||
@@ -124,7 +124,7 @@ signed char btchip_output_script_try_get_ravencoin_asset_tag_type(unsigned char
 }
 
 //Verify the asset portion of an asset script
-signed char btchip_output_script_get_ravencoin_asset_ptr(unsigned char *buffer, size_t size) {
+signed char btchip_output_script_get_avian_asset_ptr(unsigned char *buffer, size_t size) {
     // This method is also used in check_output_displayable and needs to ensure no overflows happen from bad scripts
     unsigned int script_ptr = 1; // The script length is a varint; always less than 0xFC -> skip first
     unsigned int final_op = buffer[0], i;
@@ -248,7 +248,7 @@ signed char btchip_output_script_get_ravencoin_asset_ptr(unsigned char *buffer,
     return script_start;
 }
 
-//END RVN
+//END AVN
 
 unsigned char btchip_output_script_is_regular(unsigned char *buffer) {
     if (G_coin_config->native_segwit_prefix) {

src/legacy/include/btchip_context.h

@@ -244,8 +244,8 @@ typedef enum btchip_coin_flags_e {
 
 
 typedef enum btchip_coin_kind_e {
-    COIN_KIND_RAVENCOIN,
-    COIN_KIND_RAVENCOIN_TESTNET
+    COIN_KIND_AVIAN,
+    COIN_KIND_AVIAN_TESTNET
 } btchip_coin_kind_t;
 
 typedef struct btchip_altcoin_config_s {

src/legacy/include/btchip_helpers.h

@@ -40,14 +40,14 @@ typedef struct {
     uint8_t associated_data_ptr;
 } asset_data_t;
 
-//RVN
+//AVN
 
-unsigned char btchip_output_script_is_regular_ravencoin_asset(unsigned char *buffer);
-unsigned char btchip_output_script_is_p2sh_ravencoin_asset(unsigned char *buffer);
-signed char btchip_output_script_try_get_ravencoin_asset_tag_type(unsigned char *buffer, size_t size);
-signed char btchip_output_script_get_ravencoin_asset_ptr(unsigned char *buffer, size_t size);
+unsigned char btchip_output_script_is_regular_avian_asset(unsigned char *buffer);
+unsigned char btchip_output_script_is_p2sh_avian_asset(unsigned char *buffer);
+signed char btchip_output_script_try_get_avian_asset_tag_type(unsigned char *buffer, size_t size);
+signed char btchip_output_script_get_avian_asset_ptr(unsigned char *buffer, size_t size);
 
-//END RVN
+//END AVN
 
 unsigned char btchip_output_script_is_regular(unsigned char *buffer);
 unsigned char btchip_output_script_is_p2sh(unsigned char *buffer);

src/legacy/main_old.c

@@ -1052,7 +1052,7 @@ void get_address_from_output_script(unsigned char* script, int script_size, char
     unsigned short version = G_coin_config->p2sh_version;
 
     //Loose check
-    if (btchip_output_script_is_regular_ravencoin_asset(script)) {
+    if (btchip_output_script_is_regular_avian_asset(script)) {
         addressOffset = 4;
         version = G_coin_config->p2pkh_version;
     }
@@ -1087,7 +1087,7 @@ uint8_t prepare_single_output() {
     btchip_swap_bytes(amount, btchip_context_D.currentOutput + offset, 8);
     offset += 8;
 
-    if ((type = btchip_output_script_try_get_ravencoin_asset_tag_type(btchip_context_D.currentOutput + offset,  sizeof(btchip_context_D.currentOutput) - offset)) >= 1) {
+    if ((type = btchip_output_script_try_get_avian_asset_tag_type(btchip_context_D.currentOutput + offset,  sizeof(btchip_context_D.currentOutput) - offset)) >= 1) {
       if (type <= 3) {
         //TODO: Switches? whats that
         if (type == 1) {
@@ -1101,7 +1101,7 @@ uint8_t prepare_single_output() {
           // Checks done in try_get_asset_tag_type, no more than 32
           str_len = (btchip_context_D.currentOutput + offset)[0];
           offset += 1;
-          // Validity of string checked in btchip_output_script_try_get_ravencoin_asset_tag_type
+          // Validity of string checked in btchip_output_script_try_get_avian_asset_tag_type
           strncpy(vars.tmp.fullAmount, (char *)(btchip_context_D.currentOutput + offset), MIN(str_len, 32));
           vars.tmp.fullAmount[str_len] = 0;
           offset += str_len;
@@ -1116,15 +1116,15 @@ uint8_t prepare_single_output() {
           offset += 4;
           str_len = (btchip_context_D.currentOutput + offset)[0];
           offset += 1;
-          // Validity of string checked in btchip_output_script_try_get_ravencoin_asset_tag_type
+          // Validity of string checked in btchip_output_script_try_get_avian_asset_tag_type
           strncpy(vars.tmp.verifier_string, (char *)btchip_context_D.currentOutput + offset, MIN(str_len, 80));
           vars.tmp.verifier_string[str_len] = 0;
           return 3;
         } else if (type == 3) {
           offset += 5;
           str_len = (btchip_context_D.currentOutput + offset)[0];
           offset += 1;
-          // Validity of string checked in btchip_output_script_try_get_ravencoin_asset_tag_type
+          // Validity of string checked in btchip_output_script_try_get_avian_asset_tag_type
           strncpy(vars.tmp.fullAmount, (char *)btchip_context_D.currentOutput + offset, MIN(str_len, 32));
           vars.tmp.fullAmount[str_len] = 0;
           offset += str_len;
@@ -1143,15 +1143,15 @@ uint8_t prepare_single_output() {
 
     // Prepare amount
 
-    asset_ptr = btchip_output_script_get_ravencoin_asset_ptr(
+    asset_ptr = btchip_output_script_get_avian_asset_ptr(
       btchip_context_D.currentOutput + offset,
       sizeof(btchip_context_D.currentOutput) - offset
     );
 
     if (asset_ptr > 0) {
       type = (btchip_context_D.currentOutput + offset)[asset_ptr++];
       str_len = (btchip_context_D.currentOutput + offset)[asset_ptr++];
-      // Asset is verified to be ascii (signed char) safe in btchip_output_script_get_ravencoin_asset_ptr
+      // Asset is verified to be ascii (signed char) safe in btchip_output_script_get_avian_asset_ptr
       memcpy((unsigned char *)vars.tmp.fullAmount, btchip_context_D.currentOutput + offset + asset_ptr, str_len);
       asset_ptr += str_len;
       vars.tmp.fullAmount[str_len] = ' ';

src/main.c

@@ -225,7 +225,7 @@ void app_main() {
 #endif
             // if not Bitcoin or Bitcoin-testnet, we only support the legacy APDUS.
             // to be removed once the apps are split
-            // TODO: Is set false for RVN, update logic?
+            // TODO: Is set false for AVN, update logic?
             if (G_coin_config->bip32_pubkey_version != 0x0488B21E &&
                 G_coin_config->bip32_pubkey_version != 0x043587CF) {
                 io_send_sw(SW_CLA_NOT_SUPPORTED);