Safient Claims SDK
JavaScript SDK to manage and interact with the safe claims on Safient protocol.
Installation
git clone https://github.com/safient/safient-contract-js.git
cd safient-contract-js
npm install
Running Tests
Create an .env file in the root dtrectory with INFURA_API_KEY
Terminal 1
Terminal 2
npm run deploy
npm run tests
Getting started
Usage
// If not injected web3 provider, create a jsonRpcProvider
const { JsonRpcProvider } = require('@ethersproject/providers');
const provider = new JsonRpcProvider('http://localhost:8545');
// Get signer and chainId from provider
(async () => {
const signer = await provider.getSigner();
const providerNetwork = await provider.getNetwork();
const chainId = providerNetwork.chainId;
})();
Initialization
import { SafientClaims } from '@safient/claims';
const sc = new SafientClaims(signer, chainId);
Arbitrator
sc.arbitrator.getArbitrationFee
SafientMain
sc.safientMain.createSafe
sc.safientMain.syncSafe
sc.safientMain.createClaim
sc.safientMain.submitEvidence
sc.safientMain.depositFunds
sc.safientMain.withdrawFunds
sc.safientMain.getTotalNumberOfSafes
sc.safientMain.getTotalNumberOfClaims
sc.safientMain.getSafeBySafeId
sc.safientMain.getClaimByClaimId
sc.safientMain.getClaimStatus
sc.safientMain.getContractBalance
sc.safientMain.guardianProof
API details
Arbitrator
Get Arbitration Fee
const getArbitrationFee = async () => {
try {
const fee = await sc.arbitrator.getArbitrationFee();
console.log(fee);
} catch (e) {
console.log(e.message);
}
};
Returns |
Type |
Description |
Arbitration fee |
number |
Arbitration fee in ETH
|
SafientMain
Create Safe
const createSafe = async (beneficiaryAddress, safeIdOnThreadDB, claimType, signalingPeriod, metaevidenceURI, value) => {
try {
const tx = await sc.safientMain.createSafe(
beneficiaryAddress,
safeIdOnThreadDB,
claimType,
signalingPeriod,
metaevidenceURI,
value
);
console.log(tx);
} catch (e) {
console.log(e.message);
}
};
Parameter |
Type |
Description |
beneficiaryAddress |
string |
Required. Address of the beneficiary who can claim to inherit this safe |
safeIdOnThreadDB |
string |
Required. Safe Id on threadDB |
claimType |
string |
Required. Type of claim the inheritor has go through |
signalingPeriod |
string |
Number of days within which the safe creator is willing to send a signal |
metaevidenceURI |
string |
IPFS URI pointing to the metaevidence related to arbitration details |
value |
string |
Required. Safe maintanence fee in Gwei, minimum arbitration fee required |
Returns |
Type |
Description |
Transaction Response |
object |
Includes all properties of a transaction |
Sync Safe
const syncSafe = async (creatorAddress, safeIdOnThreadDB, claimType, signalingPeriod, metaevidenceURI, value) => {
try {
const tx = await sc.safientMain.syncSafe(
creatorAddress,
safeIdOnThreadDB,
claimType,
signalingPeriod,
metaevidenceURI,
value
);
console.log(tx);
} catch (e) {
console.log(e.message);
}
};
Parameter |
Type |
Description |
creatorAddress |
string |
Required. Address of the creator who created the safe offchain |
safeIdOnThreadDB |
string |
Required. Safe Id on threadDB |
claimType |
string |
Required. Type of claim the inheritor has go through |
signalingPeriod |
string |
Number of days within which the safe creator is willing to send a signal |
metaevidenceURI |
string |
IPFS URI pointing to the metaevidence related to arbitration details |
value |
string |
Required. Safe maintanence fee in Gwei, minimum arbitration fee required |
Returns |
Type |
Description |
Transaction Response |
object |
Includes all properties of a transaction |
Create Claim
const createClaim = async (safeIdOnThreadDB, evidenceURI) => {
try {
const tx = await sc.safientMain.createClaim(safeIdOnThreadDB, evidenceURI);
console.log(tx);
} catch (e) {
console.log(e.message);
}
};
Parameter |
Type |
Description |
safeIdOnThreadDB |
string |
Required. Safe Id on threadDB |
evidenceURI |
string |
IPFS URI pointing to the evidence submitted by the claim creator |
Returns |
Type |
Description |
Transaction Response |
object |
Includes all properties of a transaction |
Submit Evidence
const submitEvidence = async (disputeId, evidenceURI) => {
try {
const tx = await sc.safientMain.submitEvidence(disputeId, evidenceURI);
console.log(tx);
} catch (e) {
console.log(e.message);
}
};
Parameter |
Type |
Description |
disputeId |
number |
Required. Id of the dispute representing the claim |
evidenceURI |
string |
Required. IPFS URI pointing to the evidence submitted by the claim creator |
Returns |
Type |
Description |
Transaction Response |
object |
Includes all properties of a transaction |
Deposit Safe Funds
const depositFunds = async (safeIdOnThreadDB, value) => {
try {
const tx = await sc.safientMain.depositFunds(safeIdOnThreadDB, value);
console.log(tx);
} catch (e) {
console.log(e.message);
}
};
Parameter |
Type |
Description |
safeIdOnThreadDB |
string |
Required. Safe Id on threadDB |
value |
string |
Required. Funds in Gwei
|
Returns |
Type |
Description |
Transaction Response |
object |
Includes all properties of a transaction |
Retrieve Safe Funds
Only safe's current owner can execute this
const withdrawFunds = async (safeIdOnThreadDB) => {
try {
const tx = await sc.safientMain.withdrawFunds(safeIdOnThreadDB);
console.log(tx);
} catch (e) {
console.log(e.message);
}
};
Parameter |
Type |
Description |
safeIdOnThreadDB |
string |
Required. Safe Id on threadDB |
Returns |
Type |
Description |
Transaction Response |
object |
Includes all properties of a transaction |
Send signal
Only safe's current owner can execute this
const sendSignal = async (safeIdOnThreadDB) => {
try {
const tx = await sc.safientMain.sendSignal(safeIdOnThreadDB);
console.log(tx);
} catch (e) {
console.log(e.message);
}
};
Parameter |
Type |
Description |
safeIdOnThreadDB |
string |
Required. Safe Id on threadDB |
Returns |
Type |
Description |
Transaction Response |
object |
Includes all properties of a transaction |
Get Total Number Of Safes
const getTotalNumberOfSafes = async () => {
try {
const numOfSafes = await sc.safientMain.getTotalNumberOfSafes();
console.log(numOfSafes);
} catch (e) {
console.log(e.message);
}
};
Returns |
Type |
Description |
Total no. of safes |
number |
Total number of safes created on SafientMain |
Get Total Number Of Claims
const getTotalNumberOfClaims = async () => {
try {
const numOfClaims = await sc.safientMain.getTotalNumberOfClaims();
console.log(numOfClaims);
} catch (e) {
console.log(e.message);
}
};
Returns |
Type |
Description |
Total no. of claims |
number |
Total number of claims created on SafientMain |
Get Safe By Safe Id
const getSafeBySafeId = async (safeIdOnThreadDB) => {
try {
const safe = await sc.safientMain.getSafeBySafeId(safeIdOnThreadDB);
console.log(safe);
} catch (e) {
console.log(e.message);
}
};
Parameter |
Type |
Description |
safeIdOnThreadDB |
string |
Required. Safe Id on threadDB |
Returns |
Type |
Description |
Safe |
Safe |
Safe containing safe data |
Type Safe
Property |
Type |
Description |
safeId |
string |
Safe Id on threadDB |
safeCreatedBy |
string |
Address of the safe creator |
safeCurrentOwner |
string |
Address of the current safe owner |
safeBeneficiary |
string |
Address of the safe beneficiary |
signalingPeriod |
Bigumber |
Number of days before which signal should be given |
endSignalTime |
Bigumber |
End timestamp before which signal should be given |
latestSignalTime |
Bigumber |
Timestamp at which signal is given |
metaEvidenceId |
Bigumber |
Id used to uniquely identify a piece of meta-evidence |
claimsCount |
Bigumber |
Number of claims made on this safe |
safeFunds |
Bigumber |
Total safe funds in Gwei
|
Get Claim By Claim Id
const getClaimByClaimId = async (claimId) => {
try {
const claim = await sc.safientMain.getClaimByClaimId(claimId);
console.log(claim);
} catch (e) {
console.log(e.message);
}
};
Parameter |
Type |
Description |
claimId |
number |
Required. Id of the claim |
Returns |
Type |
Description |
Claim |
Claim |
Claim containing claim data |
Type Claim
Property |
Type |
Description |
claimType |
BigNumber |
Type of claim 0 - SignalBased, 1 - ArbitrationBased
|
disputeId |
BigNumber |
Id of the dispute representing the claim |
claimedBy |
string |
Address of the claim creator |
metaEvidenceId |
BigNumber |
Id used to uniquely identify a piece of meta-evidence |
evidenceGroupId |
Bigumber |
Id used to identify a group of evidence related to a dispute |
status |
BigNumber |
Claim status represented by 0, 1, 2 or 3
|
result |
string |
Claim result represented by Passed, Failed or Refused To Arbitrate
|
Get Claim Status
const getClaimStatus = async (safeIdOnThreadDB, claimId) => {
try {
const claimStatus = await sc.safientMain.getClaimStatus(claimId);
console.log(claimStatus);
} catch (e) {
console.log(e.message);
}
};
Parameter |
Type |
Description |
safeIdOnThreadDB |
string |
Required. Safe Id on threadDB |
claimId |
number |
Required. Id of the claim |
Returns |
Type |
Description |
claim status |
number |
Claim status represented by 0 - Active, 1 - Passed, 2 - Failed or 3 - Refused To Arbitrate
|
Get SafientMain Contract Total Balance
const getContractBalance = async () => {
try {
const balance = await sc.safientMain.getContractBalance();
console.log(balance);
} catch (e) {
console.log(e.message);
}
};
Returns |
Type |
Description |
SafientMain contract balance |
number |
Total balance of SafientMain contract in ETH
|
Guardian proof
const guardianProof = async (message, signature, guardianProof, secrets, safeIdOnThreadDB) => {
try {
const result = await sc.safientMain.guardianProof(message, signature, guardianProof, secrets, safeIdOnThreadDB);
console.log(result);
} catch (e) {
console.log(e.message);
}
};
Type RecoveryProof
Property |
Type |
Description |
secret |
string |
Secret |
address |
string |
Guardian address |
Parameter |
Type |
Description |
message |
string |
Required. Message generated during safe creation, also signed by the safe creator |
signature |
bytes |
Required. Signature of the message signed by the creator |
guardianProof |
RecoveryProof |
Required. Object containing guardian address and his secret |
secrets |
string[] |
Required. Array of all the secrets of all the guardians, for cross verification |
safeIdOnThreadDB |
string |
Required. Id of the safe on threadDB |
Returns |
Type |
Description |
Guardian proof result |
boolean |
Guardian proof is true or false |