feat: internal NPM publishing (#243)

* chore: setting up for internal NPM publishing

* fix: install step

* refactor: publish sdk workflow

* refactor: packages naming temporary for internal publishing

* refactor: sequential publishing due to package dependencies

* refactor: nodes client import

* refactor: nodes client import

* fix: network dependency in core

* chore: idea ide settings

* feat: added tests on internal publishing pipeline

---------

Co-authored-by: Piero Bassa <pierobassa222@gmail.com>

Author: darrenvechain

.github/workflows/publish-sdk.yml

@@ -0,0 +1,50 @@
+name: Publish NPM package
+
+on:
+    push:
+        tags:
+            - '*'
+
+permissions:
+    contents: read
+    packages: write
+
+jobs:
+    publish:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+            - uses: actions/setup-node@v3
+              with:
+                  node-version-file: .nvmrc
+                  registry-url: 'https://npm.pkg.github.com/'
+            - run: yarn install
+
+            - run: yarn build
+
+            - name: Run Unit & Integration tests
+              run: yarn test
+
+            - name: Publish errors
+              run: |
+                  cd packages/errors
+                  yarn version --no-git-tag-version --new-version ${{ github.ref_name }}
+                  yarn publish
+              env:
+                  NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
+
+            - name: Publish core
+              run: |
+                  cd packages/core
+                  yarn version --no-git-tag-version --new-version ${{ github.ref_name }}
+                  yarn publish
+              env:
+                  NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
+                  
+            - name: Publish network
+              run: |
+                  cd packages/network
+                  yarn version --no-git-tag-version --new-version ${{ github.ref_name }}
+                  yarn publish
+              env:
+                  NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

.gitignore

@@ -19,4 +19,7 @@ junit.xml
 
 # docs
 docs/build/*.md
-api-docs/
+api-docs/
+
+# IDE
+.idea

apps/sdk-user/package.json

@@ -7,7 +7,7 @@
         "build": "rm -rf ./dist && tsup src/index.ts --format cjs,esm --dts"
     },
     "dependencies": {
-        "@vechain-sdk/core": "*",
+        "@vechainfoundation/vechain-sdk-core": "*",
         "typescript": "^5.2.2"
     }
 }

apps/sdk-user/src/index.ts

@@ -1,4 +1,4 @@
-import { core, mnemonic } from '@vechain-sdk/core';
+import { core, mnemonic } from '@vechainfoundation/vechain-sdk-core';
 
 const phrase = mnemonic.generate();
 console.log(phrase);

docs/accounts.md

@@ -13,7 +13,7 @@ Mnemonics represent a standard human-readable approach to generate private keys.
 ### BIP-39
 
 ```typescript { name=bip39, category=example }
-import { mnemonic } from '@vechain-sdk/core';
+import { mnemonic } from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 // Generate BIP39 mnemonic words, default to 12 words(128bit strength)
@@ -35,7 +35,7 @@ expect(ok).toBeTruthy();
 ### BIP-32
 
 ```typescript { name=bip32, category=example }
-import { mnemonic, HDNode } from '@vechain-sdk/core';
+import { mnemonic, HDNode } from '@vechainfoundation/vechain-sdk-core';
 
 // Generate BIP39 mnemonic words, default to 12 words(128bit strength)
 const rndMnemonic = mnemonic.generate();
@@ -60,7 +60,7 @@ for (let i = 0; i < 5; i++) {
 ### From Public Key
 
 ```typescript { name=pubkey, category=example }
-import { HDNode } from '@vechain-sdk/core';
+import { HDNode } from '@vechainfoundation/vechain-sdk-core';
 
 // Create HD node from xpub
 const xpub = Buffer.from(
@@ -94,7 +94,7 @@ On the other hand, Keystore is employed for encrypting private keys in accordanc
 Through the use of mnemonics and keystore, Vechain SDK ensures secure and user-friendly account handling. Mnemonics allow for easy generation of private keys, while keystore provides an additional layer of protection by encrypting the private keys in a standardized manner as per Ethereum's security practices. These functionalities collectively contribute to a robust and secure approach to managing accounts within the Thor ecosystem.
 
 ```typescript { name=keystore, category=example }
-import { keystore, secp256k1 } from '@vechain-sdk/core';
+import { keystore, secp256k1 } from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 async function example(): Promise<void> {

docs/bloom-filter.md

@@ -25,7 +25,7 @@ It is important to emphasise that the bloom filter's design is intentionally eng
 By employing bloom filters in this manner, the VechainThor blockchain significantly reduces the computational burden associated with address and block lookup operations, resulting in improved responsiveness and heightened scalability. This, in turn, positively impacts the overall user experience and facilitates seamless integration with various applications and services built on the blockchain platform.
 
 ```typescript { name=bloom, category=example }
-import { bloom } from '@vechain-sdk/core';
+import { bloom } from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 // Get best value of k (bits per key)

docs/certificates.md

@@ -40,7 +40,7 @@ import {
     secp256k1,
     blake2b256,
     addressUtils
-} from '@vechain-sdk/core';
+} from '@vechainfoundation/vechain-sdk-core';
 
 // In this example we create a certificate and
 // sign it, and then call verify to verify the signature

docs/contracts.md

@@ -7,7 +7,7 @@
 This example showcases the process of building a smart contract transaction using the Vechain SDK.
 
 ```typescript { name=contract-deploy, category=example }
-import { buildDeployContractTransaction } from '@vechain-sdk/core';
+import { buildDeployContractTransaction } from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 const contractBytecode =
@@ -20,7 +20,7 @@ expect(transaction.body.clauses[0].data).toEqual(contractBytecode);
 
 ### Code Explanation
 
--   The `buildDeployContractTransaction` function from `@vechain-sdk/core` is employed to construct a deploy contract transaction.
+-   The `buildDeployContractTransaction` function from `@vechainfoundation/vechain-sdk-core` is employed to construct a deploy contract transaction.
 
 -   The smart contract bytecode is represented by the `contractBytecode` variable.
 
@@ -37,7 +37,7 @@ This example provides a practical demonstration of utilizing the Vechain SDK to
 This example demonstrates the process of building a transaction to call a function on a deployed smart contract using the Vechain SDK.
 
 ```typescript { name=contract-function-call, category=example }
-import { networkInfo, buildCallContractTransaction } from '@vechain-sdk/core';
+import { networkInfo, buildCallContractTransaction } from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 const contractABI = JSON.stringify([
@@ -100,7 +100,7 @@ expect(transaction.body.gasPriceCoef).toBeDefined();
 
 -   The example involves a smart contract with an ABI (Application Binary Interface) defined in JSON format. The ABI describes the functions and their parameters in the contract.
 
--   The `buildCallContractTransaction` function from `@vechain-sdk/core` is used to create a transaction for calling a specific function on the smart contract.
+-   The `buildCallContractTransaction` function from `@vechainfoundation/vechain-sdk-core` is used to create a transaction for calling a specific function on the smart contract.
 
 -   The function `setValue` is called with an argument of 123, representing the value to be set in the smart contract.
 

docs/cryptography.md

@@ -15,7 +15,7 @@ vechain sdk supports blake2b256 and keccak256 hash functions.
 Blake2b256 is a specific type of hash function known for its speed and security. It takes any input data and generates a 256-bit (32-byte) hash value. The blake2b256 part refers to the specific design of the algorithm, and the 256 indicates the length of the resulting hash code. Blake2b256 is widely used in cryptographic applications, blockchain technologies, and secure data storage.
 
 ```typescript { name=blake2b256, category=example }
-import { blake2b256, type HashInput } from '@vechain-sdk/core';
+import { blake2b256, type HashInput } from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 const toHash: HashInput = 'hello world';
@@ -31,7 +31,7 @@ expect(hash.toString('hex')).toBe(
 Keccak256 is another type of hash function, and it's particularly well-known for its use in the blockchain world, specifically in cryptocurrencies like Ethereum. Similar to Blake2b256, Keccak256 also takes input data and generates a 256-bit (32-byte) hash value. The Keccak part refers to the family of algorithms, and again, 256 denotes the length of the output hash code.
 
 ```typescript { name=keccak256, category=example }
-import { keccak256, type HashInput } from '@vechain-sdk/core';
+import { keccak256, type HashInput } from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 const toHash: HashInput = 'hello world';
@@ -60,7 +60,7 @@ import {
     secp256k1,
     addressUtils,
     type HashInput
-} from '@vechain-sdk/core';
+} from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 // Generate a private key

docs/encoding.md

@@ -11,7 +11,7 @@ Vechain SDK extends its support to handle both Application Binary Interface (ABI
 Vechain SDK provides functionality to interact with smart contracts on the VechainThor blockchain using ABI's. An ABI is a standardised interface format that defines the method signatures, input parameters, and output types of smart contract functions. With Vechain SDK, developers can conveniently encode and decode data for interacting with smart contracts, making it easier to call contract functions and process their results.
 
 ```typescript { name=abi, category=example }
-import { abi } from '@vechain-sdk/core';
+import { abi } from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 // Create a new function
@@ -61,7 +61,7 @@ expect(data).toBe(expected);
 The contract interface is used to provide a higher level of abstraction to allow direct interaction with a smart contract. To create a contract interface is necessary to have a compatible smart contract ABI. Vechain SDK provides a full implementation of the Contract interface as well as some methods to encode directly a specific fragment of the smart contract (until now only functions and events fragments are supported). Encoding and decoding are based on the ABI one.
 
 ```typescript { name=contract, category=example }
-import { contract } from '@vechain-sdk/core';
+import { contract } from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 const contractABI = JSON.stringify([
@@ -114,7 +114,7 @@ RLP is a serialisation technique used on the VechainThor blockchain. It is used
 By supporting ABI and RLP encoding handling, Vechain SDK equips developers with the necessary tools to interact with smart contracts and handle data efficiently on the VechainThor blockchain. This further enhances the library's capabilities and contributes to the seamless development of decentralised applications on the platform.
 
 ```typescript { name=rlp, category=example }
-import { RLP } from '@vechain-sdk/core';
+import { RLP } from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 // Define the profile for tx clause structure

docs/examples/accounts/bip32.ts

@@ -1,4 +1,4 @@
-import { mnemonic, HDNode } from '@vechain-sdk/core';
+import { mnemonic, HDNode } from '@vechainfoundation/vechain-sdk-core';
 
 // Generate BIP39 mnemonic words, default to 12 words(128bit strength)
 const rndMnemonic = mnemonic.generate();

docs/examples/accounts/bip39.ts

@@ -1,4 +1,4 @@
-import { mnemonic } from '@vechain-sdk/core';
+import { mnemonic } from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 // Generate BIP39 mnemonic words, default to 12 words(128bit strength)

docs/examples/accounts/keystore.ts

@@ -1,4 +1,4 @@
-import { keystore, secp256k1 } from '@vechain-sdk/core';
+import { keystore, secp256k1 } from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 async function example(): Promise<void> {

docs/examples/accounts/pubkey.ts

@@ -1,4 +1,4 @@
-import { HDNode } from '@vechain-sdk/core';
+import { HDNode } from '@vechainfoundation/vechain-sdk-core';
 
 // Create HD node from xpub
 const xpub = Buffer.from(

docs/examples/bloom/bloom.ts

@@ -1,4 +1,4 @@
-import { bloom } from '@vechain-sdk/core';
+import { bloom } from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 // Get best value of k (bits per key)

docs/examples/certificates/sign_verify.ts

@@ -4,7 +4,7 @@ import {
     secp256k1,
     blake2b256,
     addressUtils
-} from '@vechain-sdk/core';
+} from '@vechainfoundation/vechain-sdk-core';
 
 // In this example we create a certificate and
 // sign it, and then call verify to verify the signature

docs/examples/contracts/contract-deploy.ts

@@ -1,4 +1,4 @@
-import { buildDeployContractTransaction } from '@vechain-sdk/core';
+import { buildDeployContractTransaction } from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 const contractBytecode =

docs/examples/contracts/contract-function-call.ts

@@ -1,4 +1,4 @@
-import { networkInfo, buildCallContractTransaction } from '@vechain-sdk/core';
+import { networkInfo, buildCallContractTransaction } from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 const contractABI = JSON.stringify([

docs/examples/cryptography/blake2b256.ts

@@ -1,4 +1,4 @@
-import { blake2b256, type HashInput } from '@vechain-sdk/core';
+import { blake2b256, type HashInput } from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 const toHash: HashInput = 'hello world';

docs/examples/cryptography/keccak256.ts

@@ -1,4 +1,4 @@
-import { keccak256, type HashInput } from '@vechain-sdk/core';
+import { keccak256, type HashInput } from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 const toHash: HashInput = 'hello world';

docs/examples/cryptography/secp256k1.ts

@@ -3,7 +3,7 @@ import {
     secp256k1,
     addressUtils,
     type HashInput
-} from '@vechain-sdk/core';
+} from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 // Generate a private key

docs/examples/encoding/abi.ts

@@ -1,4 +1,4 @@
-import { abi } from '@vechain-sdk/core';
+import { abi } from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 // Create a new function

docs/examples/encoding/contract.ts

@@ -1,4 +1,4 @@
-import { contract } from '@vechain-sdk/core';
+import { contract } from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 const contractABI = JSON.stringify([

docs/examples/encoding/rlp.ts

@@ -1,4 +1,4 @@
-import { RLP } from '@vechain-sdk/core';
+import { RLP } from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 // Define the profile for tx clause structure

docs/examples/transactions/blockref_expiration.ts

@@ -7,7 +7,7 @@ import {
     type TransactionClause,
     type TransactionBody,
     unitsUtils
-} from '@vechain-sdk/core';
+} from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 // In this example a transaction is created that

docs/examples/transactions/fee_delegation.ts

@@ -1,4 +1,4 @@
-import { networkInfo } from '@vechain-sdk/core';
+import { networkInfo } from '@vechainfoundation/vechain-sdk-core';
 import {
     Transaction,
     secp256k1,
@@ -9,7 +9,7 @@ import {
     type TransactionBody,
     mnemonic,
     unitsUtils
-} from '@vechain-sdk/core';
+} from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 // In this example a fee delegated transaction is

docs/examples/transactions/multiple_clauses.ts

@@ -1,4 +1,4 @@
-import { networkInfo } from '@vechain-sdk/core';
+import { networkInfo } from '@vechainfoundation/vechain-sdk-core';
 import {
     Transaction,
     secp256k1,
@@ -7,7 +7,7 @@ import {
     type TransactionClause,
     type TransactionBody,
     unitsUtils
-} from '@vechain-sdk/core';
+} from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 // In this example a multiple clause transaction is

docs/examples/transactions/sign_decode.ts

@@ -1,4 +1,4 @@
-import { networkInfo } from '@vechain-sdk/core';
+import { networkInfo } from '@vechainfoundation/vechain-sdk-core';
 import {
     Transaction,
     secp256k1,
@@ -7,7 +7,7 @@ import {
     type TransactionClause,
     type TransactionBody,
     unitsUtils
-} from '@vechain-sdk/core';
+} from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 // In this example a simple single clause transaction is

docs/examples/transactions/tx_dependency.ts

@@ -1,4 +1,4 @@
-import { networkInfo } from '@vechain-sdk/core';
+import { networkInfo } from '@vechainfoundation/vechain-sdk-core';
 import {
     Transaction,
     secp256k1,
@@ -7,7 +7,7 @@ import {
     type TransactionClause,
     type TransactionBody,
     unitsUtils
-} from '@vechain-sdk/core';
+} from '@vechainfoundation/vechain-sdk-core';
 import { expect } from 'expect';
 
 // In this example transaction A is created with no dependencies

docs/package.json

@@ -8,7 +8,7 @@
     "build": "find . -name \"*.md\" -type f -maxdepth 1 ! -name \"README.md\" -delete && tsup builddocs.ts && node dist/builddocs.cjs"
   },
   "dependencies": {
-    "@vechain-sdk/core": "*",
+    "@vechainfoundation/vechain-sdk-core": "*",
     "typescript": "^5.2.2"
   },
   "devDependencies": {