2.2.3. Deploy mijin on an existing VPC

This chapter shows how to deploy mijin Catapult(v.2) on an existing network (VPC).
In the commercial version, you can flexibly build a network that fits your environment by changing parameters.
creation-day:

Aug. 1, 2022

update date:

2025/6/10

2.2.3.1. List of services to be built on AWS by deployment

  • Amazon EC2 (APINode x 2 PEERNode x 3~)

  • Amazon EBS

  • Elastic Load Balancing

  • Amazon Route53

  • parameter store

Note

Elastic Load Balancing may not be created in some cases, depending on the parameter settings specified during deployment.

2.2.3.2. Creation of subnets for existing VPCs

In deploying mijin, two subnets, one for the Public network and one for the Private network, are required to achieve high availability.
If the number of subnets is not sufficient, please refer to the following for creation.

<https://docs.aws.amazon.com/ja_jp/vpc/latest/userguide/working-with-subnets.html#create-subnets>

Note

Create two subnets of multiple availability zones (AZs) so that service can continue even if one AZ fails.

2.2.3.3. View Network

For existing networks, it is possible to build on an already existing environment by changing parameters. An example pattern is shown below.

API/PEERネットワーク構成一覧

No

load balancer

API node placement

PEER node placement

figure

1
あり（公開ネットワーク）
VPC: Your vpc
VpcCidrBlock: xx.xx.xx.xx/xx
Public1/2, Private1/2
UseLoadBalancer: Yes
LoadBalancerType: external
public NW
ApiPlacementNetwork: Public

Private NW

 ../../_images/view_network_2_1.png

2
あり（非公開ネットワーク）
UseLoadBalancer: Yes
LoadBalancerType: internal
Private NW
ApiPlacementNetwork: Private

Private NW

 ../../_images/view_network_2_2.png

3
No
UseLoadBalancer: No
LoadBalancerType は設定効果なし
public NW
ApiPlacementNetwork: Public

Private NW

 ../../_images/view_network_2_3.png

4
No
UseLoadBalancer: No
LoadBalancerType は設定効果なし
Private NW
ApiPlacementNetwork: Private

Private NW

 ../../_images/view_network_2_4.png

Note

The commercial version cannot be configured with a single AZ to achieve high availability, but only with multiple AZs.
Note that you will always need two public networks and two private networks.
Deployment is single region, but can be deployed in each of the world’s 21 regions.

2.2.3.4. Step.1

../../_images/step1_1.png

you need to subscribe to use the AMI of mijin Catapult Enterprise. Please press the button in the red frame.

2.2.3.5. Step.2

../../_images/step2_1.png

mijin Catapult Enterprise AMI, please approve its use.

2.2.3.6. Step.3

../../_images/step3_1.png

To start from Config, click on the text in the red box.

2.2.3.7. Step.4

../../_images/step4_1_ext.png

Select the template to be used in the red frame in (1). In this case, we specify ‘mijin Catapult Enterprise on Existing VPC CFT’ because it will be created on an existing network. Specify the version of mijin in the red frame in ②. Specify the region where mijin will be deployed. Click ‘Continue to Launch’ in the red frame of ④.

2.2.3.8. Step.5

../../_images/step5_1_ext.png

In the red frame in (1), specify the service for which mijin is to be built. In this case, ‘Launch CloudFormation’ is specified. Click ‘Launch’ in the red frame in ②.

2.2.3.9. Step.6

../../_images/step6_1.png

Without editing anything in particular, press ‘Next’ in the red frame.

2.2.3.10. Step.7

../../_images/step7_1_exist_1.png ../../_images/step7_1_exist_2.png

Enter parameters.

CloudFormation Parameter List

No

Parameter

Describe

Recommended value

①

Stack Name

Provide the name in this stack.

②

Service Name
Provide the name of the service created by the stack.
Used as a crown name for all resources.

③

VPC

Please specify your VPC.

④

VpcCidrBlock
Please list the IP address range of the VPC specified in (3). (CIDR Block)
The IP address range in () selected in (3) is fine.

⑤

Public1

Specify the public network in the VPC specified in (3).

⑥

Public2
Specify the public network in the VPC specified in (3).
⑤と別のネットワークを指定する必要があります。

⑦

Private1

Specify the private network in the VPC specified in (3).

⑧

Private2
Specify the private network in the VPC specified in (3).
⑦とは別のネットワークを指定する必要があります。

⑨

InternalDomainName
List the DNS name for name resolution to be used between nodes.
非公開ネットワーク用で、公開はされません。
複数スタック構築時には一意にしてください。

mijin.internal

⑩

Public Location IP
Specify the IP address that is allowed to connect to mijin Catapult’s API.
IPレンジ指定可 (/24など)

XX.XX.XX.XX/32 etc.

⑪

Default UnixUser

作成するEC2の標準Unixユーザー

ubuntu

⑫

KeyName
EC2のSSH鍵を指定してください。
表示されない場合は事前作成が必要です。
こちら

⑬

ApiPlacementNetwork

APIノードの配置ネットワークを選択してください。

⑭

ApiInstanceType
APIノードのインスタンスタイプ
Architecture and Specification Requirements 参照

c5n.2xlarge以上

⑮

ApiRootVolumeSize
APIノードのルートディスクサイズ(GB)
DockerログやSystem logに使用

30GB or more

⑯

ApiBlockVolumeSize
mijinブロックデータ格納用ディスクサイズ(GB)
Use gp3 disk

500GB or more

⑰

ApiBlockVolumeIops

IOPS for mijin block data

Over 3000

⑱

ApiMongoVolumeSize
Disk size for mongo data storage (GB)
For Blockchain data call

300GB or more

⑲

ApiMongoVolumeIops

IOPS for mongo data

3000 IOPS or more

⑳

PeerNumberOfUnits

PEERノードの台数

3 or more

㉑

PeerInstanceType
Instance type of PEER node
Architecture and Specification Requirements 参照

c5n.xlarge以上

㉒

PeerRootVolumeSize
PEER node root disk size (GB)
DockerログやSystem logに使用

30GB or more

㉓

PeerBlockVolumeSize

Disk size for PEER node block data storage

500GB or more

㉔

PeerBlockVolumeIops

IOPS for block data in PEER node

3000 IOPS or more

㉕

CatapultVersion

mijinのバージョン

v10038

㉖

CatapultShareMode
Specify where to save block generation information
Currently fixed to AWS Systems Manager

ssm

㉗

CatapultNetwork

mijinネットワーク指定

mijin

㉘

Catapult BlockGenerationTargetTime

ブロック生成間隔

15s

㉙

CatapultEffectiveFee

手数料有無の設定

No

㉚

MaxCosignedAccount

最大署名数

25

㉛

FinalizationType

finalization system

Deterministic

㉜

MaxTransactionperBlock

1ブロックの最大トランザクション数

6000

㉝

RestThrottring

API接続数上限

30tps

㉞

UnconfirmCacheSize

Number of unauthorized transactions stored

Small

㉟

UseLoadBalancer
NLB use or not (fixed Yes for preview)

Yes

㊱

LoadBalancerType

ロードバランサー配置タイプ

External

㊲

ImageId

AMI ID (cannot be changed)

Unchangeable

㊳

MPS3BucketName

S3 bucket name (cannot be changed)

Unchangeable

㊴

MPS3BucketRegion

S3 Region (cannot be changed)

Unchangeable

㊵

MPS3KeyPrefix

S3 Key Prefix (cannot be changed)

Unchangeable

㊶

mijinStackAlreadyExist
If there are other mijin stacks, select “Yes” when recreating

No

Press ‘Next’ after completing the parameter entry.

2.2.3.11. Step.8

../../_images/step8_1.png

Without editing anything in particular, press ‘Next’ in the red frame.

2.2.3.12. Step.9

../../_images/step9_1.png

Check the two items in the red frame in ①. Click ‘Create Stack’ in the red frame in ②. If there are no errors, creation will begin.

2.2.3.13. Step.10

../../_images/step10_1.png

Confirm that Stack has started and is in ‘CREATE_IN_PROGRESS’ state. This state will take approximately 20~30 minutes.

2.2.3.14. Step.11

../../_images/step11_1.png

If the status is ‘CREATE_COMPLATE’, the creation of mijin is complete.

2.2.3.15. Step.12

../../_images/step12_1.png

Press ‘Outputs’ of the created Stack to see the created mijin configuration information.

※The table below is omitted because it is the same as the new network version.

mijin endpoints and checkpoints

mijinLBEndpoint

ロードバランサーを通した mijin の API エンドポイントです。 API ノードを負荷分散しますが、ソース IP によるスティッキーセッションが有効です。 詳細はこちら

mijinEndpoint

API endpoint for direct access to API nodes (EC2 instances). It can be connected to without a load balancer.
../../_images/chaininfo.png

chainInfo

You can check the current number of blocks in mijin. Make sure that the number of blocks is “2” or more.
../../_images/harvest_address.png

harvestAddress

A link to a currency distribution address registered in the AWS Systems Manager parameter store.
../../_images/empty_address.png

emptyAddress

A link to an unused address registered in the AWS Systems Manager parameter store.
../../_images/node_peers.png

nodePeers

mijin API からノードの接続状態を確認できます。 API ノード 1 台と設定された PEER ノード数が表示されていれば正常です。

You are now ready to use mijin Catapult. Let’s start the operation in the next section!