Nerds Publishing Monstrosities

    @identity.com/solana-gatekeeper-lib
    TypeScript icon, indicating that this package has built-in type declarations

    4.0.0 • Public • Published

    gatekeeper-lib

    Library and CLI to manage OCIV Gateway Tokens

    oclif Version Downloads/week License

    Usage

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

    Commands

    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, --cluster=mainnet-beta|testnet|devnet|civicnet|localnet  [default: mainnet-beta] The cluster to target.
                                                                   Alternatively, set the environment variable
                                                                   SOLANA_CLUSTER. To override this property with a specific
                                                                   endpoint url, set SOLANA_CLUSTER_URL
    
      -g, --gatekeeperKey=gatekeeperKey                            [default: [object Object]] The private key file for the
                                                                   gatekeeper authority
    
      -h, --help                                                   show CLI help
    
      -n, --gatekeeperNetworkKey=gatekeeperNetworkKey              [default: [object Object]] The private key file for the
                                                                   gatekeeper authority
    
    EXAMPLE
      $ gateway add-gatekeeper tgky5YfBseCvqehzsycwCG6rh2udA4w14MxZMnZz9Hp
    

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

    gateway freeze GATEWAYTOKEN

    Freeze a gateway token

    USAGE
      $ gateway freeze GATEWAYTOKEN
    
    ARGUMENTS
      GATEWAYTOKEN  The gateway token to freeze
    
    OPTIONS
      -c, --cluster=mainnet-beta|testnet|devnet|civicnet|localnet  [default: mainnet-beta] The cluster to target.
                                                                   Alternatively, set the environment variable
                                                                   SOLANA_CLUSTER. To override this property with a specific
                                                                   endpoint url, set SOLANA_CLUSTER_URL
    
      -g, --gatekeeperKey=gatekeeperKey                            [default: [object Object]] The private key file for the
                                                                   gatekeeper authority
    
      -h, --help                                                   show CLI help
    
      -n, --gatekeeperNetworkKey=gatekeeperNetworkKey              [default: tgnuXXNMDLK8dy7Xm1TdeGyc95MDym4bvAQCwcW21Bf]
                                                                   The public key (in base 58) of the gatekeeper network
                                                                   that the gatekeeper belongs to.
    
    EXAMPLE
      $ gateway freeze EzZgkwaDrgycsiyGeCVRXXRcieE1fxhGMp829qwj5TMv
      Frozen
    

    See code: dist/commands/freeze.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 ADDRESS

    Issue a gateway token to a wallet

    USAGE
      $ gateway issue ADDRESS
    
    ARGUMENTS
      ADDRESS  The address to issue the token to
    
    OPTIONS
      -c, --cluster=mainnet-beta|testnet|devnet|civicnet|localnet  [default: mainnet-beta] The cluster to target.
                                                                   Alternatively, set the environment variable
                                                                   SOLANA_CLUSTER. To override this property with a specific
                                                                   endpoint url, set SOLANA_CLUSTER_URL
    
      -e, --expiry=expiry                                          The expiry time in seconds for the gateway token (default
                                                                   none)
    
      -g, --gatekeeperKey=gatekeeperKey                            [default: [object Object]] The private key file for the
                                                                   gatekeeper authority
    
      -h, --help                                                   show CLI help
    
      -n, --gatekeeperNetworkKey=gatekeeperNetworkKey              [default: tgnuXXNMDLK8dy7Xm1TdeGyc95MDym4bvAQCwcW21Bf]
                                                                   The public key (in base 58) of the gatekeeper network
                                                                   that the gatekeeper belongs to.
    
    EXAMPLE
      $ gateway issue EzZgkwaDrgycsiyGeCVRXXRcieE1fxhGMp829qwj5TMv2QJjjrzdPSrcZUuAH2KrEU61crWz49KnSLSzwjDUnLSV
    

    See code: dist/commands/issue.ts

    gateway refresh GATEWAYTOKEN [EXPIRY]

    Refresh a gateway token

    USAGE
      $ gateway refresh GATEWAYTOKEN [EXPIRY]
    
    ARGUMENTS
      GATEWAYTOKEN  The gateway token to refresh
      EXPIRY        [default: 54000] The new expiry time in seconds for the gateway token (default 15 minutes)
    
    OPTIONS
      -c, --cluster=mainnet-beta|testnet|devnet|civicnet|localnet  [default: mainnet-beta] The cluster to target.
                                                                   Alternatively, set the environment variable
                                                                   SOLANA_CLUSTER. To override this property with a specific
                                                                   endpoint url, set SOLANA_CLUSTER_URL
    
      -g, --gatekeeperKey=gatekeeperKey                            [default: [object Object]] The private key file for the
                                                                   gatekeeper authority
    
      -h, --help                                                   show CLI help
    
      -n, --gatekeeperNetworkKey=gatekeeperNetworkKey              [default: tgnuXXNMDLK8dy7Xm1TdeGyc95MDym4bvAQCwcW21Bf]
                                                                   The public key (in base 58) of the gatekeeper network
                                                                   that the gatekeeper belongs to.
    
    EXAMPLE
      $ gateway refresh EzZgkwaDrgycsiyGeCVRXXRcieE1fxhGMp829qwj5TMv 54000
      Refreshed
    

    See code: dist/commands/refresh.ts

    gateway revoke GATEWAYTOKEN

    Revoke a gateway token

    USAGE
      $ gateway revoke GATEWAYTOKEN
    
    ARGUMENTS
      GATEWAYTOKEN  The gateway token to revoke
    
    OPTIONS
      -c, --cluster=mainnet-beta|testnet|devnet|civicnet|localnet  [default: mainnet-beta] The cluster to target.
                                                                   Alternatively, set the environment variable
                                                                   SOLANA_CLUSTER. To override this property with a specific
                                                                   endpoint url, set SOLANA_CLUSTER_URL
    
      -g, --gatekeeperKey=gatekeeperKey                            [default: [object Object]] The private key file for the
                                                                   gatekeeper authority
    
      -h, --help                                                   show CLI help
    
      -n, --gatekeeperNetworkKey=gatekeeperNetworkKey              [default: tgnuXXNMDLK8dy7Xm1TdeGyc95MDym4bvAQCwcW21Bf]
                                                                   The public key (in base 58) of the gatekeeper network
                                                                   that the gatekeeper belongs to.
    
    EXAMPLE
      $ gateway revoke EzZgkwaDrgycsiyGeCVRXXRcieE1fxhGMp829qwj5TMv
      Revoked
    

    See code: dist/commands/revoke.ts

    gateway revoke-gatekeeper ADDRESS

    Revoke a gatekeeper from a network

    USAGE
      $ gateway revoke-gatekeeper ADDRESS
    
    ARGUMENTS
      ADDRESS  The address of the gatekeeper to revoke from the network
    
    OPTIONS
      -c, --cluster=mainnet-beta|testnet|devnet|civicnet|localnet  [default: mainnet-beta] The cluster to target.
                                                                   Alternatively, set the environment variable
                                                                   SOLANA_CLUSTER. To override this property with a specific
                                                                   endpoint url, set SOLANA_CLUSTER_URL
    
      -g, --gatekeeperKey=gatekeeperKey                            [default: [object Object]] The private key file for the
                                                                   gatekeeper authority
    
      -h, --help                                                   show CLI help
    
      -n, --gatekeeperNetworkKey=gatekeeperNetworkKey              [default: [object Object]] The private key file for the
                                                                   gatekeeper authority
    
    EXAMPLE
      $ gateway revoke-gatekeeper tgky5YfBseCvqehzsycwCG6rh2udA4w14MxZMnZz9Hp
    

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

    gateway unfreeze GATEWAYTOKEN

    Unfreeze a gateway token

    USAGE
      $ gateway unfreeze GATEWAYTOKEN
    
    ARGUMENTS
      GATEWAYTOKEN  The gateway token to unfreeze
    
    OPTIONS
      -c, --cluster=mainnet-beta|testnet|devnet|civicnet|localnet  [default: mainnet-beta] The cluster to target.
                                                                   Alternatively, set the environment variable
                                                                   SOLANA_CLUSTER. To override this property with a specific
                                                                   endpoint url, set SOLANA_CLUSTER_URL
    
      -g, --gatekeeperKey=gatekeeperKey                            [default: [object Object]] The private key file for the
                                                                   gatekeeper authority
    
      -h, --help                                                   show CLI help
    
      -n, --gatekeeperNetworkKey=gatekeeperNetworkKey              [default: tgnuXXNMDLK8dy7Xm1TdeGyc95MDym4bvAQCwcW21Bf]
                                                                   The public key (in base 58) of the gatekeeper network
                                                                   that the gatekeeper belongs to.
    
    EXAMPLE
      $ gateway unfreeze EzZgkwaDrgycsiyGeCVRXXRcieE1fxhGMp829qwj5TMv
      Unfrozen
    

    See code: dist/commands/unfreeze.ts

    gateway verify OWNER

    Verify a gateway token

    USAGE
      $ gateway verify OWNER
    
    ARGUMENTS
      OWNER  The gateway token to revoke
    
    OPTIONS
      -c, --cluster=mainnet-beta|testnet|devnet|civicnet|localnet  [default: mainnet-beta] The cluster to target.
                                                                   Alternatively, set the environment variable
                                                                   SOLANA_CLUSTER. To override this property with a specific
                                                                   endpoint url, set SOLANA_CLUSTER_URL
    
      -h, --help                                                   show CLI help
    
      -n, --gatekeeperNetworkKey=gatekeeperNetworkKey              [default: tgnuXXNMDLK8dy7Xm1TdeGyc95MDym4bvAQCwcW21Bf]
                                                                   The public key (in base 58) of the gatekeeper network
                                                                   that the gatekeeper belongs to.
    
    EXAMPLE
      $ gateway verify EzZgkwaDrgycsiyGeCVRXXRcieE1fxhGMp829qwj5TMv
      {
       "issuingGatekeeper": "tgky5YfBseCvqehzsycwCG6rh2udA4w14MxZMnZz9Hp",
       "gatekeeperNetwork": "48V9nmW9awiR9BmihdGhUL3ZpYJ8MCgGeUoSWbtqjicv",
       "owner": "EzZgkwaDrgycsiyGeCVRXXRcieE1fxhGMp829qwj5TMv",
       "state": "ACTIVE",
       "publicKey": "3rNZ6RzH6jLCzFeySVDc8Z82sJkeQ4xi7BCUzjpZBvZr",
       "programId": "gatem74V238djXdzWnJf94Wo1DcnuGkfijbf3AuBhfs"
      }
    

    See code: dist/commands/verify.ts

    Keywords

    Install

    npm i @identity.com/solana-gatekeeper-lib

    DownloadsWeekly Downloads

    507

    Version

    4.0.0

    License

    MIT

    Unpacked Size

    94.6 kB

    Total Files

    54

    Last publish

    Collaborators

    • diosakhilleus
    • chriteixeira
    • rado0x54
    • araptarchis
    • mitchcivic
    • identity.com-ci
    • dankelleher
    • flippiescholtz
    • kevinhcolgan
    • pbshoemaker
    • tyronemichael
    • lucmir
    • william-identity