CLI for the Gateway Protocol on EVM chains.
For more detail, see the Gateway Protocol
yarn global add @identity.com/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
This command will add yourself as a gatekeeper to the test gatekeeper network on Goerli, using the built-in test network authority key.
gateway-eth add-gatekeeper -c goerli <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.
Once you are a gatekeeper, you can issue passes.
gateway-eth issue -c goerli <pass recipient address>
TIP: Set the DEFAULT_CHAIN environment variable to avoid having to specify the chain with every command.
export DEFAULT_CHAIN=goerli
gateway-eth listen <owner>
To create a gatekeeper network, find an unused ID, and register it with a name.
NOTE: Consult with identity.com about listing the gatekeeper network, in order to avoid collisions.
gateway-eth create-gatekeeper-network -c goerli <id> <name>
$ npm install -g @identity.com/gateway-eth-cli
$ gateway-eth COMMAND
running command...
$ gateway-eth (--version)
@identity.com/gateway-eth-cli/0.2.3 darwin-arm64 node-v20.10.0
$ gateway-eth --help [COMMAND]
USAGE
$ gateway-eth COMMAND
...
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 verify ADDRESS
Add a gatekeeper to a gatekeeper network
USAGE
$ gateway-eth add-gatekeeper [ADDRESS] [-h] [-p <value>] [-t <value>] [-n <value>] [-c
localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|optimism|pal
mTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starkne
t|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygo
nZkEVM|baseSepolia|base] [-f <value>] [-g <value>] [-w <value>]
ARGUMENTS
ADDRESS Gatekeeper address to add to the gatekeeper network
FLAGS
-c, --chain=<option>
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
<options: localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|op
timism|palmTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFu
ji|starknet|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTest
net|polygonZkEVM|baseSepolia|base>
-f, --fees=<value>
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=<value>
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=<value>
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-p, --privateKey=<value>
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=<value>
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-w, --confirmations=<value>
[default: 1] The amount of blocks to wait for mined transaction
DESCRIPTION
Add a gatekeeper to a gatekeeper network
EXAMPLES
$ gateway-eth add-gatekeeper 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
See code: dist/commands/add-gatekeeper.ts
Add a network authority to a GatewayToken contract
USAGE
$ gateway-eth add-network-authority [ADDRESS] [-h] [-p <value>] [-t <value>] [-n <value>] [-c
localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|optimism|pal
mTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starkne
t|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygo
nZkEVM|baseSepolia|base] [-f <value>] [-g <value>] [-w <value>]
ARGUMENTS
ADDRESS Network authority address to add to the gatekeeper network
FLAGS
-c, --chain=<option>
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
<options: localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|op
timism|palmTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFu
ji|starknet|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTest
net|polygonZkEVM|baseSepolia|base>
-f, --fees=<value>
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=<value>
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=<value>
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-p, --privateKey=<value>
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=<value>
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-w, --confirmations=<value>
[default: 1] The amount of blocks to wait for mined transaction
DESCRIPTION
Add a network authority to a GatewayToken contract
EXAMPLES
$ gateway-eth add-network-authority 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
See code: dist/commands/add-network-authority.ts
Burn existing gateway token
USAGE
$ gateway-eth burn [ADDRESS] [-h] [-p <value>] [-t <value>] [-n <value>] [-c
localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|optimism|pal
mTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starkne
t|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygo
nZkEVM|baseSepolia|base] [-f <value>] [-g <value>] [-w <value>]
ARGUMENTS
ADDRESS Token owner address
FLAGS
-c, --chain=<option>
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
<options: localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|op
timism|palmTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFu
ji|starknet|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTest
net|polygonZkEVM|baseSepolia|base>
-f, --fees=<value>
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=<value>
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=<value>
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-p, --privateKey=<value>
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=<value>
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-w, --confirmations=<value>
[default: 1] The amount of blocks to wait for mined transaction
DESCRIPTION
Burn existing gateway token
EXAMPLES
$ gateway-eth burn 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
See code: dist/commands/burn.ts
Create a new gatekeeper network
USAGE
$ gateway-eth create-gatekeeper-network [ID] [NAME] [-h] [-p <value>] [-c
localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|optimism|pal
mTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starkne
t|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygo
nZkEVM|baseSepolia|base] [-t <value>] [-f <value>] [-g <value>] [-w <value>]
ARGUMENTS
ID ID of the new network
NAME Name of the new network
FLAGS
-c, --chain=<option>
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
<options: localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|op
timism|palmTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFu
ji|starknet|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTest
net|polygonZkEVM|baseSepolia|base>
-f, --fees=<value>
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=<value>
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=<value>
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=<value>
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-w, --confirmations=<value>
[default: 1] The amount of blocks to wait for mined transaction
DESCRIPTION
Create a new gatekeeper network
EXAMPLES
$ gateway-eth create-gatekeeper-network <number> <name>
See code: dist/commands/create-gatekeeper-network.ts
Freeze existing gateway token
USAGE
$ gateway-eth freeze [ADDRESS] [-h] [-p <value>] [-t <value>] [-n <value>] [-c
localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|optimism|pal
mTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starkne
t|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygo
nZkEVM|baseSepolia|base] [-f <value>] [-g <value>] [-w <value>]
ARGUMENTS
ADDRESS Token owner address
FLAGS
-c, --chain=<option>
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
<options: localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|op
timism|palmTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFu
ji|starknet|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTest
net|polygonZkEVM|baseSepolia|base>
-f, --fees=<value>
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=<value>
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=<value>
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-p, --privateKey=<value>
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=<value>
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-w, --confirmations=<value>
[default: 1] The amount of blocks to wait for mined transaction
DESCRIPTION
Freeze existing gateway token
EXAMPLES
$ gateway-eth freeze 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
See code: dist/commands/freeze.ts
Check if a gatekeeper network exists
USAGE
$ gateway-eth get-gatekeeper-network [ID] [-h] [-c
localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|optimism|pal
mTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starkne
t|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygo
nZkEVM|baseSepolia|base] [-t <value>]
ARGUMENTS
ID ID of the network
FLAGS
-c, --chain=<option>
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
<options: localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|op
timism|palmTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFu
ji|starknet|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTest
net|polygonZkEVM|baseSepolia|base>
-h, --help
Show CLI help.
-t, --gatewayTokenAddress=<value>
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
DESCRIPTION
Check if a gatekeeper network exists
EXAMPLES
$ gateway-eth get-gatekeeper-network <number>
See code: dist/commands/get-gatekeeper-network.ts
Get existing gateway token
USAGE
$ gateway-eth get-token [ADDRESS] [-h] [-t <value>] [-n <value>] [-c
localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|optimism|pal
mTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starkne
t|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygo
nZkEVM|baseSepolia|base]
ARGUMENTS
ADDRESS Token owner address
FLAGS
-c, --chain=<option>
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
<options: localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|op
timism|palmTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFu
ji|starknet|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTest
net|polygonZkEVM|baseSepolia|base>
-h, --help
Show CLI help.
-n, --gatekeeperNetwork=<value>
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-t, --gatewayTokenAddress=<value>
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
DESCRIPTION
Get existing gateway token
ALIASES
$ gateway-eth verify
EXAMPLES
$ gateway-eth get 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
See code: dist/commands/get-token.ts
Display help for gateway-eth.
USAGE
$ gateway-eth help [COMMAND] [-n]
ARGUMENTS
COMMAND Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for gateway-eth.
See code: @oclif/plugin-help
Check if a gatekeeper is added to a network
USAGE
$ gateway-eth is-gatekeeper [GATEKEEPERADDRESS] [-h] [-c
localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|optimism|pal
mTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starkne
t|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygo
nZkEVM|baseSepolia|base] [-t <value>] [-n <value>]
ARGUMENTS
GATEKEEPERADDRESS Address of the Gatekeeper Authority
FLAGS
-c, --chain=<option>
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
<options: localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|op
timism|palmTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFu
ji|starknet|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTest
net|polygonZkEVM|baseSepolia|base>
-h, --help
Show CLI help.
-n, --gatekeeperNetwork=<value>
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-t, --gatewayTokenAddress=<value>
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
DESCRIPTION
Check if a gatekeeper is added to a network
EXAMPLES
$ gateway-eth is-gatekeeper -n <slot id> <gatekeeper address>
See code: dist/commands/is-gatekeeper.ts
Issue a new gateway token for a given owner address and gatekeeper network
USAGE
$ gateway-eth issue [ADDRESS] [EXPIRY] [-h] [-p <value>] [-t <value>] [-n <value>] [-c
localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|optimism|pal
mTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starkne
t|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygo
nZkEVM|baseSepolia|base] [-f <value>] [-w <value>] [-g <value>] [-b <value>] [-u <value>] [-x <value>] [-a <value>]
ARGUMENTS
ADDRESS Token owner address
EXPIRY [default: [object Object]] Expiry timestamp for the issued token
FLAGS
-a, --charge=<value>
Charge in native tokens for the transaction
-b, --bitmask=<value>
[default: [object Object]] Bitmask constraints to link with newly minting token
-c, --chain=<option>
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
<options: localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|op
timism|palmTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFu
ji|starknet|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTest
net|polygonZkEVM|baseSepolia|base>
-f, --fees=<value>
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=<value>
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=<value>
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-p, --privateKey=<value>
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=<value>
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-u, --uri=<value>
TokenURI to link with the issued token
-w, --confirmations=<value>
[default: 1] The amount of blocks to wait for mined transaction
-x, --forwarder=<value>
Forward the transaction to the forwarder contract
DESCRIPTION
Issue a new gateway token for a given owner address and gatekeeper network
EXAMPLES
$ gateway-eth issue 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
See code: dist/commands/issue.ts
Listen to changes on a gateway token
USAGE
$ gateway-eth listen [ADDRESS] [-h] [-t <value>] [-n <value>] [-c
localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|optimism|pal
mTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starkne
t|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygo
nZkEVM|baseSepolia|base]
ARGUMENTS
ADDRESS Token owner address
FLAGS
-c, --chain=<option>
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
<options: localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|op
timism|palmTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFu
ji|starknet|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTest
net|polygonZkEVM|baseSepolia|base>
-h, --help
Show CLI help.
-n, --gatekeeperNetwork=<value>
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-t, --gatewayTokenAddress=<value>
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
DESCRIPTION
Listen to changes on a gateway token
EXAMPLES
$ gateway-eth listen 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
See code: dist/commands/listen.ts
Refresh existing gateway token for Ethereum address
USAGE
$ gateway-eth refresh [ADDRESS] [EXPIRY] [-h] [-p <value>] [-t <value>] [-n <value>] [-c
localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|optimism|pal
mTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starkne
t|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygo
nZkEVM|baseSepolia|base] [-f <value>] [-g <value>] [-w <value>]
ARGUMENTS
ADDRESS Token owner address
EXPIRY [default: [object Object]] Expiry timestamp for newly issued token
FLAGS
-c, --chain=<option>
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
<options: localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|op
timism|palmTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFu
ji|starknet|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTest
net|polygonZkEVM|baseSepolia|base>
-f, --fees=<value>
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=<value>
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=<value>
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-p, --privateKey=<value>
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=<value>
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-w, --confirmations=<value>
[default: 1] The amount of blocks to wait for mined transaction
DESCRIPTION
Refresh existing gateway token for Ethereum address
EXAMPLES
$ gateway-eth refresh 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 60 -n 123
See code: dist/commands/refresh.ts
Remove a gatekeeper from a gatekeeper network
USAGE
$ gateway-eth remove-gatekeeper [ADDRESS] [-h] [-p <value>] [-t <value>] [-n <value>] [-c
localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|optimism|pal
mTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starkne
t|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygo
nZkEVM|baseSepolia|base] [-f <value>] [-g <value>] [-w <value>]
ARGUMENTS
ADDRESS Gatekeeper address to remove from the gatekeeper network
FLAGS
-c, --chain=<option>
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
<options: localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|op
timism|palmTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFu
ji|starknet|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTest
net|polygonZkEVM|baseSepolia|base>
-f, --fees=<value>
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=<value>
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=<value>
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-p, --privateKey=<value>
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=<value>
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-w, --confirmations=<value>
[default: 1] The amount of blocks to wait for mined transaction
DESCRIPTION
Remove a gatekeeper from a gatekeeper network
EXAMPLES
$ gateway-eth remove-gatekeeper 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
See code: dist/commands/remove-gatekeeper.ts
Remove a network authority from a gatekeeper network
USAGE
$ gateway-eth remove-network-authority [ADDRESS] [-h] [-p <value>] [-t <value>] [-n <value>] [-c
localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|optimism|pal
mTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starkne
t|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygo
nZkEVM|baseSepolia|base] [-f <value>] [-g <value>] [-w <value>]
ARGUMENTS
ADDRESS Network authority address to add to the gatekeeper network
FLAGS
-c, --chain=<option>
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
<options: localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|op
timism|palmTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFu
ji|starknet|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTest
net|polygonZkEVM|baseSepolia|base>
-f, --fees=<value>
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=<value>
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=<value>
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-p, --privateKey=<value>
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=<value>
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-w, --confirmations=<value>
[default: 1] The amount of blocks to wait for mined transaction
DESCRIPTION
Remove a network authority from a gatekeeper network
EXAMPLES
$ gateway-eth remove-network-authority 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
See code: dist/commands/remove-network-authority.ts
Rename a gatekeeper network
USAGE
$ gateway-eth rename-gatekeeper-network [ID] [NAME] [-h] [-p <value>] [-c
localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|optimism|pal
mTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starkne
t|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygo
nZkEVM|baseSepolia|base] [-t <value>] [-f <value>] [-g <value>] [-w <value>]
ARGUMENTS
ID ID of the new network
NAME New name of the new network
FLAGS
-c, --chain=<option>
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
<options: localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|op
timism|palmTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFu
ji|starknet|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTest
net|polygonZkEVM|baseSepolia|base>
-f, --fees=<value>
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=<value>
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=<value>
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=<value>
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-w, --confirmations=<value>
[default: 1] The amount of blocks to wait for mined transaction
DESCRIPTION
Rename a gatekeeper network
EXAMPLES
$ gateway-eth rename-gatekeeper-network <name> <number>
See code: dist/commands/rename-gatekeeper-network.ts
Revoke existing gateway token
USAGE
$ gateway-eth revoke [ADDRESS] [-h] [-p <value>] [-t <value>] [-n <value>] [-c
localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|optimism|pal
mTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starkne
t|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygo
nZkEVM|baseSepolia|base] [-f <value>] [-g <value>] [-w <value>]
ARGUMENTS
ADDRESS Token owner address
FLAGS
-c, --chain=<option>
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
<options: localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|op
timism|palmTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFu
ji|starknet|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTest
net|polygonZkEVM|baseSepolia|base>
-f, --fees=<value>
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=<value>
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=<value>
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-p, --privateKey=<value>
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=<value>
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-w, --confirmations=<value>
[default: 1] The amount of blocks to wait for mined transaction
DESCRIPTION
Revoke existing gateway token
EXAMPLES
$ gateway-eth revoke 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
See code: dist/commands/revoke.ts
Unfreezing existing gateway token
USAGE
$ gateway-eth unfreeze [ADDRESS] [-h] [-p <value>] [-t <value>] [-n <value>] [-c
localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|optimism|pal
mTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starkne
t|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygo
nZkEVM|baseSepolia|base] [-f <value>] [-g <value>] [-w <value>]
ARGUMENTS
ADDRESS Token owner address
FLAGS
-c, --chain=<option>
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
<options: localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|op
timism|palmTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFu
ji|starknet|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTest
net|polygonZkEVM|baseSepolia|base>
-f, --fees=<value>
Gas Price level to execute transaction with. For example: instant, fast, standard, slow
-g, --gasLimit=<value>
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=<value>
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-p, --privateKey=<value>
[default: 0xf1ddf80d2b5d038bc2ab7ae9a26e017d2252218dc687ab72d45f84bfbee2957d] The ethereum address private key for
signing messages (or set PRIVATE_KEY environment variable)
-t, --gatewayTokenAddress=<value>
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
-w, --confirmations=<value>
[default: 1] The amount of blocks to wait for mined transaction
DESCRIPTION
Unfreezing existing gateway token
EXAMPLES
$ gateway-eth unfreeze 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123
See code: dist/commands/unfreeze.ts
Get existing gateway token
USAGE
$ gateway-eth verify [ADDRESS] [-h] [-t <value>] [-n <value>] [-c
localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|optimism|pal
mTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starkne
t|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygo
nZkEVM|baseSepolia|base]
ARGUMENTS
ADDRESS Token owner address
FLAGS
-c, --chain=<option>
[default: [object Object]] Specify target chain to work with (or set DEFAULT_CHAIN environment variable)
<options: localhost|ethereum|sepolia|goerli|polygonMumbai|polygonAmoy|polygon|auroraTestnet|aurora|optimismGoerli|op
timism|palmTestnet|palm|arbitrumGoerli|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFu
ji|starknet|starknetGoerli|xdc|xdcApothem|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTest
net|polygonZkEVM|baseSepolia|base>
-h, --help
Show CLI help.
-n, --gatekeeperNetwork=<value>
[default: 1] Gatekeeper network. Defaults to the test Gatekeeper Network
-t, --gatewayTokenAddress=<value>
[default: 0xF65b6396dF6B7e2D8a6270E3AB6c7BB08BAEF22E] GatewayToken address to target (or set GATEWAY_TOKEN_ADDRESS
environment variable)
DESCRIPTION
Get existing gateway token
ALIASES
$ gateway-eth verify
EXAMPLES
$ gateway-eth get 0x893F4Be53274353CD3379C87C8fd1cb4f8458F94 -n 123