@civic/gateway-eth-cli
v0.2.5
Published
Civic Gateway Protocol EVM CLI
Downloads
8
Maintainers
Keywords
Readme
Gateway ETH CLI
CLI for the Gateway Protocol on EVM chains.
For more detail, see the Gateway Protocol
Quick Start
yarn global add @civic/gateway-eth-cli
TIP: run gateway-eth <command> -h
to see all options at any time.
TIP: The CLI uses Infura. Add an infura API key to your environment to avoid rate-limiting:
export INFURA_API_KEY=your-api-key
Add a gatekeeper
This command will add yourself as a gatekeeper to the test gatekeeper network on Sepolia, using the built-in test network authority key.
gateway-eth add-gatekeeper -c sepolia <your address>
To use a gatekeeper other than the test gatekeeper network, set the network using the -n flag.
To default to a given network, set the DEFAULT_GATEKEEPER_NETWORK
environment variable.
Issue a pass
Once you are a gatekeeper, you can issue passes.
gateway-eth issue -c sepolia <pass recipient address>
Listen to pass changes
TIP: Set the DEFAULT_CHAIN environment variable to avoid having to specify the chain with every command.
export DEFAULT_CHAIN=sepolia
gateway-eth listen <owner>
Create a Gatekeeper Network
To create a gatekeeper network, find an unused ID, and register it with a name.
NOTE: Consult with civic about listing the gatekeeper network, in order to avoid collisions.
gateway-eth create-gatekeeper-network -c sepolia <id> <name>
Usage
$ npm install -g @civic/gateway-eth-cli
$ gateway-eth COMMAND
running command...
$ gateway-eth (-v|--version|version)
@civic/gateway-eth-cli/0.2.4 darwin-arm64 node-v20.13.1
$ gateway-eth --help [COMMAND]
USAGE
$ gateway-eth COMMAND
...
Commands
gateway-eth add-gatekeeper ADDRESS
gateway-eth add-network-authority ADDRESS
gateway-eth burn ADDRESS
gateway-eth create-gatekeeper-network ID NAME
gateway-eth freeze ADDRESS
gateway-eth get-gatekeeper-network ID
gateway-eth get-token ADDRESS
gateway-eth help [COMMAND]
gateway-eth is-gatekeeper GATEKEEPERADDRESS
gateway-eth issue ADDRESS [EXPIRY]
gateway-eth listen ADDRESS
gateway-eth refresh ADDRESS [EXPIRY]
gateway-eth remove-gatekeeper ADDRESS
gateway-eth remove-network-authority ADDRESS
gateway-eth rename-gatekeeper-network ID NAME
gateway-eth revoke ADDRESS
gateway-eth unfreeze ADDRESS
gateway-eth add-gatekeeper ADDRESS
Add a gatekeeper to a gatekeeper network
USAGE
$ gateway-eth add-gatekeeper ADDRESS
ARGUMENTS
ADDRESS Gatekeeper address to add to the gatekeeper network
OPTIONS
-c, --chain=localhost|ethereum|sepolia|polygonAmoy|polygon|auroraTestnet|aurora|optimismSepolia|optimism|palmTestnet|p
alm|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starknet|starknetGoerli|xdc|xdcApo
them|bsc|bscTestnet|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygonZkEVM|baseSepolia
|base|xlayer|xlayerTestnet
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
-f, --fees=fees
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=gasLimit
Gas limit to set for the transaction. Required only for chains/providers that do not support eth_estimateGas
-h, --help
Show CLI help.
-n, --gatekeeperNetwork=gatekeeperNetwork
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-p, --privateKey=privateKey
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=gatewayTokenAddress
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-w, --confirmations=confirmations
[default: [object Object]] The amount of blocks to wait for mined transaction
EXAMPLE
$ gateway-eth add-gatekeeper 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
See code: dist/commands/add-gatekeeper.ts
gateway-eth add-network-authority ADDRESS
Add a network authority to a GatewayToken contract
USAGE
$ gateway-eth add-network-authority ADDRESS
ARGUMENTS
ADDRESS Network authority address to add to the gatekeeper network
OPTIONS
-c, --chain=localhost|ethereum|sepolia|polygonAmoy|polygon|auroraTestnet|aurora|optimismSepolia|optimism|palmTestnet|p
alm|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starknet|starknetGoerli|xdc|xdcApo
them|bsc|bscTestnet|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygonZkEVM|baseSepolia
|base|xlayer|xlayerTestnet
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
-f, --fees=fees
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=gasLimit
Gas limit to set for the transaction. Required only for chains/providers that do not support eth_estimateGas
-h, --help
Show CLI help.
-n, --gatekeeperNetwork=gatekeeperNetwork
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-p, --privateKey=privateKey
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=gatewayTokenAddress
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-w, --confirmations=confirmations
[default: [object Object]] The amount of blocks to wait for mined transaction
EXAMPLE
$ gateway-eth add-network-authority 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
See code: dist/commands/add-network-authority.ts
gateway-eth burn ADDRESS
Burn existing gateway token
USAGE
$ gateway-eth burn ADDRESS
ARGUMENTS
ADDRESS Token owner address
OPTIONS
-c, --chain=localhost|ethereum|sepolia|polygonAmoy|polygon|auroraTestnet|aurora|optimismSepolia|optimism|palmTestnet|p
alm|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starknet|starknetGoerli|xdc|xdcApo
them|bsc|bscTestnet|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygonZkEVM|baseSepolia
|base|xlayer|xlayerTestnet
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
-f, --fees=fees
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=gasLimit
Gas limit to set for the transaction. Required only for chains/providers that do not support eth_estimateGas
-h, --help
Show CLI help.
-n, --gatekeeperNetwork=gatekeeperNetwork
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-p, --privateKey=privateKey
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=gatewayTokenAddress
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-w, --confirmations=confirmations
[default: [object Object]] The amount of blocks to wait for mined transaction
EXAMPLE
$ gateway-eth burn 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
See code: dist/commands/burn.ts
gateway-eth create-gatekeeper-network ID NAME
Create a new gatekeeper network
USAGE
$ gateway-eth create-gatekeeper-network ID NAME
ARGUMENTS
ID ID of the new network
NAME Name of the new network
OPTIONS
-c, --chain=localhost|ethereum|sepolia|polygonAmoy|polygon|auroraTestnet|aurora|optimismSepolia|optimism|palmTestnet|p
alm|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starknet|starknetGoerli|xdc|xdcApo
them|bsc|bscTestnet|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygonZkEVM|baseSepolia
|base|xlayer|xlayerTestnet
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
-f, --fees=fees
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=gasLimit
Gas limit to set for the transaction. Required only for chains/providers that do not support eth_estimateGas
-h, --help
Show CLI help.
-p, --privateKey=privateKey
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=gatewayTokenAddress
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-w, --confirmations=confirmations
[default: [object Object]] The amount of blocks to wait for mined transaction
EXAMPLE
$ gateway-eth create-gatekeeper-network <number> <name>
See code: dist/commands/create-gatekeeper-network.ts
gateway-eth freeze ADDRESS
Freeze existing gateway token
USAGE
$ gateway-eth freeze ADDRESS
ARGUMENTS
ADDRESS Token owner address
OPTIONS
-c, --chain=localhost|ethereum|sepolia|polygonAmoy|polygon|auroraTestnet|aurora|optimismSepolia|optimism|palmTestnet|p
alm|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starknet|starknetGoerli|xdc|xdcApo
them|bsc|bscTestnet|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygonZkEVM|baseSepolia
|base|xlayer|xlayerTestnet
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
-f, --fees=fees
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=gasLimit
Gas limit to set for the transaction. Required only for chains/providers that do not support eth_estimateGas
-h, --help
Show CLI help.
-n, --gatekeeperNetwork=gatekeeperNetwork
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-p, --privateKey=privateKey
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=gatewayTokenAddress
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-w, --confirmations=confirmations
[default: [object Object]] The amount of blocks to wait for mined transaction
EXAMPLE
$ gateway-eth freeze 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
See code: dist/commands/freeze.ts
gateway-eth get-gatekeeper-network ID
Check if a gatekeeper network exists
USAGE
$ gateway-eth get-gatekeeper-network ID
ARGUMENTS
ID ID of the network
OPTIONS
-c, --chain=localhost|ethereum|sepolia|polygonAmoy|polygon|auroraTestnet|aurora|optimismSepolia|optimism|palmTestnet|p
alm|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starknet|starknetGoerli|xdc|xdcApo
them|bsc|bscTestnet|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygonZkEVM|baseSepolia
|base|xlayer|xlayerTestnet
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
-h, --help
Show CLI help.
-t, --gatewayTokenAddress=gatewayTokenAddress
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
EXAMPLE
$ gateway-eth get-gatekeeper-network <number>
See code: dist/commands/get-gatekeeper-network.ts
gateway-eth get-token ADDRESS
Get existing gateway token
USAGE
$ gateway-eth get-token ADDRESS
ARGUMENTS
ADDRESS Token owner address
OPTIONS
-c, --chain=localhost|ethereum|sepolia|polygonAmoy|polygon|auroraTestnet|aurora|optimismSepolia|optimism|palmTestnet|p
alm|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starknet|starknetGoerli|xdc|xdcApo
them|bsc|bscTestnet|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygonZkEVM|baseSepolia
|base|xlayer|xlayerTestnet
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
-h, --help
Show CLI help.
-n, --gatekeeperNetwork=gatekeeperNetwork
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-t, --gatewayTokenAddress=gatewayTokenAddress
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
ALIASES
$ gateway-eth verify
EXAMPLE
$ gateway-eth get 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
See code: dist/commands/get-token.ts
gateway-eth help [COMMAND]
Display help for gateway-eth.
USAGE
$ gateway-eth help [COMMAND]
ARGUMENTS
COMMAND Command to show help for.
OPTIONS
-n, --nested-commands Include all nested commands in the output.
See code: @oclif/plugin-help
gateway-eth is-gatekeeper GATEKEEPERADDRESS
Check if a gatekeeper is added to a network
USAGE
$ gateway-eth is-gatekeeper GATEKEEPERADDRESS
ARGUMENTS
GATEKEEPERADDRESS Address of the Gatekeeper Authority
OPTIONS
-c, --chain=localhost|ethereum|sepolia|polygonAmoy|polygon|auroraTestnet|aurora|optimismSepolia|optimism|palmTestnet|p
alm|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starknet|starknetGoerli|xdc|xdcApo
them|bsc|bscTestnet|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygonZkEVM|baseSepolia
|base|xlayer|xlayerTestnet
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
-h, --help
Show CLI help.
-n, --gatekeeperNetwork=gatekeeperNetwork
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-t, --gatewayTokenAddress=gatewayTokenAddress
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
EXAMPLE
$ gateway-eth is-gatekeeper -n <slot id> <gatekeeper address>
See code: dist/commands/is-gatekeeper.ts
gateway-eth issue ADDRESS [EXPIRY]
Issue a new gateway token for a given owner address and gatekeeper network
USAGE
$ gateway-eth issue ADDRESS [EXPIRY]
ARGUMENTS
ADDRESS Token owner address
EXPIRY [default: [object Object]] Expiry timestamp for the issued token
OPTIONS
-a, --charge=charge
Charge in native tokens for the transaction
-b, --bitmask=bitmask
[default: [object Object]] Bitmask constraints to link with newly minting token
-c, --chain=localhost|ethereum|sepolia|polygonAmoy|polygon|auroraTestnet|aurora|optimismSepolia|optimism|palmTestnet|p
alm|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starknet|starknetGoerli|xdc|xdcApo
them|bsc|bscTestnet|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygonZkEVM|baseSepolia
|base|xlayer|xlayerTestnet
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
-f, --fees=fees
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=gasLimit
Gas limit to set for the transaction. Required only for chains/providers that do not support eth_estimateGas
-h, --help
Show CLI help.
-n, --gatekeeperNetwork=gatekeeperNetwork
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-p, --privateKey=privateKey
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=gatewayTokenAddress
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-u, --uri=uri
TokenURI to link with the issued token
-w, --confirmations=confirmations
[default: [object Object]] The amount of blocks to wait for mined transaction
-x, --forwarder=forwarder
Forward the transaction to the forwarder contract
EXAMPLE
$ gateway-eth issue 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
See code: dist/commands/issue.ts
gateway-eth listen ADDRESS
Listen to changes on a gateway token
USAGE
$ gateway-eth listen ADDRESS
ARGUMENTS
ADDRESS Token owner address
OPTIONS
-c, --chain=localhost|ethereum|sepolia|polygonAmoy|polygon|auroraTestnet|aurora|optimismSepolia|optimism|palmTestnet|p
alm|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starknet|starknetGoerli|xdc|xdcApo
them|bsc|bscTestnet|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygonZkEVM|baseSepolia
|base|xlayer|xlayerTestnet
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
-h, --help
Show CLI help.
-n, --gatekeeperNetwork=gatekeeperNetwork
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-t, --gatewayTokenAddress=gatewayTokenAddress
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
EXAMPLE
$ gateway-eth listen 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
See code: dist/commands/listen.ts
gateway-eth refresh ADDRESS [EXPIRY]
Refresh existing gateway token for Ethereum address
USAGE
$ gateway-eth refresh ADDRESS [EXPIRY]
ARGUMENTS
ADDRESS Token owner address
EXPIRY [default: [object Object]] Expiry timestamp for newly issued token
OPTIONS
-c, --chain=localhost|ethereum|sepolia|polygonAmoy|polygon|auroraTestnet|aurora|optimismSepolia|optimism|palmTestnet|p
alm|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starknet|starknetGoerli|xdc|xdcApo
them|bsc|bscTestnet|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygonZkEVM|baseSepolia
|base|xlayer|xlayerTestnet
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
-f, --fees=fees
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=gasLimit
Gas limit to set for the transaction. Required only for chains/providers that do not support eth_estimateGas
-h, --help
Show CLI help.
-n, --gatekeeperNetwork=gatekeeperNetwork
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-p, --privateKey=privateKey
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=gatewayTokenAddress
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-w, --confirmations=confirmations
[default: [object Object]] The amount of blocks to wait for mined transaction
EXAMPLE
$ gateway-eth refresh 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 60 -n 123
See code: dist/commands/refresh.ts
gateway-eth remove-gatekeeper ADDRESS
Remove a gatekeeper from a gatekeeper network
USAGE
$ gateway-eth remove-gatekeeper ADDRESS
ARGUMENTS
ADDRESS Gatekeeper address to remove from the gatekeeper network
OPTIONS
-c, --chain=localhost|ethereum|sepolia|polygonAmoy|polygon|auroraTestnet|aurora|optimismSepolia|optimism|palmTestnet|p
alm|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starknet|starknetGoerli|xdc|xdcApo
them|bsc|bscTestnet|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygonZkEVM|baseSepolia
|base|xlayer|xlayerTestnet
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
-f, --fees=fees
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=gasLimit
Gas limit to set for the transaction. Required only for chains/providers that do not support eth_estimateGas
-h, --help
Show CLI help.
-n, --gatekeeperNetwork=gatekeeperNetwork
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-p, --privateKey=privateKey
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=gatewayTokenAddress
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-w, --confirmations=confirmations
[default: [object Object]] The amount of blocks to wait for mined transaction
EXAMPLE
$ gateway-eth remove-gatekeeper 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
See code: dist/commands/remove-gatekeeper.ts
gateway-eth remove-network-authority ADDRESS
Remove a network authority from a gatekeeper network
USAGE
$ gateway-eth remove-network-authority ADDRESS
ARGUMENTS
ADDRESS Network authority address to add to the gatekeeper network
OPTIONS
-c, --chain=localhost|ethereum|sepolia|polygonAmoy|polygon|auroraTestnet|aurora|optimismSepolia|optimism|palmTestnet|p
alm|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starknet|starknetGoerli|xdc|xdcApo
them|bsc|bscTestnet|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygonZkEVM|baseSepolia
|base|xlayer|xlayerTestnet
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
-f, --fees=fees
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=gasLimit
Gas limit to set for the transaction. Required only for chains/providers that do not support eth_estimateGas
-h, --help
Show CLI help.
-n, --gatekeeperNetwork=gatekeeperNetwork
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-p, --privateKey=privateKey
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=gatewayTokenAddress
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-w, --confirmations=confirmations
[default: [object Object]] The amount of blocks to wait for mined transaction
EXAMPLE
$ gateway-eth remove-network-authority 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
See code: dist/commands/remove-network-authority.ts
gateway-eth rename-gatekeeper-network ID NAME
Rename a gatekeeper network
USAGE
$ gateway-eth rename-gatekeeper-network ID NAME
ARGUMENTS
ID ID of the new network
NAME New name of the new network
OPTIONS
-c, --chain=localhost|ethereum|sepolia|polygonAmoy|polygon|auroraTestnet|aurora|optimismSepolia|optimism|palmTestnet|p
alm|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starknet|starknetGoerli|xdc|xdcApo
them|bsc|bscTestnet|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygonZkEVM|baseSepolia
|base|xlayer|xlayerTestnet
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
-f, --fees=fees
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=gasLimit
Gas limit to set for the transaction. Required only for chains/providers that do not support eth_estimateGas
-h, --help
Show CLI help.
-p, --privateKey=privateKey
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=gatewayTokenAddress
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-w, --confirmations=confirmations
[default: [object Object]] The amount of blocks to wait for mined transaction
EXAMPLE
$ gateway-eth rename-gatekeeper-network <name> <number>
See code: dist/commands/rename-gatekeeper-network.ts
gateway-eth revoke ADDRESS
Revoke existing gateway token
USAGE
$ gateway-eth revoke ADDRESS
ARGUMENTS
ADDRESS Token owner address
OPTIONS
-c, --chain=localhost|ethereum|sepolia|polygonAmoy|polygon|auroraTestnet|aurora|optimismSepolia|optimism|palmTestnet|p
alm|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starknet|starknetGoerli|xdc|xdcApo
them|bsc|bscTestnet|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygonZkEVM|baseSepolia
|base|xlayer|xlayerTestnet
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
-f, --fees=fees
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=gasLimit
Gas limit to set for the transaction. Required only for chains/providers that do not support eth_estimateGas
-h, --help
Show CLI help.
-n, --gatekeeperNetwork=gatekeeperNetwork
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-p, --privateKey=privateKey
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=gatewayTokenAddress
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-w, --confirmations=confirmations
[default: [object Object]] The amount of blocks to wait for mined transaction
EXAMPLE
$ gateway-eth revoke 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
See code: dist/commands/revoke.ts
gateway-eth unfreeze ADDRESS
Unfreezing existing gateway token
USAGE
$ gateway-eth unfreeze ADDRESS
ARGUMENTS
ADDRESS Token owner address
OPTIONS
-c, --chain=localhost|ethereum|sepolia|polygonAmoy|polygon|auroraTestnet|aurora|optimismSepolia|optimism|palmTestnet|p
alm|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starknet|starknetGoerli|xdc|xdcApo
them|bsc|bscTestnet|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygonZkEVM|baseSepolia
|base|xlayer|xlayerTestnet
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
-f, --fees=fees
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=gasLimit
Gas limit to set for the transaction. Required only for chains/providers that do not support eth_estimateGas
-h, --help
Show CLI help.
-n, --gatekeeperNetwork=gatekeeperNetwork
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-p, --privateKey=privateKey
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=gatewayTokenAddress
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-w, --confirmations=confirmations
[default: [object Object]] The amount of blocks to wait for mined transaction
EXAMPLE
$ gateway-eth unfreeze 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
See code: dist/commands/unfreeze.ts