On-chain Integration

Ethereum

Warning: The Ethereum integration is in alpha and is subject to change.
  1. 1.
    Copy the IGatewayTokenVerifier.sol (github) into your contract deployment
  2. 2.
    In your contract, implement an instance of the verifier:
    import "./IGatewayTokenVerifier.sol";
    // Your contract
    contract MyContract {
    IGatewayTokenVerifier verifier;
    constructor (address gatekeeperNetwork) {
    verifier = IGatewayTokenVerifier(gatekeeperNetwork);
    }
    }
    Get the gatekeeperNetwork key the Selecting a Pass Verification section or by contacting Civic
  3. 3.
    Check that your user has a Civic Pass by calling verifyToken
    bool verificationResult = verifier.verifyToken(userAddress);

Solana

Import the solana_gateway Rust crate from crates.io and call Gateway::verify_gateway_token_account_info
For your program to be able to call the integration library, the following parameters must be passed as inputs to your dApp's transaction:
  • userWallet : The wallet account for the dApp user (e.g. the trader in a defi application) . A Civic Pass must have been already issued to this wallet.
  • gateway_token : The address of the Civic Pass (token). This address can be accessed in the dApp through the useGateway hook on the Civic React Component once the user has passed Gatekeeper verification.
  • gatekeeper_network The gatekeeper network on which the Civic Pass has been issued. For more information about Gatekeeper Networks, see the-gatekeeper-network.
Get the gatekeeper_network address in the Selecting a Pass Verification section
use solana_gateway::Gateway;
// This check happens before the dApp transaction is processed
fn process() -> ProgramResult {
// The owner of the gateway token
let user_wallet: AccountInfo;
// The gateway token presented by the owner
let gateway_token: AccountInfo;
// The gatekeeper network key
let gatekeeper_network: Pubkey;
// Check the token is valid. An error here means the token
// is not valid for the user's wallet on the gateway network.
Gateway::verify_gateway_token_account_info(
&gateway_token_account_info, &userWallet.key, &gatekeeper
)?;
Ok(())
}

Error handling

The Gateway call will return a GatewayError if something goes wrong or the token is invalid. The possible values can be seen in error.rs . For error cases, the dApp smart contract should reject the transaction.
Copy link