@identity.com/casper-gatekeeper-lib

gatekeeper-lib

Library and CLI to manage OCIV Gateway Tokens

• gatekeeper-lib
• Usage
• Commands

Usage

$ npm install -g @identity.com/casper-gatekeeper-lib
$ gateway COMMAND
running command...
$ gateway (-v|--version|version)
@identity.com/casper-gatekeeper-lib/0.1.5 darwin-x64 node-v16.0.0
$ gateway --help [COMMAND]
USAGE
  $ gateway COMMAND
...

Commands

• gateway add-admin ADDRESS
• gateway add-gatekeeper ADDRESS
• gateway freeze ACCOUNT
• gateway get-deploy HASH
• gateway help [COMMAND]
• gateway issue ACCOUNT
• gateway refresh ACCOUNT [EXPIRY]
• gateway revoke ACCOUNT
• gateway revoke-admin ADDRESS
• gateway revoke-gatekeeper ADDRESS
• gateway unfreeze ACCOUNT
• gateway verify ACCOUNT

gateway add-admin ADDRESS

Add an admin to a contract

USAGE
  $ gateway add-admin ADDRESS

ARGUMENTS
  ADDRESS  The address of the admin to add to the contract

OPTIONS
  -c, --config=config  [default: ./config.json] Configuration file for commands
  -h, --help           show CLI help

EXAMPLE
  $ gateway add-admin tgky5YfBseCvqehzsycwCG6rh2udA4w14MxZMnZz9Hp

See code: dist/commands/add-admin.ts

gateway add-gatekeeper ADDRESS

Add a gatekeeper to a network

USAGE
  $ gateway add-gatekeeper ADDRESS

ARGUMENTS
  ADDRESS  The address of the gatekeeper to add to the network

OPTIONS
  -c, --config=config  [default: ./config.json] Configuration file for commands
  -h, --help           show CLI help

EXAMPLE
  $ gateway add-gatekeeper tgky5YfBseCvqehzsycwCG6rh2udA4w14MxZMnZz9Hp

See code: dist/commands/add-gatekeeper.ts

gateway freeze ACCOUNT

Freeze a gateway token

USAGE
  $ gateway freeze ACCOUNT

ARGUMENTS
  ACCOUNT  The account holding the KYC Token

OPTIONS
  -c, --config=config  [default: ./config.json] Configuration file for commands
  -h, --help           show CLI help

EXAMPLE
  $ gateway freeze EzZgkwaDrgycsiyGeCVRXXRcieE1fxhGMp829qwj5TMv
  Frozen

See code: dist/commands/freeze.ts

gateway get-deploy HASH

Check status of deployment

USAGE
  $ gateway get-deploy HASH

ARGUMENTS
  HASH  Deployment hash

OPTIONS
  -c, --config=config  [default: ./config.json] Configuration file for commands
  -h, --help           show CLI help

EXAMPLE
  $ gateway get-deploy EzZgkwaDrgycsiyGeCVRXXRcieE1fxhGMp829qwj5TMv
  Frozen

See code: dist/commands/get-deploy.ts

gateway help [COMMAND]

display help for gateway

USAGE
  $ gateway help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

gateway issue ACCOUNT

Issue a gateway token to a wallet

USAGE
  $ gateway issue ACCOUNT

ARGUMENTS
  ACCOUNT  The account to issue the KYC Token to

OPTIONS
  -c, --config=config  [default: ./config.json] Configuration file for commands
  -h, --help           show CLI help

EXAMPLE
  $ gateway issue EzZgkwaDrgycsiyGeCVRXXRcieE1fxhGMp829qwj5TMv2QJjjrzdPSrcZUuAH2KrEU61crWz49KnSLSzwjDUnLSV

See code: dist/commands/issue.ts

gateway refresh ACCOUNT [EXPIRY]

Refresh a gateway token

USAGE
  $ gateway refresh ACCOUNT [EXPIRY]

ARGUMENTS
  ACCOUNT  The account to issue the KYC Token to
  EXPIRY   [default: 54000] The new expiry time in seconds for the gateway token (default 15 minutes)

OPTIONS
  -c, --config=config  [default: ./config.json] Configuration file for commands
  -h, --help           show CLI help

EXAMPLE
  $ gateway refresh EzZgkwaDrgycsiyGeCVRXXRcieE1fxhGMp829qwj5TMv 54000
  Refreshed

See code: dist/commands/refresh.ts

gateway revoke ACCOUNT

Revoke a gateway token

USAGE
  $ gateway revoke ACCOUNT

ARGUMENTS
  ACCOUNT  The account holding the KYC Token

OPTIONS
  -c, --config=config  [default: ./config.json] Configuration file for commands
  -h, --help           show CLI help

EXAMPLE
  $ gateway revoke EzZgkwaDrgycsiyGeCVRXXRcieE1fxhGMp829qwj5TMv
  Revoked

See code: dist/commands/revoke.ts

gateway revoke-admin ADDRESS

Revoke an admin

USAGE
  $ gateway revoke-admin ADDRESS

ARGUMENTS
  ADDRESS  The address of the admin to revoke

OPTIONS
  -c, --config=config  [default: ./config.json] Configuration file for commands
  -h, --help           show CLI help

EXAMPLE
  $ gateway add-admin tgky5YfBseCvqehzsycwCG6rh2udA4w14MxZMnZz9Hp

See code: dist/commands/revoke-admin.ts

gateway revoke-gatekeeper ADDRESS

Revoke a gatekeeper from a network

USAGE
  $ gateway revoke-gatekeeper ADDRESS

ARGUMENTS
  ADDRESS  The address of the gatekeeper to remove from the network

OPTIONS
  -c, --config=config  [default: ./config.json] Configuration file for commands
  -h, --help           show CLI help

EXAMPLE
  $ gateway revoke-gatekeeper tgky5YfBseCvqehzsycwCG6rh2udA4w14MxZMnZz9Hp

See code: dist/commands/revoke-gatekeeper.ts

gateway unfreeze ACCOUNT

Unfreeze a gateway token

USAGE
  $ gateway unfreeze ACCOUNT

ARGUMENTS
  ACCOUNT  The account holding the KYC Token

OPTIONS
  -c, --config=config  [default: ./config.json] Configuration file for commands
  -h, --help           show CLI help

EXAMPLE
  $ gateway unfreeze EzZgkwaDrgycsiyGeCVRXXRcieE1fxhGMp829qwj5TMv
  Unfrozen

See code: dist/commands/unfreeze.ts

gateway verify ACCOUNT

Verify a gateway token

USAGE
  $ gateway verify ACCOUNT

ARGUMENTS
  ACCOUNT  The account holding the KYC Token

OPTIONS
  -c, --config=config  [default: ./config.json] Configuration file for commands
  -h, --help           show CLI help

EXAMPLE
  $ gateway verify EzZgkwaDrgycsiyGeCVRXXRcieE1fxhGMp829qwj5TMv
  {
    "issuingGatekeeper": "tgky5YfBseCvqehzsycwCG6rh2udA4w14MxZMnZz9Hp",
    "gatekeeperNetwork": "48V9nmW9awiR9BmihdGhUL3ZpYJ8MCgGeUoSWbtqjicv",
    "owner": "EzZgkwaDrgycsiyGeCVRXXRcieE1fxhGMp829qwj5TMv",
    "status": "Active",
    "expiry": 1234567890
  }

See code: dist/commands/verify.ts