new ElvContracts({configUrl,mainObjectId})
Instantiate the ElvContract SDK
Parameters:
| Name | Type | Description |
|---|---|---|
configUrl |
string |
The Content Fabric configuration URL |
mainObjectId |
string |
The top-level Eluvio Live object ID |
|
- Source:
Methods
async ClaimerAddAuthAddr(address)
Call the method addAuthorizedAdr of the smart contract Claimer.sol
Parameters:
| Name | Type | Description |
|---|---|---|
address |
string |
: the address to add to the list |
- Source:
async ClaimerAllocate(address,amount,expirationDate)
Call the method allocate of the smart contract Claimer.sol
Parameters:
| Name | Type | Description |
|---|---|---|
address |
string |
: address to allocate |
amount |
string |
: amount to allocate |
expirationDate |
string |
: the expiration date of the new allocation |
- Source:
async ClaimerBalanceOf(address)
Call the method getClaim of the smart contract Claimer.sol
Parameters:
| Name | Type | Description |
|---|---|---|
address |
string |
: get the balance of this address |
- Source:
async ClaimerBurn(amount)
Call the method burn of the smart contract Claimer.sol
Parameters:
| Name | Type | Description |
|---|---|---|
amount |
string |
: amount to burn |
- Source:
async ClaimerBurnOf(address)
Call the method getBurn of the smart contract Claimer.sol
Parameters:
| Name | Type | Description |
|---|---|---|
address |
string |
: get the burn balance of this address |
- Source:
async ClaimerClaim(amount)
Call the method claim of the smart contract Claimer.sol
Parameters:
| Name | Type | Description |
|---|---|---|
amount |
string |
: amount to claim |
- Source:
async ClaimerClearAllocations(address)
Call the method clearAllocations of the smart contract Claimer.sol
Parameters:
| Name | Type | Description |
|---|---|---|
address |
string |
: clear the allocations of this address |
- Source:
async ClaimerListAllocations(address)
First clear the list and then create a list by pushing all the allocations into it
Parameters:
| Name | Type | Description |
|---|---|---|
address |
string |
: list the allocations of this list |
- Source:
async ClaimerRmAuthAddr(address)
Call the method rmAuthorizedAdr of the smart contract Claimer.sol
Parameters:
| Name | Type | Description |
|---|---|---|
address |
string |
: the address to remove from the list |
- Source:
async CleanupObjects(objectAddr:,objectType:)
cleanUp objects to remove references to dead objects
Parameters:
| Name | Type | Description |
|---|---|---|
objectAddr: |
string |
address of the object |
objectType: |
string |
object type (library | content_object | group | content_type) |
- Source:
async DeleteLibrary(libraryAddr:)
delete library and to remove references to dead objects for the signer and groups
Parameters:
| Name | Type | Description |
|---|---|---|
libraryAddr: |
string |
address of the library |
- Source:
async ListContentObjects(objectAddr:)
list content objects for user or group address provided
Parameters:
| Name | Type | Description |
|---|---|---|
objectAddr: |
string |
address of the user or group |
- Source:
async PaymentDeploy(addresses,shares:)
Deploy Payment contract (revenue splitter - commerce/Payment.sol)
Parameters:
| Name | Type | Description |
|---|---|---|
addresses |
string |
: list of stakeholder addresses |
shares: |
string |
list of stakeholder shares, in the order of addresses |
- Source:
async PaymentRelease(addr:,tokenContractAddress:,payeeAddress:)
Retrieve funds from payment splitter contract, as a payee or for payee address provided
Parameters:
| Name | Type | Description |
|---|---|---|
addr: |
string |
address of the payment contract |
tokenContractAddress: |
string |
address of the token contract (ERC20) |
payeeAddress: |
string |
address of the payee |
- Source:
async PaymentShow(addr:,tokenContractAddress:)
Show status of payment contract stakeholders
Parameters:
| Name | Type | Description |
|---|---|---|
addr: |
string |
address of the payment contract |
tokenContractAddress: |
string |
address of the token contract (ERC20) |
- Source: