badgeforce

Solidity Smart contracts for Issuers and Holders.

Install Dependecies

We are using truffle and ganache-cli for our smart contract development

Install testrpc and truffle

$ npm install -g testrpc
$ npm install -g ganache-cli

Install project dependencies

$ npm install

Run Test

Start your Ethereum ganache node you might have to alter gas limit, we have seem differences on different OS

$ ganache-cli -l 4500000000000 --network-id 3000 --port 8000

Next cd into badgeforce cloned directory and run test, make sure dependencies are installed

$ ganache-cli test

Usage

Usage examples are in JavaScript using web3 and truffle

• Issuer
  • admin
  • getAuthorizedAccount
  • authorzeAccount
  • removeAuthorizedAccount
  • getNumberOfAuthorizedAccounts
  • getInfo
  • createBadge
  • deleteBadge
  • getNumberOfBadges
  • getBadge
  • issue
  • revoke
  • unRevoke
  • isRevoked
• Holder
  • getNumberOfCredentials
  • getCredential
  • verifyCredential

---

Issuer

Issuer.sol

The Issuer smart contract acts as a representation of an issuer entity in the real world such as a univeristy or organization. You can authorized many issuers on one Issuer contract, i.e: authorizing all the deans of the math department on the Math departments Issuer contract. This way they can all issue credentials. As these contracts are further developed we will be able to represent organizations more flexibly such as chaining together Issuer contracts to make up an organization, and we will extend the capabilities of badges such as data, and relation to one another (micro badges representing courses taken within a certain program).

admin

Automatic getter function generated for admin property on Issuer smart contract. Admin acts as God account and has special access to methods.

Returns

adminAddress

Example

const adminAddress = await issuer.admin();

---

getAuthorizedAccount

Function returns info for a authorized account

Parameters

1. address - the address of the authorized issuer account you want to retrieve

Returns

AuthorizedAccount

Example using authorizedAccountsMap property

const authorizedAccountData = await issuer.authorizedAccountsMap(0x0000);

Example using getAuthorizedAccount method

const authorizedAccountData = await issuer.getAuthorizedAccount(0x0000);

---

authorzeAccount

Function sets new authorized account. Use this function to add any enable new ethereum wallets to issue from your Issuer smart contract.

Parameters

1. address - the address of the issuer account you want to authorize

Example

await issuer.authorzeAccount(0x0000);

---

removeAuthorizedAccount

Function removes an authorized account. Once an account is unauthorized the issuer that ethereum account belongs to will no longer be able to call methods with authorized modifier

Parameters

1. address - the address of the authorized issuer account you want to unauthorize

Example

await issuer.removeAuthorizedAccount(0x0000);

---

getNumberOfAuthorizedAccounts

Function gets the number of authorized accounts. A UI client or API interacting with an Issuer smart contract can use this function in conjunction with the getAuthorizedAccount method to retrieve all accounts authorized on the contract

Example

const count = await issuer.getNumberOfAuthorizedAccounts();

---

getInfo

Function returns information about the issuer and smart contract

Returns

1. address - the admin address on this contract
2. address - the address of the issuer contract it's self
3. string - name of the issuer
4. string - url associated with the issuer

Example

const info = await issuer.getInfo();

---

createBadge

Function is used to create a new badge. This method will be extended to hold more data and more types of badges as the BadgeLibrary is further developed.

Parameters

1. string - description of the badge
2. string - name of the badge
3. string - image url
4. string - badge version
5. string - json

Example

const createBadgeParams = {
    _description: "This badge is super cool",
    _name: "Cool badge",
    _image: "http://some/image/url",
    _version: "1",
    _json: "json"
}
await issuer.createBadge(...Object.values(createBadgeParams));

---

deleteBadge

Function is used to delete a badge.

Parameters

1. string - name of the badge to delete

Example

await issuer.deleteBadge(name);

---

getNumberOfBadges

Function is used to get the number of badges. A UI client or API interacting with an Issuer smart contract can use this function in conjunction with the getBadge method to retrieve all badges

Example

const count = await issuer.getNumberOfBadges();

---

getBadge

Function is used to get a badge.

Parameters

1. uint - badge index

Example

const badge = await issuer.getBadge(index);

---

issue

Function is used to issue a credential to a holder contract.

Parameters

1. string - name of a badge that already exists on the issuer smart contract
2. address - address of the holder contract to issue credential to
3. uint - unix timstamp for expiration date or 0 for non expiring

Example

const issueParams = {
    _badgeName: "Fresh New Badge",
    _recipient: 0x0,
    _expires: 0,
}
await issuer.issue(...Object.values(issueParams));

---

revoke

Function is used to revoke a badge. Once a credential is revoked it will fail verification.

Parameters

1. bytes32 - transaction key of the credential to revoke

Example

await issuer.revoke(credential._txKey);

---

unRevoke

Function is used to un-revoke a credential. Can be used if a credential is revoked on error.

Parameters

1. bytes32 - transaction key of the credential to revoke

Example

await issuer.unRevoke(credential._txKey);

---

isRevoked

Function is used to check if a credential is revoked.

Parameters

1. bytes32 - transaction key of the credential to check

Example

const check = await issuer.isRevoked(redential._txKey);

---

Holder

Holder.sol

The Holder smart contract represents a holder or recipient of credentials, badges and certifications in the real world. This is where a holder will be able access all their earned credentials, and consumers will be able to query these contracts for credential verification. A Holder smart contract is owned by the holder in the real world by attaching it to an ethereum wallet address that they own.

getNumberOfCredentials

Function is used to get the number of credentials on the Holder contract. This can be used in conjunction with the getCredential function to get all the holders credentials.

Example

const count = await holder.getNumberOfCredentials();

---

getCredential

Function to retrieve a credential by it's index.

Parameters

1. uint - index of the credential

Example

const check = await holder.getCredential(index);

---

verifyCredential

Function is verify a credential.

Parameters

1. bytes32 - index of the credential

Returns

1. bool - true or false if the credential is verified
2. message - success or failure message

Example

const check = await holder.verifyCredential(index);

---